...
On this page:
| Table of Contents |
|---|
...
Email messages
An email message is always created inside the environment of a MailUp list, so it cannot be managed outside of that list.
...
| 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)
Retrieve messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive
|
Sending Queue Status
It is possible to retrieve the status of the sending queue for the outgoing messages by calling the following methods:
1) status of ongoing sendings: GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/Immediate
2) status of waiting sendings: GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/Deferred
3) status of sending to be planned: GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/Undefined
Moreover, it is possible to retrieve the first available date to send a specific sending:
where {id_sending} is the unique identifier of the sending to consider. The result is the date UTC date specified with the format described in the section 'Type and cast definition' of this page: http://help.mailup.com/pages/viewpage.action?pageId=22806545.
Update message
This method allows you to modify an existing message (content and settings).
...
| Description | Read, add and remove message attachments | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET, POST, DELETE | ||||||||||||
URL | 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 |
...
Send Email Messages
Email messages are usually sent with the sender name and the sender name that are specified as default settings for the MailUp list. As an alternative you can specify a different sender for a certain sending by specifying "SenderName" and "SenderAddress" (both, not only one of them) as querystring parameters.
...
and "SenderAddress" (both, not only one of them) as querystring parameters.
Example: POST /Console/List/2/Email/30/Send?SenderName='John Smith'&SenderAddress='smith@example.com'
It is possible to specify an eventual date/time for a deferred sending, using the 'datetime' querystring parameter (UTC value), with the format described in the section 'Type and cast definition' of this page: http://help.mailup.com/pages/viewpage.action?pageId=22806545.
Example: POST /Console/List/2/Email/30/Send?
...
datetime='
...
2014-10-20 05:00:00Z'
| Note |
|---|
Message sending fails with HTTP 500 error if no authorized sender email nor sender email are provided. Ensure that sender name and sender email have been configured at list level (starting from MailUp version 8.6.1 the sender address has also to be a verified address) |
...