Email Adapter

The Email Adapter adds SSL-protected email capability to the BizTalk Server.

Remarks

The Email Adapter provides an all-encompassing email client implementation to your BizTalk Server. The adapter supports both send and receive functionality over multiple protocols.

Email Receive Adapter

The Email Receive Adapter implements the IMAP and POP3 internet mail protocols. In order to use the Email Receiver adapter, 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 adapter 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 adapter 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 adapter 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 Adapter

The Email Send Adapter is a complete SMTP client. To send emails from the adapter 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 adapter with short descriptions. Click on the links for further details.


AuthMode	The authentication mode to be used when connecting to the MailServer .
DeleteMode	Controls if and when the email is deleted after download.
ErrorThreshold	The maximum number of errors before the adapter shuts down.
Filter	A filter to be applied to the inbox when selecting messages.
Firewall	A set of properties related to firewall access.
IncludeHeaders	Instructs the adapter to include or ignore message headers.
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).
MaxBatchSize	The maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCount	The maximum number of files in the current batch (0 indicates no limit).
MaxFileSize	The maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreads	The maximum number of threads that the adapter may consume.
MessageCc	A comma separated list of addresses for carbon copies.
MessageDate	The date a message was sent.
MessageFrom	The email address of the author of the message.
MessageHeaders	Message headers associated with the current email message.
MessageId	The id of the current message.
MessageSender	The email address of the sender.
MessageSize	The size of the current message.
MessageSubject	The subject of the mail message.
MessageTo	A comma separated list of addresses for destinations.
Other	Defines a set of configuration settings to be used by the adapter.
Password	A password for login.
PersistentConnection	Instructs the adapter whether to keep the connection to the server open.
PollingInterval	The amount of time, in seconds, between download attempts.
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicense	Specifies the adapter runtime license key.
ServerType	The type of server for your email account.
SSLAcceptServerCert	Instructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
SSLStartMode	Determines how the adapter starts the SSL negotiation.
Timeout	A timeout for the adapter.
TransportLog	Tells the adapter where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
User	A user id for login.

Sender Property List

The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.


Attachments	Specifies which files the adapter 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).
ConnectionLifetime	Instructs the adapter whether or not to leave the connection to the server open.
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).
MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending.
MaxThreads	The maximum number of threads that the adapter may consume.
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch.
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 adapter.
Password	A password for login.
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 adapter 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 adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
SSLStartMode	Determines how the adapter 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 adapter.
TransmitBatchMode	How the transmitter processes batches.
TransportLog	Tells the adapter where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
User	A user id for login.

Configuration Settings

The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.


DeleteOnSuspend	Specifies whether files may be deleted from server when message is suspended.
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 adapter 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 adapter whether or not to use the system security libraries or a managed implementation.
PersistedConnectionTimeout	How long to leave a persisted connection alive.