SMIMEEmail Adapter

Properties   Config Settings  

The SMIMEEmail Component adds S/MIME-protected email capability to the BizTalk Server.

Remarks

The SMIMEEmail Adapter adds support for sending and receiving S/MIME-protected emails to BizTalk Server. The adapter allows you to encrypt and sign emails before sending and decrypt and verify signatures on received emails.

SMIMEEmail Receiver Adapter

The SMIMEEmail Receiver adapter is the S/MIME enabled equivalent of the Email Receive adapter. In addition to standard IMAP and POP3 functions, the SMIMEEmail Receiver adapter can decrypt and/or verify message signatures. In order to use the SMIMEEmail 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 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 MessageFrom, MessageTo, MessageSubject and MessageHeaders. The message headers may also be included with the message body by setting the IncludeHeaders property to True.

When it receives an email, the SMIMEEmail Reciever adapter will detect if the message is encrypted and attempt to decrypt it using the certificate in the Certificate property. If the message is signed, it will also attempt to verify the signature using the certificate in the SignerCert property.

SMIMEEmail Sender Adapter

The SMIMEEmail Sender Adapter is a complete SMTP client that can also encrypt and sign emails. 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.

If you want to encrypt an email you are sending, set the RecipientCert property to the receiver's certificate, set the EncryptData property to true, and set EncryptingAlgorithm to the encryption algorithm you want to use. To sign an email, set the Certificate property to your certificate, set the SignData property to true, and set the SigningAlgorithm property to the hash algorithm you want to use for signing.

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.

AttachmentDirectory	Specifies the directory to which attachments are saved.
AuthMode	The authentication mode to be used when connecting to the MailServer .
Certificate	The Certificate used to sign (Encoder) and decrypt (Decoder) messages.
DeleteMode	Controls if and when the email is deleted after download.
ErrorThreshold	The maximum number of errors before the component 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 component 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 component 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.
MessageNetId	The globally unique identifier of the 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.
OAuthAuthorization	OAuth Authorization Information.
Other	Defines a set of configuration settings to be used by the component.
Password	A password for login.
PersistentConnection	Instructs the component 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.
RequireEncryption	Whether an error should be thrown if a received message is not encrypted.
RequireOAEP	Whether an error should be thrown if OAEP was not used to encrypt the incoming message.
RequirePSS	Whether an error should be thrown if RSA-PSS was not used to encrypt the incoming message.
RequireSignature	Whether an error should be thrown if a received message is not signed.
RolloverCertificate	The rollover decryption certificate.
RuntimeLicense	Specifies the component runtime license key.
ServerType	The type of server for your email account.
SignerCert	Contains the certificate of the message signer.
SSLAcceptServerCert	Instructs the component 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 component starts the SSL negotiation.
TempPath	The path to which temporary files are written at runtime.
Timeout	A timeout for the component.
TransportLog	Tells the component 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 component 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).
Certificate	The Certificate used to sign (Encoder) and decrypt (Decoder) messages.
ConnectionLifetime	Instructs the component whether or not to leave the connection to the server open.
DeliveryReceipt	Whether or not a delivery receipt should be returned to the sender.
EncryptData	Whether to encrypt the MIME data.
EncryptingAlgorithm	The algorithm to use for encryption.
Firewall	A set of properties related to firewall access.
From	The email address of the sender (required).
IncludeCertificate	Specifies whether to include the signer's certificate with the signed message.
IncludeChain	Specifies whether to include the signer's certificate chain with the signed message.
MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending.
MaxThreads	The maximum number of threads that the component 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.
MessageText	The text of the mail message (optional).
OAuthAuthorization	OAuth Authorization Information.
Other	Defines a set of configuration settings to be used by the component.
Password	A password for login.
ReadReceipt	Whether or not a receipt should be sent when the email has been read.
RecipientCert	The certificate used to encrypt the MIME data.
ReplyTo	A mail address to reply to (optional).
RuntimeLicense	Specifies the component runtime license key.
SendTo	A comma separated list of addresses for destinations (required).
SignData	Whether to sign the MIME data.
SigningAlgorithm	Textual description of the signature hash algorithm.
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 component 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 component starts the SSL negotiation.
Subject	The subject of the mail message (optional).
TempPath	The path to which temporary files are written at runtime.
Timeout	A timeout for the component.
TransmitBatchMode	How the transmitter processes batches.
TransportLog	Tells the component where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
UseOAEP	Whether to use OAEP when encrypting the MIME data.
UsePSS	Whether to use RSA-PSS when signing.
User	A user id for login.

Config Settings

---

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

AutoNormalizeLF	Whether to automatically determine how to normalize the MIC when verifying a signature.
ContinueOnSMIMEError	Specifies whether further emails are processed after encountering an error.
SMIMECapabilities	Specifies the algorithms to include in the sMIMECapabilities object in the signature.
AddAttachmentsAsMessageParts	Includes attachments as additional parts on the message.
AttachmentEncoding[index]	Content-Transfer-Encoding for attached file (at index).
AttachmentName[index]	Filename for the attached file (at index).
AttachmentNameSource	Specifies the source location in the MIME entity from which the filename is retrieved.
AttachmentType[index]	Content-type for attached file (at index).
AutoDecodeHeaders	Whether to decode headers.
AutoDecodeMessageText	Whether to decode non-MIME message text.
DeleteOnSuspend	Specifies whether files may be deleted from server when message is suspended.
DuplicateAttachmentAction	Specifies what action to take when a duplicate filename is encountered.
FoldHeaders	Whether incoming message headers should be folded.
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.
MaskSensitive	Whether sensitive properties should be masked when logging.
MaxParts	The maximum number of parts to be parsed from a mime message.
MessageHTMLFile	Specifies a file that will be included as the email's HTML content.
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.
ReturnOnlyPlainTextPart	Specifies if the component should return the first plain text part or the entire message.
ReturnPath	Sets the Return-Path to be used for sending email.
UIDMode	If True, permanent message identifiers will be used instead of temporary identifiers.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
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.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

SMIMEEmail Receiver

How to Configure a SMIMEEmail Receive Location with the BizTalk Server Administration Console

To configure the receive location by using the BizTalk Server Administration console, use the following procedure:

NOTE: Before completing the following procedure you must have already added a one-way receive port. For more information, see How to Create a Receive Port.

To configure receive location variables for a SMIMEEmail receive location:

1. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, and then expand the application you want to create a receive location in.
2. In the left pane, click the Receive Port node. Then in the right pane, right-click the receive port that is associated with an existing receive location or that you want to associate with a new receive location, and then click Properties.
3. In the left pane of the Receive Port Properties dialog box, select Receive Locations, and in the right pane double-click an existing receive location or click New to create a new receive location.
4. In the Receive Location Properties dialog box, in the Transport section next to Type, select nsoftware.SMIMEEmail 2022 from the drop-down list, and then click Configure to configure the transport properties for the receive location.
5. In the nsoftware.SMIMEEmail 2022 Transport Properties dialog box, you will find the following properties:

   AttachmentDirectory	Specifies the directory to which attachments are saved. Type: xs:string    Default Value: ""
   AuthMode	The authentication mode to be used when connecting to the MailServer . Type: xs:int    Default Value: 0
   Certificate	The Certificate used to sign (Encoder) and decrypt (Decoder) messages. Type: Certificate    Default Value: null NOTE: The digital id must have a private key associated with it.
   DeleteMode	Controls if and when the email is deleted after download. Type: xs:int    Default Value: 0
   ErrorThreshold	The maximum number of errors before the component shuts down. Type: xs:int    Default Value: 5
   Filter	A filter to be applied to the inbox when selecting messages. Type: xs:string    Default Value: ""
   Firewall	A set of properties related to firewall access. Type: Firewall    Default Value: null
   IncludeHeaders	Instructs the component to include or ignore message headers. Type: bool    Default Value: false
   MailFolder	Name of the mailbox selected on the server. Type: xs:string    Default Value: "Inbox"
   MailPort	The port of the mail server (IMAP or POP3). Type: xs:int    Default Value: 0
   MailServer	The name or address of the mail server (IMAP or POP3). Type: xs:string    Default Value: "" NOTE: This property must have a value.
   MaxBatchSize	The maximum size, in MB, of the current batch (0 indicates no limit). Type: xs:int    Default Value: 0
   MaxFileCount	The maximum number of files in the current batch (0 indicates no limit). Type: xs:int    Default Value: 10
   MaxFileSize	The maximum size, in MB, of a file in the current batch (0 indicates no limit). Type: xs:int    Default Value: 0
   MaxThreads	The maximum number of threads that the component may consume. Type: xs:int    Default Value: 20
   MessageCc	A comma separated list of addresses for carbon copies. Type: xs:string    Default Value: ""
   MessageDate	The date a message was sent. Type: xs:string    Default Value: ""
   MessageFrom	The email address of the author of the message. Type: xs:string    Default Value: ""
   MessageHeaders	Message headers associated with the current email message. Type: xs:string    Default Value: ""
   MessageId	The id of the current message. Type: xs:string    Default Value: ""
   MessageNetId	The globally unique identifier of the message. Type: xs:string    Default Value: ""
   MessageSender	The email address of the sender. Type: xs:string    Default Value: ""
   MessageSize	The size of the current message. Type: xs:int    Default Value: 0
   MessageSubject	The subject of the mail message. Type: xs:string    Default Value: ""
   MessageTo	A comma separated list of addresses for destinations. Type: xs:string    Default Value: ""
   OAuthAuthorization	OAuth Authorization Information. Type: OAuthAuthorizationParam    Default Value: null
   Other	Defines a set of configuration settings to be used by the component. Type: xs:string    Default Value: ""
   Password	A password for login. Type: baf:Password    Default Value: ""
   PersistentConnection	Instructs the component whether to keep the connection to the server open. Type: bool    Default Value: false
   PollingInterval	The amount of time, in seconds, between download attempts. Type: xs:int    Default Value: 60
   RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached. Type: bool    Default Value: false
   RequireEncryption	Whether an error should be thrown if a received message is not encrypted. Type: bool    Default Value: false
   RequireOAEP	Whether an error should be thrown if OAEP was not used to encrypt the incoming message. Type: bool    Default Value: false
   RequirePSS	Whether an error should be thrown if RSA-PSS was not used to encrypt the incoming message. Type: bool    Default Value: false
   RequireSignature	Whether an error should be thrown if a received message is not signed. Type: bool    Default Value: false
   RolloverCertificate	The rollover decryption certificate. Type: Certificate    Default Value: null NOTE: The digital id must have a private key associated with it.
   RuntimeLicense	Specifies the component runtime license key. Type: xs:string    Default Value: ""
   ServerType	The type of server for your email account. Type: xs:int    Default Value: 0 NOTE: This property must have a value.
   SignerCert	Contains the certificate of the message signer. Type: Certificate    Default Value: null
   SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. Type: Certificate    Default Value: null
   SSLCert	The certificate to use for client authentication during the SSL handshake. Type: Certificate    Default Value: null NOTE: The digital id must have a private key associated with it.
   SSLStartMode	Determines how the component starts the SSL negotiation. Type: xs:int    Default Value: 0
   TempPath	The path to which temporary files are written at runtime. Type: xs:string    Default Value: ""
   Timeout	A timeout for the component. Type: xs:int    Default Value: 60
   TransportLog	Tells the component where and how to report information about its operations. Type: Log    Default Value: null
   URI	The Uniform Resource Identifier (URI) of the send port or receive location. Type: xs:string    Default Value: ""
   User	A user id for login. Type: xs:string    Default Value: ""

6. Click OK.
7. Enter the appropriate values in the Receive Location Properties dialog box to complete the configuration of the receive location and click OK to save settings. For information about the Receive Locations Properties dialog box, see How to Create a Receive Location.

SMIMEEmail Transmitter

Setting the SMIMEEmail Adapter Configuration Properties for a Dynamic Send Port

A dynamic send port does not provide any transport configuration options in BizTalk Explorer because it is expected that these properties will be provided with the context properties associated with the message. These properties can be set in a custom pipeline or in an orchestration. To set message configuration properties in an orchestration you can do the following:

• Add a Construct Message shape to your orchestration.
• Configure the Construct Message shape to construct a new message. (for example Message_2)
• Add a Message Assignment shape to the Construct Message shape.
• Add code to the Message Assignment shape to initialize the message that you constructed and to set the appropriate configuration properties for the message.

Configuring the SMIMEEmail Send Port with the BizTalk Server Administration Console

To configure the send port by using the BizTalk Server Administration console, use the following procedure:

To configure variables for a SMIMEEmail send port:

1. In the BizTalk Server Administration console, create a new send port or double-click an existing send port to modify it. For more information, see How to Create a Send Port. Configure all of the send port options and specify nsoftware.SMIMEEmail 2022 for the Type option in the Transport section of the General tab.
2. On the General tab, in the Transport section, click the Configure button next to Type.
3. In the nsoftware.SMIMEEmail 2022 Transport Properties dialog box, use the following properties to:

   
   

   Attachments	Specifies which files the component should include as attachments in the outgoing message. Type: xs:string    Default Value: ""
   AuthMode	The authentication mode to be used when connecting to the MailServer . Type: xs:int    Default Value: 0
   BCc	A comma separated list of addresses for blind carbon copies (optional). Type: xs:string    Default Value: ""
   Cc	A comma separated list of addresses for carbon copies (optional). Type: xs:string    Default Value: ""
   Certificate	The Certificate used to sign (Encoder) and decrypt (Decoder) messages. Type: Certificate    Default Value: null NOTE: The digital id must have a private key associated with it.
   ConnectionLifetime	Instructs the component whether or not to leave the connection to the server open. Type: xs:int    Default Value: 0
   DeliveryReceipt	Whether or not a delivery receipt should be returned to the sender. Type: bool    Default Value: false
   EncryptData	Whether to encrypt the MIME data. Type: bool    Default Value: true
   EncryptingAlgorithm	The algorithm to use for encryption. Type: xs:string    Default Value: "3DES"
   Firewall	A set of properties related to firewall access. Type: Firewall    Default Value: null
   From	The email address of the sender (required). Type: xs:string    Default Value: "" NOTE: This property must be specified.
   IncludeCertificate	Specifies whether to include the signer's certificate with the signed message. Type: bool    Default Value: true
   IncludeChain	Specifies whether to include the signer's certificate chain with the signed message. Type: bool    Default Value: false
   MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending. Type: xs:int    Default Value: 1
   MaxThreads	The maximum number of threads that the component may consume. Type: xs:int    Default Value: 20
   MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch. Type: xs:int    Default Value: 1
   MessageHeaders	Message headers associated with the current email message. Type: xs:string    Default Value: ""
   MessageHTML	The HTML text of the message. Type: xs:string    Default Value: ""
   MessageText	The text of the mail message (optional). Type: xs:string    Default Value: ""
   OAuthAuthorization	OAuth Authorization Information. Type: OAuthAuthorizationParam    Default Value: null
   Other	Defines a set of configuration settings to be used by the component. Type: xs:string    Default Value: ""
   Password	A password for login. Type: baf:Password    Default Value: ""
   ReadReceipt	Whether or not a receipt should be sent when the email has been read. Type: bool    Default Value: false
   RecipientCert	The certificate used to encrypt the MIME data. Type: Certificate    Default Value: null
   ReplyTo	A mail address to reply to (optional). Type: xs:string    Default Value: ""
   RuntimeLicense	Specifies the component runtime license key. Type: xs:string    Default Value: ""
   SendTo	A comma separated list of addresses for destinations (required). Type: xs:string    Default Value: "" NOTE: This property must be specified.
   SignData	Whether to sign the MIME data. Type: bool    Default Value: false
   SigningAlgorithm	Textual description of the signature hash algorithm. Type: xs:string    Default Value: "SHA256"
   SMTPMessageId	The id of the mail message (optional). Type: xs:string    Default Value: ""
   SMTPPort	The server port for SMTP (default 25). Type: xs:int    Default Value: 25
   SMTPServer	The name or address of a mail server (mail relay). Type: xs:string    Default Value: "" NOTE: This property must be specified.
   SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. Type: Certificate    Default Value: null
   SSLCert	The certificate to use for client authentication during the SSL handshake. Type: Certificate    Default Value: null NOTE: The digital id must have a private key associated with it.
   SSLStartMode	Determines how the component starts the SSL negotiation. Type: xs:int    Default Value: 0
   Subject	The subject of the mail message (optional). Type: xs:string    Default Value: ""
   TempPath	The path to which temporary files are written at runtime. Type: xs:string    Default Value: ""
   Timeout	A timeout for the component. Type: xs:int    Default Value: 60
   TransmitBatchMode	How the transmitter processes batches. Type: xs:int    Default Value: 0
   TransportLog	Tells the component where and how to report information about its operations. Type: Log    Default Value: null
   URI	The Uniform Resource Identifier (URI) of the send port or receive location. Type: xs:string    Default Value: ""
   UseOAEP	Whether to use OAEP when encrypting the MIME data. Type: bool    Default Value: false
   UsePSS	Whether to use RSA-PSS when signing. Type: bool    Default Value: false
   User	A user id for login. Type: xs:string    Default Value: ""

4. Click OK and OK again to save settings.

AttachmentDirectory Property (SMIMEEmail Adapter)

Specifies the directory to which attachments are saved.

Data Type

String

Default Value

""

Remarks

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. The DuplicateAttachmentAction will determine what happens if a file with the same name already exists.

This property is not available in the Sender.

Attachments Property (SMIMEEmail Adapter)

Specifies which files the component should include as attachments in the outgoing message.

Data Type

String

Default Value

""

Remarks

Attachments may be used when sending an email to specify which files will be included as attachments to the outgoing message.

The value should be a pipe ("|") -delimited sequence of one or more filenames. The filenames should be specified with paths if necessary, so that the files may be found on the local file system.

If this property is set to an empty string, no attachments will be included in the outgoing message.

This property is not available in the Receiver.

AuthMode Property (SMIMEEmail Adapter)

The authentication mode to be used when connecting to the MailServer .

Data Type

Enumeration

Possible Values

Login (0)
CRAMMD5 (1)
NTLM (2)
APOP (3)
SASLPlain (4)
XOAUTH2 (5)

Default Value

0

Remarks

The following authentication modes are supported by the Email adapter:

The default AuthMode is Login.

BCc Property (SMIMEEmail Adapter)

A comma separated list of addresses for blind carbon copies (optional).

Data Type

String

Default Value

""

Remarks

The BCc property specifies a comma separated list of destinations for blind carbon copies of the mail message. A copy of the message is sent to each destination, but no BCc SMTP header is created containing the destination addresses, so individual recipients never see the list of the other recipients.

The adapter will stop processing the message and log an error if the SMTPServer returns an error code about any email address specified in SendTo or Cc, but it will only log warnings if the same happens with an email address specified in BCc.

This property is not available in the Receiver.

Cc Property (SMIMEEmail Adapter)

A comma separated list of addresses for carbon copies (optional).

Data Type

String

Default Value

""

Remarks

The Cc property specifies a comma separated list of destinations for carbon copies of the mail message. A copy of the message is sent to each destination, and a Cc SMTP header is created containing the destination addresses. This header is sent to every recipient of the message. If you don't want to copy this information to every recipient, then use blind carbon copies instead (see the description of the BCc).

The adapter will stop processing the message and log an error if the SMTPServer returns an error code about any email address specified in SendTo or Cc, but it will only log warnings if the same happens with an email address specified in BCc.

This property is not available in the Receiver.

Certificate Property (SMIMEEmail Adapter)

The Certificate used to sign (Encoder) and decrypt (Decoder) messages.

Data Type

Certificate

Remarks

The adapter uses this certificate to sign MIME data when S/MIME encoding. This property is also used to decrypt S/MIME entities in the Decoder, and it should be set to the certificate that holds the private key that is paired with the public key that was used to encrypt the data.

ConnectionLifetime Property (SMIMEEmail Adapter)

Instructs the component whether or not to leave the connection to the server open.

Data Type

Enumeration

Possible Values

Automatic (0)
Per Batch (1)
Persisted (2)

Default Value

0

Remarks

This property is used when uploading batches of messages to a server that use the same connection properties. In order to minimize connection-related protocol overhead, connections may be persisted with various lifetimes:

This property is not available in the Receiver.

DeleteMode Property (SMIMEEmail Adapter)

Controls if and when the email is deleted after download.

Data Type

Enumeration

Possible Values

Never (0)
On Success (1)
On Failure (2)
Always (3)

Default Value

0

Remarks

This property informs the adapter as to whether or not it should delete a remote files from the server after a successful download. The possible values and their meanings are as follows:

Note: the default value is Never for data protection purposes. Unless modified this will result in the adapter continuously receiving the same data.

This property is not available in the Sender.

DeliveryReceipt Property (SMIMEEmail Adapter)

Whether or not a delivery receipt should be returned to the sender.

Data Type

Boolean

Default Value

false

Remarks

When set to True, a Return-Receipt-To header is added to the message. If the email recipient so chooses, a delivery receipt will be sent to the email address in the From property.

This property is not available in the Receiver.

EncryptData Property (SMIMEEmail Adapter)

Whether to encrypt the MIME data.

Data Type

Boolean

Default Value

true

Remarks

If false, the data will be encoded but not encrypted. The default is true.

This property is not available in the Receiver.

EncryptingAlgorithm Property (SMIMEEmail Adapter)

The algorithm to use for encryption.

Data Type

String

Default Value

"3DES"

Remarks

This property contains either the name of the algorithm (such as "RC2", "3DES", "DES", or "AES"), or an object identifier (OID) string representing the algorithm.

In the case of "RC2" ("RC2CBC") the key bit length is specified after the name. The following algorithm names are supported for RC2: "RC2CBC40", "RC2CBC64", and "RC2CBC128", with the default being 128 bit ("RC2CBC128").

In the case of "AES" ("AESCBC") the key bit length is specified after the name. The following algorithm names are supported for AES: "AESCBC128", "AESCBC192", and "AESCBC256", with the default being 128 bit ("AESCBC128").

When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.

This property is not available in the Receiver.

ErrorThreshold Property (SMIMEEmail Adapter)

The maximum number of errors before the component shuts down.

Data Type

Integer

Default Value

5

Remarks

This property limits the number of errors that the adapter can incur before it shuts down and stops processing messages.

If set to 0 the adapter will never shutdown.

Note that if the operation completes successfully the current error count will be reset.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

Filter Property (SMIMEEmail Adapter)

A filter to be applied to the inbox when selecting messages.

Data Type

String

Default Value

""

Remarks

If this value is set, the adapter will use it to filter out which messages to download from the server. The adapter will apply the filter as a search string, and then download all messages in the message set returned by the server.

Note: this property is only valid for the stIMAP ServerType.

The exact format of the filter criteria is specified by the IMAP RFCs. The string consists of one or more search keys and their corresponding values (if any) separated by spaces, for example: "SINCE 1-Feb-1994 NOT FROM Smith".

Possible search keys include:

This property is not available in the Sender.

Firewall Property (SMIMEEmail Adapter)

A set of properties related to firewall access.

Data Type

Firewall

Remarks

This is a Firewall type property which contains fields describing the firewall through which the adapter will attempt to connect.

From Property (SMIMEEmail Adapter)

The email address of the sender (required).

Data Type

String

Default Value

""

Remarks

The From property is used to create a From SMTP header. This header identifies the sender of the message. A valid email address is required. Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com

This property is not available in the Receiver.

IncludeCertificate Property (SMIMEEmail Adapter)

Specifies whether to include the signer's certificate with the signed message.

Data Type

Boolean

Default Value

true

Remarks

If true, the certificate used to sign the message will be encoded and included in the message signature.

Including a certificate is the preferred method of building signed messages. If you do not include a certificate, the message recipient may not be able to verify the sender's signature.

This property is not available in the Receiver.

IncludeChain Property (SMIMEEmail Adapter)

Specifies whether to include the signer's certificate chain with the signed message.

Data Type

Boolean

Default Value

false

Remarks

If this property is set to True, the entire certificate's chain that was used to sign the message will be encoded and included in the message signature.

NOTE: To include the chain, the IncludeCertificate property must also be set to true.

This property is not available in the Receiver.

IncludeHeaders Property (SMIMEEmail Adapter)

Instructs the component to include or ignore message headers.

Data Type

Boolean

Default Value

false

Remarks

If IncludeHeaders is set to True, the adapter will include any headers retrieved from the server in the message. This is useful for PassThrough configurations and for orchestrations that use MIME decoding message pipelines.

Note: regardless of the value of this property, there will be a "MessageHeaders" message context property that contains a string with the full RFC-822 encoded original headers as retrieved from the server. This is useful for situations where it is necessary to find specific mail headers.

This property is not available in the Sender.

MailFolder Property (SMIMEEmail Adapter)

Name of the mailbox selected on the server.

Data Type

String

Default Value

"Inbox"

Remarks

This property tells the adapter which mailbox folder to check for messages when logging into an IMAP email account.

Note: this property is only valid when ServerType is set to IMAP.

This property is not available in the Sender.

MailPort Property (SMIMEEmail Adapter)

The port of the mail server (IMAP or POP3).

Data Type

Integer

Default Value

0

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is established by the adapter

For IMAP, the default ports are 143 for a plaintext connection and 993 for an implicit SSL connection. For POP3, the default ports are 110 and 995 respectively.

This property is not available in the Sender.

MailServer Property (SMIMEEmail Adapter)

The name or address of the mail server (IMAP or POP3).

Data Type

String

Default Value

""

Remarks

The MailServer property specifies the IP address (IP number in dotted internet format) or Domain Name of the mail server.

This property is not available in the Sender.

MaxBatchSize Property (SMIMEEmail Adapter)

The maximum size, in MB, of the current batch (0 indicates no limit).

Data Type

Integer

Default Value

0

Remarks

This property limits the maximum amount of data the adapter can store before finalizing and processing the current batch to the number of bytes indicated.

Note: the default value, "0" indicates that there is no limit on the size of the batch. This value is not recommended for production environments as it may result in extremely large batches being held in memory before the adapter moves the data to the next stage of processing.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

MaxFileCount Property (SMIMEEmail Adapter)

The maximum number of files in the current batch (0 indicates no limit).

Data Type

Integer

Default Value

10

Remarks

This property places a limit on the number of files that can be transmitted in a single batch.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

MaxFileSize Property (SMIMEEmail Adapter)

The maximum size, in MB, of a file in the current batch (0 indicates no limit).

Data Type

Integer

Default Value

0

Remarks

This property limits the maximum size of any file in the current transmission batch to the number of bytes indicated.

Note: the default value, "0" indicates that there is no limit on the size of the batch. This value is not recommended for production environments as it may result in extremely large batches being held in memory before the adapter moves the data to the next stage of processing.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

MaxPersistentConnections Property (SMIMEEmail Adapter)

The maximum number of simultaneous persistent connections when sending.

Data Type

Integer

Default Value

1

Remarks

This setting specifies the maximum number of simultaneous persistent connections when sending.

The default value is 1, which limits the adapter to using one persistent connection for the adapter at any one time. This means when ConnectionLifetime is set to Persisted the send adapter will first check to see if an existing connection is present before transmitting data. In the case where a connection exists but another instance of the send port is using the connection the adapter will wait for the connection to become free. A value of 1 effectively serializes all communication for the send port through one persistent connection.

By setting a value greater than 1 a pool of persistent connections can be created. This allows multiple simultaneous persistent connections to be used. When the send adapter is active it will check to see if there are any existing connections. In the case where a connection exists but is being used by another instance of the send port it will attempt to create a new persistent connection. If creating a new persistent connection would exceed the limit specified in this setting the adapter will instead wait for a connection to become free. Setting this to a value greater than 1 allows multiple simultaneous connections to be made while still taking advantage of persistent connections to reduce the overhead of re-connecting.

Note: This only applies to the send adapter.

The default value is 1.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

MaxThreads Property (SMIMEEmail Adapter)

The maximum number of threads that the component may consume.

Data Type

Integer

Default Value

20

Remarks

This property limits the number of concurrent threads that the adapter may consume while completing its work.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

MaxTransmissionBatchSize Property (SMIMEEmail Adapter)

The maximum number of messages that can be sent in a single batch.

Data Type

Integer

Default Value

1

Remarks

This property controls the maximum size of an outbound message batch.

Note: be careful when modifying this property as it directly effects the efficiency of the transmit adapter. Setting MaxTransmissionBatchSize to a low value in an environment that requires transmission of large quantities of data will result in the adapter accumulating several small batches. If TransmitBatchMode is set to Parallel, this will result in the adapter transmitting many small batches at once and can put a heavy load on the processor.

Conversely, if TransmitBatchMode is set to Serial, setting MaxTransmissionBatchSize to a large value may result in long transmission delays as the adapter will wait on existing work to complete before accepting new messages from the BizTalk Message Engine. This is especially true when the adapter is transmitting large data.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

MessageCc Property (SMIMEEmail Adapter)

A comma separated list of addresses for carbon copies.

Data Type

String

Default Value

""

Remarks

The MessageCc property will contain the list of address for carbon copies of the message returned by the server.

This property is not available in the Sender.

MessageDate Property (SMIMEEmail Adapter)

The date a message was sent.

Data Type

String

Default Value

""

Remarks

The MessageDate property will contain the date/time stamp of when the message returned by the server was sent.

This property is not available in the Sender.

MessageFrom Property (SMIMEEmail Adapter)

The email address of the author of the message.

Data Type

String

Default Value

""

Remarks

MessageFrom normally has the same value as MessageSender.

There are cases when a message may have more than one From address. If this is the case, the addresses are provided in the MessageFrom property separated by commas.

This property is not available in the Sender.

MessageHeaders Property (SMIMEEmail Adapter)

Message headers associated with the current email message.

Data Type

String

Default Value

""

Remarks

In the Send Adapter, this property applies to outgoing messages. Normally, the Email adapter will generate a set of headers to be transferred to the server along with the current mail message. However, this set of headers can be modified at runtime by writing to the MessageHeaders context property of the current BizTalk message. Several headers may be supplied as one string, with each header value terminated by a carriage return and new line ("\r\n", or VBCrLf) in accordance with RFC 822 format, but need not be folded.

Note: If any headers are supplied that would normally be generated by the adapter, the adapter will use the values specified.

In the Receive Adapter, this property will contain the headers of the message that was retrieved from the server.

MessageHTML Property (SMIMEEmail Adapter)

The HTML text of the message.

Data Type

String

Default Value

""

Remarks

The MessageHTML property contains the HTML version of the message. When this property is set, the adapter will send the email as an HTML encoded message.

This property is not available in the Receiver.

MessageId Property (SMIMEEmail Adapter)

The id of the current message.

Data Type

String

Default Value

""

Remarks

MessageId contains the Id of the message that was retrieved from the server.

This property is not available in the Sender.

MessageNetId Property (SMIMEEmail Adapter)

The globally unique identifier of the message.

Data Type

String

Default Value

""

Remarks

The adapter fills the MessageNetId with the value of the Message-Id: header. This is a globally unique value normally created by the first mail server the message is sent to.

This property is not available in the Sender.

MessageSender Property (SMIMEEmail Adapter)

The email address of the sender.

Data Type

String

Default Value

""

Remarks

This property will contain the email address of the sender of the message that was retrieved from the server.

This property is not available in the Sender.

MessageSize Property (SMIMEEmail Adapter)

The size of the current message.

Data Type

Integer

Default Value

0

Remarks

This property specifies the size of the message that was retrieved from the server.

This property is not available in the Sender.

MessageSubject Property (SMIMEEmail Adapter)

The subject of the mail message.

Data Type

String

Default Value

""

Remarks

This property will contain the subject of the message that was retrieved from the server.

This property is not available in the Sender.

MessageText Property (SMIMEEmail Adapter)

The text of the mail message (optional).

Data Type

String

Default Value

""

Remarks

The string in MessageText is sent as the text of the message.

This property is not available in the Receiver.

MessageTo Property (SMIMEEmail Adapter)

A comma separated list of addresses for destinations.

Data Type

String

Default Value

""

Remarks

MessageTo will contain a comma separated list of addresses for destinations that was retrieved from the server for the current message.

This property is not available in the Sender.

OAuthAuthorization Property (SMIMEEmail Adapter)

OAuth Authorization Information.

Data Type

OAuthAuthorizationParam

Remarks

This property holds details about the OAuth authorization. This includes the following fields:

• AuthorizationScopes
• AuthorizationString
• CacheLocation
• CallbackURL
• ClientId
• ClientSecret
• ExpiresIn
• RefreshToken
• ServerAuthURL
• ServerTokenURL
• ServiceProvider
• TimeStamp

Other Property (SMIMEEmail Adapter)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

""

Remarks

The adapter accepts one or more 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.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

Password Property (SMIMEEmail Adapter)

A password for login.

Data Type

Password

Default Value

""

Remarks

If the Password property is set to a non-empty string, then when connecting to the mail server an AUTH or CRAM-MD5 (depending on the value of AuthMode) command is sent in order to provide authentication information for the user.

PersistentConnection Property (SMIMEEmail Adapter)

Instructs the component whether to keep the connection to the server open.

Data Type

Boolean

Default Value

false

Remarks

If set to true, the adapter will first attempt to use an existing connection. If no such connection exists, it will create a new connection. When the adapter completes, it will persist the connection so that the adapter will reuse it during the next polling interval. Setting this property to true can improve performance if you are polling very frequently.

PollingInterval Property (SMIMEEmail Adapter)

The amount of time, in seconds, between download attempts.

Data Type

Integer

Default Value

60

Remarks

The adapter will wait for the number of seconds indicated before attempting another download.

This property is not available in the Sender.

ReadReceipt Property (SMIMEEmail Adapter)

Whether or not a receipt should be sent when the email has been read.

Data Type

Boolean

Default Value

false

Remarks

When set, a Disposition-Notification-To header is added to the message. If the email recipient so chooses, a receipt will be sent to the email address in the From property.

This property is not available in the Receiver.

RecipientCert Property (SMIMEEmail Adapter)

The certificate used to encrypt the MIME data.

Data Type

Certificate

Remarks

The adapter uses the recipient's certificate to encrypt the MIME data so that it can be decrypted once it reaches the recipient. This property should be set to the appropriate certificate for encryption.

This property is not available in the Receiver.

ReplyTo Property (SMIMEEmail Adapter)

A mail address to reply to (optional).

Data Type

String

Default Value

""

Remarks

If the ReplyTo property contains a non-empty string, a Reply-To SMTP header is created for the message. This header shows the address to use for replies (useful if this address is different from the one in From).

This property is not available in the Receiver.

RequeueEndpoints Property (SMIMEEmail Adapter)

Whether to requeue receive endpoints if the polling interval has not been reached.

Data Type

Boolean

Default Value

false

Remarks

This setting controls whether receive endpoints are requeued for later processing if the polling interval has not yet been reached. When this setting is set to No (default) each thread will block until the polling interval for the corresponding receive location is reached. If there exist more active receive locations than MaxThreads it is possible for some threads to block the execution of others since they may be waiting for a polling interval.

When this setting is set to Yes if the polling interval has not been reached the thread will not block until the polling interval is reached, and instead the endpoint will be requeued to be processed later. This lets subsequent endpoints in the queue to be processed.

If MaxThreads is set to a low value and there are a larger number of receive locations setting this to Yes will help assure that polling intervals are respected and receive locations poll in a timely manner.

The default value is No.

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Sender.

RequireEncryption Property (SMIMEEmail Adapter)

Whether an error should be thrown if a received message is not encrypted.

Data Type

Boolean

Default Value

false

Remarks

By default, if the adapter receives a message that is not encrypted it will skip the decryption step and continue processing the message. If RequireEncryption is set to true, an error will be thrown if a received message is not encrypted.

This property is not available in the Sender.

RequireOAEP Property (SMIMEEmail Adapter)

Whether an error should be thrown if OAEP was not used to encrypt the incoming message.

Data Type

Boolean

Default Value

false

Remarks

By default, the adapter will silently support decrypting messages regardless of whether they were encrypted with Optimal Asymmetric Encryption Padding (OAEP). If OAEP should be required, and thus an error should be thrown if OAEP is not detected, set this property to true.

This property is not available in the Sender.

RequirePSS Property (SMIMEEmail Adapter)

Whether an error should be thrown if RSA-PSS was not used to encrypt the incoming message.

Data Type

Boolean

Default Value

false

Remarks

By default, the adapter will silently support decrypting and verifying messages regardless of whether they were signed with RSA Probabilistic Signature Scheme (RSA-PSS). If RSA-PSS should be required, and thus an error should be thrown if RSA-PSS is not detected, set this property to true.

This property is not available in the Sender.

RequireSignature Property (SMIMEEmail Adapter)

Whether an error should be thrown if a received message is not signed.

Data Type

Boolean

Default Value

false

Remarks

By default, if the adapter receives an unsigned message it will skip the signature verification step and continue processing the message. If RequireSignature is set to true, an error will be thrown if the received message is not signed.

This property is not available in the Sender.

RolloverCertificate Property (SMIMEEmail Adapter)

The rollover decryption certificate.

Data Type

Certificate

Remarks

The rollover digital certificate that the adapter will use to decrypt incoming messages. This may be used to specify an additional decryption certificate during a period of transition between private certificates. When specified, the adapter will be able to decrypt messages that were encrypted with the corresponding public certificate of either Certificate or RolloverCertificate.

RolloverCertificate must be set to a private key certificate.

This property is not available in the Sender.

RuntimeLicense Property (SMIMEEmail Adapter)

Specifies the component runtime license key.

Data Type

String

Default Value

""

Remarks

You can use the RuntimeLicense property to set the runtime key for the adapter license.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

SendTo Property (SMIMEEmail Adapter)

A comma separated list of addresses for destinations (required).

Data Type

String

Default Value

""

Remarks

The SendTo property specifies a comma separated list of destinations for the mail message. A copy of the message is sent to each of them, and a To SMTP header is created containing the destination addresses.

Examples of valid addresses are: "Friendly Name" <address@company.com> or address@company.com

The adapter will stop processing the message and log an error if the SMTPServer returns an error code about any email address specified in SendTo or Cc, but it will only log warnings if the same happens with an email address specified in BCc.

This property is not available in the Receiver.

ServerType Property (SMIMEEmail Adapter)

The type of server for your email account.

Data Type

Enumeration

Possible Values

IMAP (0)
POP3 (1)

Default Value

0

Remarks

This represents the type of server from which the adapter will download emails.

This property is not available in the Sender.

SignData Property (SMIMEEmail Adapter)

Whether to sign the MIME data.

Data Type

Boolean

Default Value

false

Remarks

If true, the certificate held in the Certificate property will be used to sign the message.

This property is not available in the Receiver.

SignerCert Property (SMIMEEmail Adapter)

Contains the certificate of the message signer.

Data Type

Certificate

Remarks

This certificate is used to verify the signature on the incoming message. Setting this property is only necessary if the message does not have the signer's certificate attached to it.

This property is not available in the Sender.

SigningAlgorithm Property (SMIMEEmail Adapter)

Textual description of the signature hash algorithm.

Data Type

String

Default Value

"SHA256"

Remarks

This property specifies the hash algorithm used to prepare the message digest for signature.

This property must contain either the name of the algorithm (such as "MD5" or "SHA1"), or an object id (OID) string representing the hash algorithm. Possible values are:

• sha1
• md5
• sha-256 (default)
• sha-384
• sha-512
• sha-224

When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.

This property is not available in the Receiver.

SMTPMessageId Property (SMIMEEmail Adapter)

The id of the mail message (optional).

Data Type

String

Default Value

""

Remarks

This property is used to specify the value of the SMTP MessageId header in the outgoing message. When this property is not set, the adapter will automatically calculate the MessageId. It is recommended that this property be left blank to allow the adapter to automatically create the MessageId value unless there is a specific need to define this value.

This property is not available in the Receiver.

SMTPPort Property (SMIMEEmail Adapter)

The server port for SMTP (default 25).

Data Type

Integer

Default Value

25

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is established by the adapter

For implicit SSL, use port 465 (please refer to the SSLStartMode property for more information).

This property is not available in the Receiver.

SMTPServer Property (SMIMEEmail Adapter)

The name or address of a mail server (mail relay).

Data Type

String

Default Value

""

Remarks

The SMTPServer property specifies the IP address (IP number in dotted internet format) or Domain Name for a mail relay through which messages will be routed.

The current version of the adapter does not provide a default value for the mail relay. You must provide a host name yourself. Generally, any internet host with an SMTP server will suffice (a UNIX host for example), but it is preferable to select an SMTPServer that is close to the machine sending mail.

This property is not available in the Receiver.

SSLAcceptServerCert Property (SMIMEEmail Adapter)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Data Type

Certificate

Remarks

If it finds any issues with the certificate presented by the server, the adapter will normally terminate the connection with an error. You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the adapter will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file. If you click on the ellipses, a certificate selection dialog will open. To select a public key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of available certificates will be shown below.

Alternatively, you may specify a public key on file. Select the PEM or Certificate File tabs to load a public key from file. You can use the browse button to examine the file system for the certificate that you wish to use. Public keys typically are stored in .CER, .DER, or .PEM files, but other formats may be used. You can click on the Open button to examine the contents of the certificate. Or, if you have a certificate stored in memory, you can write the contents of the certificate into the text box provided. Note that if you are loading a certificate from memory, the certificate must be Base-64 encoded, or the string representation of the certificate may become corrupted and uninterpretable.

Regardless of how you selected the certificate, once you hit the OK button, the adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the adapter to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes. Set the LogMode to Info to cause the adapter to report the server's credentials to Location.

SSLCert Property (SMIMEEmail Adapter)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format. If you click on the ellipses, a certificate selection dialog will open. To select a private key from the system registry, select the System Store tab or the User Store tab, and highlight the appropriate registry store. The list of certificates which have private keys will be shown below.

To select a private key certificate from a file in PKCS#12 format, select the PFX Store tab. The browse button can be used to examine the file system for PKCS#12 (.pfx or .p12) certificates. If you wish to examine the certificate, provide the password in the field provided and click on the Open button to examine the file store for certificates present. To load a certificate from PEM files, select the PEM tab. Like the PFX file selection, you can specify the password and click the Open button to examine the certificates in the PEM store, or you may paste any PEM data stored in memory.

Regardless of how you selected the certificate, once you hit the OK button, the adapter will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the adapter was not able to verify the selection, a dialog box will appear instead detailing the verification error.

SSLStartMode Property (SMIMEEmail Adapter)

Determines how the component starts the SSL negotiation.

Data Type

Enumeration

Possible Values

Automatic (0)
Implicit (1)
Explicit (2)
None (3)

Default Value

0

Remarks

The SSLStartMode property may have one of the following values:

Subject Property (SMIMEEmail Adapter)

The subject of the mail message (optional).

Data Type

String

Default Value

""

Remarks

The string in Subject is sent with a Subject SMTP header to the mail recipient.

This property is not available in the Receiver.

TempPath Property (SMIMEEmail Adapter)

The path to which temporary files are written at runtime.

Data Type

String

Default Value

""

Remarks

If you are planning on working with binary files or large files, it is recommended that you set a valid path for this property. When set to a valid path this property tells the adapter to use temp files when performing operations. If this is not set, all operations are done in memory and require that all input and output is in ASCII.

This property accepts the "%TEMP%" macro, which will be replaced with the default system temporary directory at runtime.

Timeout Property (SMIMEEmail Adapter)

A timeout for the component.

Data Type

Integer

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the adapter will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the adapter fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the adapter may be changed to absolute timeouts, i.e. the adapter will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

TransmitBatchMode Property (SMIMEEmail Adapter)

How the transmitter processes batches.

Data Type

Enumeration

Possible Values

Parallel (0)
Serial (1)

Default Value

0

Remarks

This property controls how the transmitter processes message batches:

This property can only be configured through the adapter's static handler property page in the BizTalk Server administration console.

This property is not available in the Receiver.

TransportLog Property (SMIMEEmail Adapter)

Tells the component where and how to report information about its operations.

Data Type

Log

Remarks

This is a Log type property which contains fields describing how and where the adapter will record information about its execution.

This property may be configured on the adapter's static handler property page in the BizTalk Server administration console.

URI Property (SMIMEEmail Adapter)

The Uniform Resource Identifier (URI) of the send port or receive location.

Data Type

String

Default Value

""

Remarks

This property specifies a URI for the send port or receive location. Setting this property is optional.

By default the adapter will automatically generate a URI. You may choose to specify your own value here to be used in place of the generated URI.

If this value is specified it must begin with the correct prefix, as seen in the default value.

UseOAEP Property (SMIMEEmail Adapter)

Whether to use OAEP when encrypting the MIME data.

Data Type

Boolean

Default Value

false

Remarks

By default, the adapter will use PKCS1 when encrypting the message. To use Optimal Asymmetric Encryption Padding (OAEP) instead, set this property to true.

This property is not available in the Receiver.

UsePSS Property (SMIMEEmail Adapter)

Whether to use RSA-PSS when signing.

Data Type

Boolean

Default Value

false

Remarks

To use RSA Probabilistic Signature Scheme (RSA-PSS) when signing, set this property to true. Note that the certificate used to sign does not itself need to be signed with RSA-PSS; any valid RSA certificate may be used with this setting.

This property is not available in the Receiver.

User Property (SMIMEEmail Adapter)

A user id for login.

Data Type

String

Default Value

""

Remarks

If the User property is set to a non-empty string, then when connecting to the mail server an AUTH or CRAM-MD5 (depending on the value of AuthMode) command is sent in order to provide authentication information for the user.

NOTE: POP3 and IMAP servers typically require User to be set.

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Certificate();

Creates a Certificate instance whose properties can be set.

public Certificate(string certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate(byte[] certificateData);

Parses CertificateData as an X509 public key.

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the constructor will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.

Fields

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Firewall();

Log Type

A log where the component will record information about its operations.

Remarks

This describes how and where the adapter will record information describing its execution.

Fields

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public Log();

public Log(LogTypes logType, string location, LogModes logMode);

OAuthAuthorizationParam Type

This type holds details of the OAuth authorization.

Remarks

This type holds details of the OAuth authorization.

Fields

Constructors

Constructors are only relevant when configuring adapters in orchestrations.

public OAuthAuthorizationParam();

Config Settings (SMIMEEmail Adapter)

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.

SMIMEEMail Config Settings

Email Config Settings

SSL Config Settings

General Config Settings

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%.