...
Description | Create a new email message | ||||
---|---|---|---|---|---|
HTTP Method | POST | ||||
URL |
| ||||
JSON request (example) |
| ||||
JSON response (example) |
| ||||
Paging and filtering (example) |
|
List Messages
Description | Retreive Retrieve email messages of specified list | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | ||||||||||||
URL | Retreive Retrieve all email messages of that list
Retreive Retrieve only email messages that have been published (i.e. with public visibility, see details)
Retreive Retrieve only email messages that have been archived (i.e. with public visibility, see details)
*an empty list is returned if public visibility of messages (aka Web library) is disabled. You shall enable it to retreive Retrieve them | ||||||||||||
JSON request (example) | none | ||||||||||||
JSON response (example) | All email messages of specified list
List published messages (public URLs are also provided)
List archived messages
| ||||||||||||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
Retreive Retrieve messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive
|
...
Description | Retrieve the email details (content, settings, attachment) by specified id | ||||||||
---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | ||||||||
URL | Retrieve the email details by specified id
Get attachment list for the specified message id
| ||||||||
JSON request (example) | none | ||||||||
JSON response (example) | Message content
Message attachments
| ||||||||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
Retreive Retrieve messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive
|
...
Description | Read, add and remove message attachments | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET, POST, DELETE | ||||||||||||
URL | Retreive Retrieve all the attachments of a specified message
Add an attachment to message slot
Remove an attachment from a message slot
| ||||||||||||
JSON request (example) | Only POST method needs a request parameter. Attachment has to be Base64 encoded
| ||||||||||||
JSON response (example) | GET method returns a list of the documents that are attached to specified message. An empty array ([], not JSON format) is returned if no document is attached.
POST method returns the list of attachments after the command execution
DELETE method returns details about remaining attachments after deletion
| ||||||||||||
Paging and filtering (example) | none |
...
Description | Send message to a single recipient | ||
---|---|---|---|
HTTP Method | POST | ||
URL |
| ||
JSON request (example) |
| ||
JSON response (example) | See notes at the bottom of this page1
| ||
Paging and filtering (example) | none |
...
Retrieve sending history
An email message can be sent several times. This feature allows to retreive retrieve details about each sending.
Description | Retreive Retrieve information about sent history | ||||
---|---|---|---|---|---|
HTTP Method | GET | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | N/A |
...