Service Info: mail
Service Description
This service provides operations that allow you to interact with the e-mail feature and the address books within the mail system of Hornbill ESP.
Available Operations
The following operations are available for the mail service. You can click on each operation to see detailed information about that operation.
| Operation | Description |
|---|---|
| addMessageCrossReference | This method is used to add a mail message cross reference. |
| addMessageToQueue | This method is used to add the mail message to the inbound queue. |
| checkOriginDomain | This method is used to check that the domain, or domain within an email address is valid for this instance. If an email address is defined,
and the domain is 'live.hornbill.com' then the email address component must be made up as ANYNAME- |
| checkServiceAvailability | This method is used to check the service availability. |
| deleteMessage | This method is used to delete the specified message(s). |
| deliveryResend | |
| directMessageDeliveryResend | This method is used to resend a message to one or more recipients. |
| directMessageGet | This method is used to get a message from the direct message queue. |
| directMessageGetDeliveryLog | This method is used to get a mail message delivery status log. |
| directMessageGetList | This method is used to get the list of messages stored in the specified folder. |
| directMessageSearch | This method is used to search the list of messages sent via sentMessageDirect API. |
| directMessageSearchInfo | This method is used to return information about the data set that can be searched. |
| directMessageSend | This method is used to send a mail message directly to one or more recipients without going through a shared or personal mailbox. This operation will return as soon as the message has been successfully queued for delivery. |
| directMessageSendEntityTemplate | This method is used to send a mail message directly using entity mail template to one or more recipients without going through a shared or personal mailbox. This operation will return as soon as the message has been successfully queued for delivery. |
| folderCreate | This method is used to create a new folder in the specified mailbox. |
| folderDelete | This method is used to delete an existing folder. Deleting folder does not permanently remove them from the mailbox. Rather, folder you delete is moved to the Deleted Items folder. If the folder is deleted from the Deleted Items folder then it will be permanently removed from the mailbox. |
| folderEmpty | This method is used to delete all messages contained within the specified folder. This operation will only delete messages that are contained in the specified folder, it will not delete sub-folders or messages within any sub-folders. This operation is asynchronous and will return immediately. You can check the progress by calling the system::backgroundJobStatus operation. |
| folderFavoriteGetList | This method is used to get the list of favorite folders for the current user. |
| folderFavoriteRemove | This method is used to remove a mailbox folder as a favorite folder. |
| folderFavoriteSet | This method is used to mark a mailbox folder as a favorite folder. |
| folderGetInfo | This method is used to get an existing folder. |
| folderGetInfoFromPath | This method is used to get information about a specific folder, using a slash-separated path. |
| folderGetList | This method is used to get the list of folders for the specified mailbox. This method will only return folders at a single level of the hierarchy. |
| folderGetSpecialFolders | This method is used to get the list of special folders for the specified mailbox. Use this to get the ID's of the special function folders such as Inbox, Outbox, Sent Items, Deleted Items and Drafts folders. |
| folderMove | This method is used to move an existing folder. |
| folderRename | This method is used to rename an existing folder. |
| getEntityTemplateMessagePreview | This method is used to generate an Email Preview from an Entity Email Template. |
| getInboundFileAttachments | EXPERIMENTAL: This method is used to get inbound message file attachment properties for the specified file. For already processed email file attachments use mail::getMessage instead |
| getLockedBy | This method is used to get the user who locks the specified message. |
| getMailboxList | This method is used to get the list of mailboxes. |
| getMessage | This method is used to get a mail message. |
| getMessageCount | Gets the count of messages stored in the specified folder. |
| getMessageDeliveryLog | This method is used to get a mail message delivery status log. |
| getMessageList | This method is used to get the list of messages stored in the specified folder. |
| getOriginDomainList | This method is used to get a list of email deomains configured on this instance for outbound mail delivery |
| getUserMailboxRights | This method is used to get the list of mailboxes and associated rights granted to the mailboxes for the specified user. |
| lockMessage | This method is used to lock the specified message. |
| mailGetUnreadCounts | This method is used to get unread message counts. |
| markFolderRead | EXPERIMENTAL: This method is used to mark all the messages for the specified folder as Read. This process may take several seconds or longer if folder have accumulated thousands of unread messages. |
| markMessageRead | This method is used to mark the specified message(s) as Read. |
| markMessageUnread | This method is used to mark the specified message(s) as Unread. |
| moveMessage | This method is used to move one or more messages to a folder. |
| saveMessage | This method is used to save a mail message to the Drafts folder. |
| searchMessage | This method searches the mail index and returns a list of documents matching this query. |
| sendEntityTemplateMessage | This method is used to send a mail message using mail template. |
| sendMessage | This method is used to send a mail message. |
| sendTemplateMessage | This is DEPRECATED and should not be used, USE mail::sendEntityTemplateMessage INSTEAD This method is used to send a mail message using mail template. |
| setMailboxNotificationContext | This method is used to set the mailbox notification context for the current session. |
| setMessageFlagged | This method is used to flag the specified message(s). |
| synchronizeIndex | This method synchronizes the mail index with the database. |
| unlockMessage | This method is used to unlock the specified message. |
| updateMailFileAttachment | Attaches a file to the mail message. |