Email Messaging

This page lists the optional parameters, request data and reponse in xml

Retrieve outbox messages [HTTP GET]

https://appapi.dlangemobile.com/xml/email/{api_key}/outbox?page_size={page_size}&page_number={page_number}

URL Parameters

• api_key (Required) - Your API application key.

Query string Parameters

• page_size (Optional) - Value should be an integer. Defines the number of items per page. Value is required if page_number is defined. Default value if not provided is to return all items.
• page_number (Optional) - Value should be an integer. Defines the page number to return if page_size is defined. Default value if not provided is to return all items.

Response Notes

Each message includes all contacts and groups set as recipients.

• DateCreated - Format is {yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}

Example XML Response

<Outbox>
   <EmailOutbox>
    <ID>1</ID>
    <DateCreated>2011-05-31T11:20:00</DateCreated>
    <Subject>my email subject</Message>
    <Message>my email body</Message>
    <Status>Message queued for sending</Status>
    <RecipientContacts>
      <EmailContact>
        <ID>1</ID>
        <EmailAddress>contact1@domain.com</EmailAddress>
        <FirstName>firsttest</FirstName>
        <LastName>lasttest</LastName>
      </EmailContact>
      <EmailContact>
        <ID>2</ID>
        <EmailAddress>contact2@domain.com</EmailAddress>
        <FirstName>ted</FirstName>
        <LastName>ray</LastName>
      </EmailContact>
    </RecipientContacts>
    <RecipientGroups>
      <Group>
        <ID>2147483647</ID>
        <Name>String content</Name>
        <ColorCode>-16751002</ColorCode>
      </Group>
      <Group>
        <ID>1</ID>
        <Name>first group</Name>
        <ColorCode>-13434625</ColorCode>
      </Group>
    </RecipientGroups>
  </EmailOutbox>
  <EmailOutbox>
    <ID>3</ID>
    <DateCreated>2011-05-31T11:20:00</DateCreated>
    <Subject>my second email subject</Message>
    <Message>my second email body</Message>
    <Status>Message queued for sending</Status>
    <RecipientContacts>
      <EmailContact>
        <ID>2</ID>
        <EmailAddress>contact1@domain.com</EmailAddress>
        <FirstName>Jane</FirstName>
        <LastName>Smith</LastName>
      </EmailContact>
      <EmailContact>
        <ID>4</ID>
        <EmailAddress>contact2@domain.com</EmailAddress>
        <FirstName>John</FirstName>
        <LastName>Smith</LastName>
      </EmailContact>
    </RecipientContacts>
    <RecipientGroups>
      <Group>
        <ID>3</ID>
        <Name>String content</Name>
        <ColorCode>-65536</ColorCode>
      </Group>
      <Group>
        <ID>4</ID>
        <Name>second group</Name>
        <ColorCode>-39373</ColorCode>
      </Group>
    </RecipientGroups>
  </EmailOutbox>
  </Outbox>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.
• 003 - Define the page size for paged queries..
• 004 - Define the page number for paged queries..

Retrieve outbox messages total count [HTTP GET]

https://appapi.dlangemobile.com/xml/email/{api_key}/outbox/count

URL Parameters

• api_key (Required) - Your API application key.

Example XML Response

<int>500</int>

Error Codes

• 001 - API key is required.
• 002 - Invalid API key.