Delete Folder

This Email tool deletes a folder on the email server.

Note: The Email tools cannot delete folders located on user’s local machines. This tool deletes a folder on the mail server.

Inputs

Folder ID

The unique identifier for the folder being deleted. This ID is retrieved with an Incoming Mail initiator, or the Open Folder tool.

Folder Name

The string value that contains the name of the folder to be deleted.

Delete Messages

A boolean value to signify deleting messages if contained with in the folder targeted for deletion.

Delete Subfolders

A boolean value to signify deleting subfolders if contained with in the folder targeted for deletion.

Timeout

The number of seconds the tool will wait for a return value. This field accepts floating point numbers, so you can enter fractions of a second for more granularity. For example, 4.5 seconds (equivalent to 4500 milliseconds).

Outputs

Result

The results of the operation.

See Email Tool Result Codes for more information.

Exit Paths

Success

If this step executes successfully, this step will take the Success exit path.

Failure

The folder could not be deleted. The most likely cause is the mailbox or folder name (or both) were invalid.