Email Configuration
The adapter accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the adapter, access to these internal properties is provided through the Other property.Email Configuration Settings
| DeleteOnSuspend: Specifies whether files may be deleted from server when message is suspended.If true, the file on the server will be deleted in accordance with the option selected in DeleteMode even if the message is suspended.
The default value is False. | |||||||||
| AttachmentDirectory: Specifies the directory to which attachments are saved.When retrieving messages from a mail server, this setting may be set to a full path to which attachments should be saved. For example "C:\download\attachments". This setting is valid only when receiving messages, and is supported when using both the IMAP and POP protocols. If a file with the same name as the attachment exists it will be overwritten. | |||||||||
| AutoDecodeHeaders: Whether to decode headers.When retrieving messages from the server, this setting specifies whether headers are automatically decoded by the adapter. When IncludeHeaders is set to True this setting may also be set to False to ensure that the original header values are included without any processing applied. This is helpful in scenarios when further processing of the message is done outside of the adapter. The default value is True. | |||||||||
AttachmentNameSource: Specifies the source location in the MIME entity from which the filename is retrieved.When set to 0 (default), the adapter will use the usual header attributes to determine the filename of the attachment that is saved to disk. If these values are not present, the name attribute from the Content-Type header may be used by setting this configuration setting to 1. Note that use of the name attribute for Content-Type is deprecated, but this configuration setting is present to allow for backward compatibility.
Possible value are:
| |||||||||
| AutoDecodeMessageText: Whether to decode non-MIME message text.When retrieving non-MIME encoded messages from the server, this setting specifies whether encoded messages (e.g., Base64 encoded message) are automatically decoded by the adapter. This configuration option is only valid for messages that are not MIME encoded. The default value is False. | |||||||||
| AttachmentType[index]: Content-type for attached file (at index).This configuration setting allows you to set the Content-Type for each attached file. Valid array indices are from 0 to AttachmentCount - 1. To set the Content-Type for the attachment at index 2 you would set the string "AttachmentType[2]=application/octet-stream". | |||||||||
DuplicateAttachmentAction: Specifies what action to take when a duplicate filename is encountered.This setting determines what happens when AttachmentDirectory is set and a duplicate filename is encountered.
Possible value are:
| |||||||||
IncludeAttachments: Determines if additional message parts are added to the outgoing E-Mail as attachments.This is only applicable when sending. The following values may be set to indicate which BizTalk message parts are treated as attachments.
| |||||||||
| IncludeFilterInURI: Determines if the Filter is appended to the URI. This allows for unique URIs with the same Mail Server, Mail Folder, and User when the Filter property is set. Note: This is only available in the Email Receiver. | |||||||||
MessageTextEncoding: When set, the Text values will be encoded using the specified encoding.This is only applicable if an attachment is set as well as Text.
When set to one of the below integer values, the Text property will be encoded
using the specified encoding. The "Content-Transfer-Encoding" header will also be set for the plain text parts.
The following encodings are supported:
| |||||||||
| MoveTo: Specifies the IMAP folder on the server to which messages will be moved.If set, the adapter will move the downloaded messages to the folder specified. This is only applicable when ServerType is set to IMAP.
Only successfully downloaded messages will be moved.
This is only applicable when receiving. | |||||||||
| ReturnPath: Sets the Return-Path to be used for sending email.Setting this property sets the Return-Path to be used for sending email. If this is not set, the value in From is used.
This is only applicable when sending emails. | |||||||||
| ReturnOnlyPlainTextPart: Specifies if the adapter should return the first plain text part or the entire message.If set to true the adapter will return only the first plain text part of a message. This is false by default. This is only applicable when receiving messages. | |||||||||
| UIDMode: If true, permanent message identifiers will be used instead of the default temporary identifiers.When False (default), the IMAP server uses temporary message identifiers that are valid only during the current session. If this configuration setting is True, permanent message identifiers will be used instead.
The IMAP protocol operations where UID mode is used are the following: COPY, FETCH, STORE, SEARCH. Note: This configuration setting only applies when ServerType is set to IMAP; |
SSL Configuration Settings
| SSLEnabledProtocols: Used to enable/disable the supported security protocols.Used to enable/disable the supported security protocols.
Not all supported protocols are enabled by default (the value of this setting is 240). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:
TLS 1.1 and TLS1.2 support are only available starting with Windows 7.
|
General Configuration Settings
| AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout. | |
| LocalHost: The name of the local host or user-assigned IP interface through which connections are initiated or accepted.The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the adapter initiate connections (or accept in the case of server adapters) only through that interface. If the adapter is connected, the LocalHost configuration shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). | |
| TcpNoDelay: Whether or not to delay when sending packets.
When true, the socket will send all data that is ready to send at once. When
false, the socket will send smaller buffered packets of data at small intervals.
This is known as the Nagle algorithm.
By default, this config is set to false. | |
| UseManagedSecurityAPI: Tells the adapter whether or not to use the system security libraries or a managed implementation.
By default the adapter will use the system security libraries to perform cryptographic functions. This means
calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security
implementation set this setting to True. Setting this to True tells the adapter to use the internal managed implementation
instead of using the system's security API.
Note that when this value is set the product's system dll is no longer required as a reference, as all unmanaged code is stored in this file. |
Connections Configuration Settings
| PersistedConnectionTimeout: How long to leave a persisted connection alive.If persisted connections are enabled and PersistedConnectionTimeout is set to a positive value, the connection will be kept alive for that number of minutes after a message transmission. If no other messages are sent over that connection during the timeout period, the adapter will disconnect from that server.
Note: the default value is 0. This value means that the connection will be kept alive unless the server disconnects it due to idling. |
Supported Macros
The adapter also supports the following Macros. These values are not case sensitive and would be supplied to a property in the form %MacroName%.
| Temp | This is resolved to the full path to the system's temporary directory. |
| MessageID | Globally unique identifier (GUID) of the message in BizTalk Server. |
| SourceFileName | The original file name. This includes the extension and excludes the file path, for example, Sample.xml |
| SourceFileNameNoExt | The original file name without the extension or file path, for example, Sample |
| RemoteFileName | The name of the file as it was uploaded to the remote server. This includes the extension and excludes the file path, for example, Sample.xml. Valid only for AS3, FTP, and SFTP Send Adapters. |
| DestinationParty | Name of the destination party. |
| DestinationPartyQualifier | Qualifier of the destination party. |
| SourceParty | Name of the source party. |
| SourcePartyQualifier | Qualifier of the source party. |
| DateTime:CustomFormat | This special value allows you to specify your own custom time format. For instance DateTime:yyyy would be resolved to the 4 digit year. |
| Date | The date format yyyy-MM-dd. |
| DateTime | The date format yyyy-MM-ddThhmmss. |
| Time | The date format hhmmss. |
| DateTime_BTS2000 | The date format yyyyMMddhhmmssf. |
| DateTime.TZ | The date format yyyy-MM-ddThhmmsszzz. |
| Time.TZ | The date format hhmmsszzz. |