Delete Message

This Email tool deletes the indexed message from the given folder. If the email platform supports the concept of a "trash" folder and the tool has not been told to expunge the message, the message will be moved to the "trash" folder. If the email platform does not support the concept of a "trash" folder or the tool has been told to expunge the message, then the message will be deleted.

Inputs

Folder ID

A value returned by the Open Folder tool.

Index

The zero-based index of a message within the given folder. The index denotes the location of the message within the specified folder. The value for this parameter is generated by the Incoming Mail initiator or the Find Message tool.

Expunge

Set this to True if you want this tool to permanently delete the message. If set to False, the tool simply moves the message from the given folder to the current mailbox’s "Trash" folder.

Asynchronous

Whether or not the tool should wait until the status has been changed.

Timeout

The number of seconds the tool should wait for a return value. If no value is returned in the specified time, this tool will take the Failure exit path.

Outputs

Result

The results of the operation.

See Email Tool Result Codes for more information.

Exit Paths

Success

This step takes the Success exit path if the message was deleted successfully.

Failure

This step takes the Failure exit path if the folder or index was invalid.