deleteEmailMessages

Delete multiple EmailMessages using a list of identifiers.

Email messages can only be deleted in batches of 100 or less. Anything greater will throw an EmailMessageException.LimitExceededException.

This API returns a BatchOperationResult:

  • On Success, all email messages succeeded to delete.

  • On Partial, only a partial amount of messages succeeded to delete. Result includes two lists; one containing identifiers of email messages that were successfully deleted, and the other containing identifiers and failure reasons of email messages that failed to delete.

  • On Failure, all email messages failed to delete. Result contains a list of identifiers of and failure reasons of email messages that failed to delete.

Return

A success, partial or failed BatchOperationResult result containing a list of ids of email messages that failed to delete, and/or a list of ids of email messages that were successfully deleted.

Parameters

ids

List A list of one or more identifiers of the email messages to be deleted. There is a limit of 100 email message identifiers per request. Exceeding this will cause an exception. to be thrown.

Throws