Forward Message

This Email tool forwards an e-mail (or voice or fax mail) to another email user. If a recording is provided, the resulting message will be a voicemail unless another message class is given. This tool (unlike the Send Email, Send Fax Mail, and Send Voice Mail tools) performs some synchronous interaction with the mail server before queuing messages for alter sending.

Inputs

Folder ID

The folder that contains the email to be forwarded. This ID is retrieved with an Incoming Mail initiator, or the Open Folder tool.

Index

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

To Recipients

Specifies the recipient of the message. Separate multiple email addresses with a semicolon. If you leave the To and CC parameters empty, the message is sent to the address specified in the Unaddressed Mail Recipient server parameter.

CC Recipients

Specifies who should receive a copy of this email. Separate multiple email addresses with a semicolon.

BCC Recipients

Optionally specifies recipients who should receive a "Blind Carbon Copy" of the reply message. Separate multiple email addresses with a semicolon.

Reply To

Optionally specifies one or more email addresses to which the recipients of the reply message should direct their own replies. Separate multiple email addresses with a semicolon.

Sender

Optionally specifies a local email address from which this reply message should be sent. The email system will generate the reply message in the outbox folder of the mailbox associated with this address, so that it will appear to the recipients as if the message originated from the owner of that mailbox. The transmission of the reply message will fail if the mailbox associated with this address is not accessible by the email system. If no From address is specified, the message will originate in the outbox folder of the mailbox belonging to the account under which the CIC email system is running. Separate multiple email addresses with a semicolon.

Subject

Specifies the text on the subject line of the email message. This value is taken from the message that is forwarded.

Importance

Specifies the importance of the message as "Low," "Normal," or "High."

Sensitivity

This parameter is a string that can have the value of "None", "Personal", "Private", or "Confidential". The default is "None", and this will also be used in the event that something other than one of the other three valid values is entered.

Body

A List of Email Body type. Specifies the text to appear in the body of the email message. You may enter a literal value or build a complex expression using the Expression Editor Assistant.

Message Attachments

An optional variable that identifies a message to be attached to the reply message.

Attached Files

A list of strings containing zero or more complete file system paths to files that will be copied into the reply message. As with the Send Email tool, this parameter is a list of strings, not a single string, so you cannot just type the file path in this parameter. Instead you must assign the attachment file paths to the elements in variable of type list of string.

Note: OLE attachments (for example, bitmaps rendered inline) are not visible, as attachments or otherwise, to handlers. As far as the handler tools are concerned, an email message consists of a text body and zero or more *file* attachments. Other sorts of attachments, such as embedded OLE objects and "nested" messages, are not accessible through the handler tools, since they are not supported or easily simulated on messaging systems other than Exchange (i.e. IBM Notes or IMAP).

Delete Attachments

When checked, all files in the Attachments List are deleted after they have been attached (copied) to the email message and successfully sent. Sometimes, especially when replying to or forwarding a message, you should create a temporary file and attach it to the message being sent. After the message is sent the temporary file needs to be deleted, but since outgoing mail is handled asynchronously in IP, the handler can't delete the file immediately after the tool returns, because the message most likely hasn't yet been processed. This checkbox simply passes the responsibility for deleting the file(s) on to the asynchronous service thread that actually sends the message since that thread is the only one that actually knows when it's safe to delete it (or them).

Recording ID

The file name of an attached audio recording.

Audio Format 

The format to use for audio recording. See Compress Audio File tool for possible values.

Normalize

Set this Boolean to True to normalize the audio recording. When a recording is normalized, it is analyzed to determine what the maximum volume level of the audio file is. A value 5% below the maximum value is then used to set the gain value that will bring the maximum volume level up or down to a standard level. This ensures that at a given station, all recordings will play back at the same relative volume. Using a value 5% below the maximum volume to calculate the gain prevents a short burst of static or similar anomalous noise from throwing off this volume adjustment.

Delivery Receipt

Set to True to prompt the recipient for a delivery receipt upon receiving this email. If the underlying mail system does not support this feature, it will be ignored.

Read Receipt

Set to True to prompt the recipient for a read receipt upon opening this email. If the underlying mail system does not support this feature, it will be ignored.

Saved Copies

String designating the mailbox cookie in which copies of the email are saved.

Message Class

The class of the message. Can be "text," "voice," and "fax."

Timeout

The number of seconds that the tool will wait for a return value.

Scheduled

The DateTime variable for the future delivery of a message.

Attachment Files

A list of attached file objects output from another tool, such as Make Attached File.

Outputs

Result

The results of the operation.

See Email Tool Result Codes for more information.

Exit Paths

Success

This tool (unlike the Send Email, Send Fax Mail, and Send Voice Mail tools) performs some synchronous interaction with the mail server before queuing messages for later sending. It will take the Success exit path if the message was queued for sending, but this does not guarantee that the message was sent or that the recipient's email address is valid.

Failure

This step takes the Failure exit path if the connection to mail server is dropped, but this is rare because such a failure would cause one of the previously called email tools to fail.