Email Lists and Details
The Message APIs help you to retrieve messages from the user account and access them.
While using any Emails Message related API, make use of the OAuth Scope messages.
| Method Name | URL | Method Type | OAuth Scope | Purpose |
/api/accounts/<accountId>/messages/view | GET | messages | To get the details of all or specific set of emails in a folder based on view options. | |
| Get emails based on search conditions | /api/accounts/<accountId>/messages/search | GET | To get the list of emails, from the account based on custom search conditions. | |
/api/accounts/<accountId>/folders/<folderid>/ | GET | To get the meta data details of a particular email message in the account, based on the message id. | ||
| Get attachment info | /api/accounts/<accountId>/folders/<folderId>/ messages/<messageId>/attachmentinfo | GET | To get the attachment information of a particular email message in the account, based on the message id. | |
| Get email attachment content | /api/accounts/<accountId>/folders/<folderId> /messages/<messageId>/attachments/<attachId> | GET | To get the content stream of attachments in an email. | |
| Get email content | /api/accounts/<accountId>/folders/folderId/ messages/<messageId>/content | GET | To get the content of a particular email message, based on the message id. | |
| Get email headers | /api/accounts/<accountId>/folders/folderId/ messages/<messageId>/header | GET | To get the email headers of a particular email message, based on the message id. | |
| Mark emails as read | /api/accounts/<accountId>/updatemessage | PUT | To mark single/ multiple emails as read, based on the list of message ids passed as parameters. | |
| Mark emails as unread | /api/accounts/<accountId>/updatemessage | PUT | To mark single/ multiple emails as unread, based on the list of message ids passed as parameters. | |
| Archive an email | /api/accounts/<accountId>/updatemessage | PUT | To archive an email or mulitple emails based on the message ids passed as parameters. | |
| Unarchive an email | /api/accounts/<accountId>/updatemessage | PUT | To unarchive an email or mulitple emails based on the message ids passed as parameters. | |
| Set flag for an email | /api/accounts/<accountId>/updatemessage | PUT | To set one among the three available flags to a particular email or a group of emails. | |
| Apply tag to an email | /api/accounts/<accountId>/updatemessage | PUT | To apply a tag to a particular email or a group of emails. | |
| Remove tag from an email | /api/accounts/<accountId>/updatemessage | PUT | To remove a tag from a particular email or a group of emails. | |
| Remove all tags from an email | /api/accounts/<accountId>/updatemessage | PUT | To remove all tags from a particular email or a group of emails. | |
| Move email | /api/accounts/<accountId>/updatemessage | PUT | To move a particular email or a group of emails from the existing folder to a different folder. | |
| Mark email as spam | /api/accounts/<accountId>/updatemessage | PUT | To mark a particular email or a group of emails as spam. | |
| Mark email as not spam | /api/accounts/<accountId>/updatemessage | PUT | To mark a particular email or a group of emails as not spam. | |
| Send an email | /api/accounts/<accountId>/messages | POST | To send an email specifying the From, To, Cc, Bcc, Subject, Encoding and Email format. | |
| Send an email with attachment | /api/accounts/<accountId>/messages | POST | To send an email with Attachment. | |
| Upload attachment | /api/accounts/<accountId>/messages/attachments | POST | To upload an file before attaching it with the email. | |
| Save Draft / Template | /api/accounts/<accountId>/messages | POST | To save content as a draft or as a template. | |
| /api/accounts/<accountId>/messages/<messageId> | POST | The API is used to send a reply to an email received. | ||
| Delete email | /api/accounts/<accountId>/folders<folderId>/messages/<messageId> | DELETE | To delete a particular email or a group of emails. | |
| Get original message | /api/accounts/<accountid>/messages/<messageid>/originalmessage | GET | To get the mime of particular email. | |
| Mark thread as read | /api/accounts/<accountId>/updatethread | PUT | To mark single/multiple email threads as read based on the list of thread ids passed as parameters. | |
| Mark thread as unread | /api/accounts/<accountId>/updatethread | PUT | To mark single/multiple email threads as unread based on the list of thread ids passed as parameters. | |
| Flag thread | /api/accounts/<accountId>/updatethread | PUT | To flag single/multiple email threads | |
| Apply Label to thread | /api/accounts/<accountId>/updatethread | PUT | To apply a label to single/multiple email threads | |
| Remove label from thread | /api/accounts/<accountId>/updatethread | PUT | To remove a label from single/multiple email threads | |
| Remove all labels from thread | /api/accounts/<accountId>/updatethread | PUT | To remove all labels from single/multiple email threads | |
| Move thread | /api/accounts/<accountId>/updatethread | PUT | To move single/multiple threads based on the list of thread ids passed as parameters. | |
| Mark thread as spam | /api/accounts/<accountId>/updatethread | PUT | To mark single/multiple threads as spam. | |
| Mark thread as not spam | /api/accounts/<accountId>/updatethread | PUT | To mark single/multiple threads as not spam. |