email - getmessages

API Call Information

area: email

action: getmessages

API Arguments

Argument	Data Type	Required	Description
`start`	integer	No	Starting position
`limit`	integer	No	Number of records to return
`id`	string	No	Optional message id or comma separated ids 1,2,3,4

API URL Example

https://api.hypermail.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=getmessages&start=0&limit=10

API Response

XML Response

<response>

<records>2</records>



<message>

<id>45911</id>

<title>Message 1</title>

<datecreated>August 11, 2011, 09:18:08 pm</datecreated>

<numberoftimesused>0</numberoftimesused>

<datelastused>Never</datelastused>

<locked>0</locked>

</message>



<message>

<id>45910</id>

<title>Message</title>

<datecreated>August 11, 2011, 09:17:39 pm</datecreated>

<numberoftimesused>2</numberoftimesused>

<datelastused>October 11, 2011, 11:42:04 pm</datelastused>

<locked>0</locked>

</message>

</response>

JSON Response

{
    "records": "2",
    "message": [
        {
            "id": "45911",
            "title": "Message 1",
            "datecreated": "August 11, 2011, 09:18:08 pm",
            "numberoftimesused": "0",
            "datelastused": "Never",
            "locked": "0"
        },
        {
            "id": "45910",
            "title": "Message",
            "datecreated": "August 11, 2011, 09:17:39 pm",
            "numberoftimesused": "2",
            "datelastused": "October 11, 2011, 11:42:04 pm",
            "locked": "0"
        }
    ]
}