folders
attribute of that email address and are retrieved along with the email address.listEmailFoldersForEmailAddressId
method by passing in the id
of the email address to query. This returns a ListOutput
object with the list of email folder objects which contain information used to identify each folder and to facilitate moving of messages between folders.EmailFolder
object contains useful information such as the name of the folder, the total size of all messages assigned to the folder and the total count of unseen messages assigned to the folder.previousFolderId
property which specifies the identifier of the folder that the message was previously in. An example implementation of using the updateEmailMessages
method to move a message to another folder is:updateEmailMessages
method to move a message to another folder is:createDraftEmailMessage
method. This method takes in a rfc822Data
input property which contains the email message content formatted under RFC 822 as well as the senderEmailAddressId
input property which must match the identifier of the email addess from the from
field in the RFC 822 data. A call to this method returns metadata of the saved draft. Draft email message data provides the ID of the draft and an updatedAt
timestamp representing the last time the draft was saved.updateDraftEmailMessage
method to update a previously created and saved draft email message. The input requires the id
of the previously saved draft to perform the update. It is a requirement that the entire message content be replaced with an updated version as part of the rfc822Data
input property. A call to this method returns the id
of the draft that was updated which should match the id
provided in the input.deleteDraftEmailMessages
method by passing in one or more draft message identifiers and the id
of the email address associated with the drafts.LimitExceededError
.BatchOperationResult
type is returned from this method call which contains the status of the batch delete operation. Three possible statuses can be returned:getDraftEmailMessage
method. This method takes in the id
of the draft to retrieve as well as the id
of the email address that is associated with the draft. This method returns the draft email message data if it exists.listDraftEmailMessageMetadata
to retrieve a list of all the metadata of the draft email messages associated with an email address. The metadata returned in the list can be used to retrieve individual draft email message content, perform an update to an already saved draft, or identify which drafts to perform full retrieval of based on updatedAt
timestamp.listDraftEmailMessageIds
to retrieve a list of all the identifiers of the draft email messages associated with an email address. The identifiers returned in the list can be used to retrieve individual draft email message content or perform an update to an already saved draft.