1	<?php
2
3	/**
4	* @apiDefine SuccessGet Response-Content
5	*
6	* @apiParam (GET) {String} page Page number of result.
7	*
8	* @apiSuccess (Response-Content)   {String}     current_page    page called.
9	* @apiSuccess (Response-Content)   {Array}      data            Array of asked data.
10	* @apiSuccess (Response-Content)   {String}     first_page_url  first page url.
11	* @apiSuccess (Response-Content)   {String}     next_page_url   next page url.
12	* @apiSuccess (Response-Content)   {String}     path            Base url.
13	* @apiSuccess (Response-Content)   {String}     prev_page_url   previous page url.
14	* @apiSuccess (Response-Content)   {Integer}    from            first entry index.
15	* @apiSuccess (Response-Content)   {Integer}    per_page        nb of entries by page.
16	* @apiSuccess (Response-Content)   {Integer}    to              last entry index.
17	*
18	*
19	*
20	* @apiSuccessExample Response-Content (example):
21	*     HTTP/1.1 200 OK
22	*          [
23	*              {
24	*                  id: 'xxxxx',
25	*                  attempts: 0,
26	*                  mail_type: 'NewPassword',
27	*                  recipients: test@advertise-me.net
28	*              }
29	*          ]
30	*/
31
32	/**
33	* @apiDefine EntityError Error 422
34	*
35	* @apiError (Error 422) {json} Unprocessable Entity Something wrong with parameters.
36	*
37	* @apiErrorExample {json} 422:
38	*     HTTP/1.1 422 Unprocessable Entity
39	*     {
40	*       "error": "error description"
41	*     }
42	*/
43
44	/**
45	* @apiDefine UserId Request-Header
46	*
47	* @apiHeader (UserId) {Integer} X-Qwamplify-user-id User-id.
48	*
49	* @apiHeaderExample {json} Header (Example) :
50	*     {
51	*           "X-Qwamplify-user-id" : 1
52	*     }
53	*/
54
55
56
57	/******************** STATE *********************/
58
59	/**
60	* @api {get} http://service_mail/api/state 1.1 Get Mail service state
61	* @apiVersion 1.0.0
62	* @apiName GetMailState
63	* @apiGroup 1.Mail
64	* @apiDescription Get mail service informations states.
65	*
66	* @apiUse UserId
67	* @apiUse SuccessGet
68	*
69	*/