Email Activities
Properties Configuration Settings
The Email Activity adds SSL-protected email capability to the WorkFlow.
Remarks
The Email Activity provides an all-encompassing email client implementation to your WorkFlow. The activity supports both send and receive functionality over multiple protocols.
Email Receive Activity
The Email Receive Activity implements the IMAP and POP3 internet mail protocols. In order to use the Email Receiver activity, you must first select a ServerType. You must also enter a MailServer and User. For servers that require authentication, you will also have to enter a Password. To activate SSL, you must also select an SSLCert, and set the SSLAcceptServerCert and SSLStartMode. The activity will attempt to determine the correct port to connect to based on the server type and SSL settings. However, you may override the default by directly setting the MailPort in the property pages.
Once you have your port set up, the activity will connect to the server once every PollingInterval and download messages. To control how the messages are downloaded, or to prevent duplicate messages from being fetched from the mail server, you may set the DeleteMode to an appropriate value. For IMAP connections, you may also set a Filter.
The activity will write as much information as it has regarding the emails to various properties in the message context that can be polled at runtime. These include From, SendTo, Subject and MessageHeaders. The message headers may also be included with the message body by setting the IncludeHeaders property to True.
Email Send Activity
The Email Send Activity is a complete SMTP client. To send emails from the activity you must set at a minimum your SMTPServer, as well as your From and SendTo email addresses. Should you need to guarantee a secure transmission, you may set the SSLCert and SSLStartMode properties, as well as a specific SSLAcceptServerCert.
You may also add carbon copy and blind carbon copy recipients via the Cc and BCc properties. If you wish to receive delivery or read notifications, you can set the DeliveryReceipt and ReadReceipt properties. You may set the Subject of your message. The contents of the outbound message will be sent as the body of the email.
Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.
Receiver Property List
The following is the full list of the properties of the receiver activity with short descriptions. Click on the links for further details.
AuthMode | The authentication mode to be used when connecting to the MailServer . |
Delete | Controls if the email is deleted after download. |
Filter | A filter to be applied to the inbox when selecting messages. |
Firewall | A set of properties related to firewall access. |
IncludeHeaders | Instructs the activity to include or ignore message headers. |
LogFile | The file to write logging information to at runtime. |
LogMode | What information gets logged during activity execution. |
MailFolder | Name of the mailbox selected on the server. |
MailPort | The port of the mail server (IMAP or POP3). |
MailServer | The name or address of the mail server (IMAP or POP3). |
MessageList | Collection of the last message listing entries. |
Operation | The operation which will be executed by the Email task. |
Other | Defines a set of configuration settings to be used by the activity. |
Password | A password for login. |
PersistentConnection | Instructs the activity whether to keep the connection to the server open. |
RuntimeLicense | Specifies the activity runtime license key. |
ServerType | The type of server for your email account. |
SSLAcceptServerCert | Instructs the activity to unconditionally accept the server certificate that matches the supplied certificate. |
SSLAcceptServerCertAcceptAny | Tells the activity to accept any server certificate. |
SSLCert | The certificate to use for client authentication during the SSL handshake. |
SSLStartMode | Determines how the activity starts the SSL negotiation. |
Timeout | A timeout for the activity. |
User | A user id for login. |
Sender Property List
The following is the full list of the properties of the sender activity with short descriptions. Click on the links for further details.
Attachments | Specifies which files the activity should include as attachments in the outgoing message. |
AuthMode | The authentication mode to be used when connecting to the MailServer . |
BCc | A comma separated list of addresses for blind carbon copies (optional). |
Cc | A comma separated list of addresses for carbon copies (optional). |
DeliveryReceipt | Whether or not a delivery receipt should be returned to the sender. |
Firewall | A set of properties related to firewall access. |
From | The email address of the sender (required). |
LogFile | The file to write logging information to at runtime. |
LogMode | What information gets logged during activity execution. |
MessageHeaders | Message headers associated with the current email message. |
MessageHTML | The HTML text of the message. |
Other | Defines a set of configuration settings to be used by the activity. |
Password | A password for login. |
PersistentConnection | Instructs the activity whether to keep the connection to the server open. |
ReadReceipt | Whether or not a receipt should be sent when the email has been read. |
ReplyTo | A mail address to reply to (optional). |
RuntimeLicense | Specifies the activity runtime license key. |
SendTo | A comma separated list of addresses for destinations (required). |
SMTPMessageId | The id of the mail message (optional). |
SMTPPort | The server port for SMTP (default 25). |
SMTPServer | The name or address of a mail server (mail relay). |
SSLAcceptServerCert | Instructs the activity to unconditionally accept the server certificate that matches the supplied certificate. |
SSLAcceptServerCertAcceptAny | Tells the activity to accept any server certificate. |
SSLCert | The certificate to use for client authentication during the SSL handshake. |
SSLStartMode | Determines how the activity starts the SSL negotiation. |
Subject | The subject of the mail message (optional). |
Text | The text of the mail message (optional). |
Timeout | A timeout for the activity. |
User | A user id for login. |
Configuration Settings
The following is a list of configuration settings for the activity with short descriptions. Click on the links for further details.
AttachmentDirectory | Specifies the directory to which attachments are saved. |
AutoDecodeHeaders | Whether to decode headers. |
AttachmentNameSource | Specifies the source location in the MIME entity from which the filename is retrieved. |
AutoDecodeMessageText | Whether to decode non-MIME message text. |
AttachmentType[index] | Content-type for attached file (at index). |
DuplicateAttachmentAction | Specifies what action to take when a duplicate filename is encountered. |
IncludeAttachments | Determines if additional message parts are added to the outgoing E-Mail as attachments. |
IncludeFilterInURI | Determines if the Filter is appended to the URI. |
MessageTextEncoding | When set, the Text values will be encoded using the specified encoding. |
MoveTo | Specifies the IMAP folder on the server to which messages will be moved. |
ReturnPath | Sets the Return-Path to be used for sending email. |
ReturnOnlyPlainTextPart | Specifies if the activity should return the first plain text part or the entire message. |
UIDMode | If true, permanent message identifiers will be used instead of the default temporary identifiers. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseManagedSecurityAPI | Tells the activity whether or not to use the system security libraries or a managed implementation. |
PersistedConnectionTimeout | How long to leave a persisted connection alive. |