Open Folder

This Email tool opens a folder and loads it with messages that match the given criteria. If the folder is opened asynchronously, then no message count will be available.

Note: The Email tools cannot access folders located on user’s local machines. In order for the Open Folder tool to work, the folder being accessed must reside on the mail server.

Inputs

Mailbox

A mailbox identification string based on the Interaction Message Store moniker for the mailbox. The following example uses Exchange Web Services (EWS):

ININ.Mail.ObjectMoniker:<x-inin-mail.ex.ews.store:/s=mailbox@test.com>

In this example, replace mailbox@test.com with the actual SMTP address of the mailbox.

Folder Name

The string value that contains the name of the folder to be opened. Subfolders are specified by using a semicolon separator. For example, a subfolder of Inbox named "Personal" would be passed in as "Inbox;Personal." If the empty string is specified, the "Root" special folder is opened.

There are certain "special folders" that represent well-known mail folders whose names and presence are user or platform dependent.

For example:

• On an Exchange server, the special folder "Inbox" will be named "Inbox" for an English user, but not for other languages.

• The special folder "Deleted Items" might be called "Deleted Items" on an Exchange server, but "Trash" on an IMAP server.

• The special folder "Outbox" will exist on an Exchange server, but typically will not exist on an IMAP server (since IMAP is not a protocol for delivering messages).

This tool interprets these "special folders" as reserved names representing the well-known folders. This is useful, for example, if some users are on Exchange and some are on IMAP, and you want to target the correct folder for both without having to worry about whether to pass in "Deleted Items" or "Trash" for a certain user.

The special folders supported by the tool are:

• Root

• Inbox

• Outbox

• Sent Items

• Deleted Items

• Scratch - (the "Drafts" folder on Exchange)

You can use the Query Mail System tool to determine support for special folders for a particular platform.

Max Count

The maximum number of messages to open. No value or a value of 0 will retrieve all messages.

If this parameter is defined, it will be applied before any of the other filters, except when the "Message Class" parameter is used with an Exchange mailbox. In this case those two filters will be applied concurrently.

Reverse Order

Set to True to reverse the default order in which the messages are opened by the mail server. The default order is dependent on the underlying mail system.

Reverse Index

Set to True to reverse the order in which messages are indexed.

Status 

Only messages with this status (read or unread) will be searched.

Importance 

Only messages with this importance (low, high, or normal) will be searched.

Sensitivity 

Only messages with this sensitivity (personal, private, confidential, or none) will be searched.

Message Class 

Only messages with this class (text, voice, fax, or ndr) will be searched.

Subject 

Only messages with this subject will be searched. Uses a regular expression.

Sender 

Only messages from this sender will be searched (friendly name or email address). Uses a regular expression.

Start Date/Time 

Only message received after this date and time will be searched.

End Date/Time 

Only messages received before this date and time will be searched.

Asynchronous 

Set this to true if you want the tool should to until the messages have been loaded before exiting.

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

Folder ID

An extended type value that identifies the open folder.

Unread Count

The total number of unread messages in the folder.

Read Count

The total number of read messages in the folder.

Unread Voice

The total number of unread voice mail messages in the folder.

Read Voice

The total number of read voice mail messages in the folder.

Unread Fax

The total number of unread faxes in the folder.

Read Fax

The total number of read faxes in the folder.

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 step takes the Failure exit path if the folder could not be opened, probably because either the mailbox or folder name (or both) was invalid.