Resource: Mail Queue Messages ( /api/mailqueue/messages )

Allows the retrieval of messages awaiting delivery in the mail queue (collection resource)

Root Relation: MailQueueMessages

Methods

GET

Retrieves mail messages queued for delivery.

Required Permissions

  • Administration/Organisation

Status Codes

These are the expected status codes returned by the service - in addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the request was completed successfully.
403 - ForbiddenReturned if the user does not have permission to retrieve items in the mail queue.

Example - Get page of mail messages

Example of fetching the first page of mail messages

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
$skip0
$top25

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

{
  "Skip": 0,
  "Top": 25,
  "Total": 2,
  "Items": [
    {
      "Id": "abfa25fc-87ef-4a6a-8320-c933b5d3c8c7",
      "EnqueuedAt": "2013-01-01T14:04:05Z",
      "Subject": "This is the subject (title) of the email",
      "Body": "This is the body of the email",
      "To": [
        {
          "Address": "joeb@test.com",
          "Name": "Joe Bloggs"
        }
      ],
      "Self": "http://localhost/api/mailqueue/message/abfa25fc-87ef-4a6a-8320-c933b5d3c8c7"
    },
    {
      "Id": "66181f42-02b5-44a8-988b-13ad5e8deb80",
      "EnqueuedAt": "2013-01-01T14:04:06Z",
      "Subject": "This is the subject (title) of another email message",
      "Body": "This is another email message body\r\nThat spans\r\nMultiple lines",
      "To": [
        {
          "Address": "joeb@test.com",
          "Name": "Joe Bloggs"
        },
        {
          "Address": "janed@test.com",
          "Name": "Jane Doe"
        }
      ],
      "Self": "http://localhost/api/mailqueue/message/66181f42-02b5-44a8-988b-13ad5e8deb80"
    }
  ],
  "Self": "http://localhost/api/api/mailqueue/messages?$skip=0&$top=25"
}

Status Code

200 - OK

  • No labels