Office365Mail Adapter

Properties   Config Settings  

The Office365Mail Component adds Outlook 365 send and receive capabilities to your BizTalk Server.

Remarks

The Office365Mail Adapter provides a simple way to send and receive emails from Microsoft Outlook 365.

Authorization

To perform OAuth authorization first open the OAuth Authorization dialog by clicking the ellipses (...) button of the OAuthAuthorization property at design time. This will open a dialog. Within the dialog specify the ClientId, ClientSecret, and CallbackURL values for the registered application.

After specifying the necessary values press the Authorize button to authorize the application. This will launch a browser and prompt the user to grant access. After access is granted the adapter will populate the following values:

• AuthorizationString
• RefreshToken
• ExpiresIn
• TimeStamp

All necessary values will be saved in the CacheLocation for use in subsequent requests by the adapter. The adapter will use the cached values and will automatically refresh the token if needed. In this way any user interaction is only required at design time, not at runtime.

Office365Mail Receive Adapter

At runtime the adapter will connect to Outlook 365 every PollingInterval and search the emails on the server. All emails that match the Filter will be downloaded and submitted to the BizTalk Message Engine as individual messages.

Office365Mail Send Adapter

The adapter will connect to Outlook 365 whenever it has a message to send. The contents of the message will be sent in the body of the email, with other fields on the email set through the Message* properties.

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.

AttachmentDirectory	Specifies the directory to which attachments are saved.
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.
MailFolder	Name of the mailbox selected on the server.
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.
MessageSender	The email address of the sender.
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.
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 component runtime license key.
Select	The parts of a message that should be retrieved.
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.
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.

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.
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.
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.
MessageBody	The body of the message.
MessageBodyContentType	The body content type for a message.
OAuthAuthorization	OAuth Authorization Information.
Other	Defines a set of configuration settings to be used by the component.
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 component runtime license key.
SendTo	A comma separated list of addresses for destinations (required).
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.
Subject	The subject of the mail message (optional).
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.

Config Settings

---

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

AddAttachmentsAsMessageParts	Includes attachments as additional parts on the message.
AttachmentName[index]	Filename for the attached file (at index).
AttachmentType[index]	Content-type for attached file (at index).
ContinueOnAttachmentError	Whether or not to continue processing messages if an attachment download fails.
DuplicateAttachmentAction	Specifies what action to take when a duplicate filename is encountered.
FolderPageSize	Determines the number of folders that will be returned from the server at a time when searching.
IncludeAttachments	Determines if additional message parts are added to the outgoing E-Mail as attachments.
MarkAsRead	Specifies whether a message will be marked as read.
MessageBodyFile	Specifies a file that will be included as the email's body content.
MessageImportance	Sets the importance of the message.
MessagePageSize	Determines the number of messages that will be returned from the server at a time when searching.
MoveTo	Specifies the folder on the server to which messages will be moved.
UserId	Sets the Id of the mailbox to connect to when accessing a shared mailbox.
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.

Office365Mail Receiver

How to Configure a Office365Mail 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 Office365Mail 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.Office365Mail 2024 from the drop-down list, and then click Configure to configure the transport properties for the receive location.
5. In the nsoftware.Office365Mail 2024 Transport Properties dialog box, you will find the following properties:

   AttachmentDirectory	Specifies the directory to which attachments are saved. Type: xs:string    Default Value: ""
   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
   MailFolder	Name of the mailbox selected on the server. Type: xs:string    Default Value: "Inbox"
   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: ""
   MessageSender	The email address of the sender. Type: xs:string    Default Value: ""
   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: ""
   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
   RuntimeLicense	Specifies the component runtime license key. Type: xs:string    Default Value: ""
   Select	The parts of a message that should be retrieved. Type: xs:string    Default Value: ""
   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.
   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: ""

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.

Office365Mail Transmitter

Setting the Office365Mail 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 Office365Mail 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 Office365Mail 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.Office365Mail 2024 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.Office365Mail 2024 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: ""
   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: ""
   DeliveryReceipt	Whether or not a delivery receipt should be returned to the sender. Type: bool    Default Value: false
   Firewall	A set of properties related to firewall access. Type: Firewall    Default Value: null
   From	The email address of the sender. Type: xs:string    Default Value: "" NOTE: This property must be specified.
   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
   MessageBody	The body of the message. Type: xs:string    Default Value: ""
   MessageBodyContentType	The body content type for a message. Type: xs:string    Default Value: "text"
   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: ""
   ReadReceipt	Whether or not a receipt should be sent when the email has been read. Type: bool    Default Value: false
   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.
   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.
   Subject	The subject of the mail message (optional). 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: ""

4. Click OK and OK again to save settings.

AttachmentDirectory Property (Office365Mail 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. 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 (Office365Mail 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.

BCc Property (Office365Mail 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 individual recipients never see the list of the other recipients.

This property is not available in the Receiver.

Cc Property (Office365Mail 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 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).

This property is not available in the Receiver.

DeleteMode Property (Office365Mail 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 (Office365Mail 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 delivery receipt will be requested. 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.

ErrorThreshold Property (Office365Mail 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 (Office365Mail 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.

Filter follows the OData protocol syntax.

Example (List Unread Messages in a Folder)

isRead eq false

Example (List Messages from a Specific Address)

address eq 'specific@address.com'

Example (List Unread Messages from a Specific Address)

isRead eq false and address eq 'specific@address.com'

This property is not available in the Sender.

Firewall Property (Office365Mail 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 (Office365Mail Adapter)

The email address of the sender.

Data Type

String

Default Value

""

Remarks

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

This property is not available in the Receiver.

MailFolder Property (Office365Mail 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.

This property is not available in the Sender.

MaxThreads Property (Office365Mail 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 (Office365Mail 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.

MessageBody Property (Office365Mail Adapter)

The body of the message.

Data Type

String

Default Value

""

Remarks

This property contains the body of the email message. This can be either plaintext or HTML, as determined by the $rpMessageBodyContentType.

This property is not available in the Receiver.

MessageBodyContentType Property (Office365Mail Adapter)

The body content type for a message.

Data Type

String

Default Value

"text"

Remarks

This property contains the content type of a message. Valid values include text or html.

This property is not available in the Receiver.

MessageCc Property (Office365Mail 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 (Office365Mail 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 (Office365Mail 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 (Office365Mail Adapter)

Message headers associated with the current email message.

Data Type

String

Default Value

""

Remarks

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

This property is not available in the Sender.

MessageId Property (Office365Mail 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.

MessageSender Property (Office365Mail 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.

MessageSubject Property (Office365Mail 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.

MessageTo Property (Office365Mail 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 (Office365Mail 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 (Office365Mail 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

PollingInterval Property (Office365Mail 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 (Office365Mail 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 read receipt will be requested. 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.

ReplyTo Property (Office365Mail 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 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 (Office365Mail 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.

RuntimeLicense Property (Office365Mail 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.

Select Property (Office365Mail Adapter)

The parts of a message that should be retrieved.

Data Type

String

Default Value

""

Remarks

This property can be used to select specific message properties to retrieve. Specify the message properties to be selected as a comma separated list.

If this property is an empty string all message properties except for MessageHeaders will be selected. To select all message properties supported by the adapter (including MessageHeaders), use the following value:

body,ccRecipients,sentDateTime,from,sender,subject,toRecipients,internetMessageHeaders,importance,isDeliveryReceiptRequested,isReadReceiptRequested,hasAttachments

This property is not available in the Sender.

SendTo Property (Office365Mail 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 header is created containing the destination addresses.

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

This property is not available in the Receiver.

SSLAcceptServerCert Property (Office365Mail 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 (Office365Mail 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.

Subject Property (Office365Mail Adapter)

The subject of the mail message (optional).

Data Type

String

Default Value

""

Remarks

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

This property is not available in the Receiver.

Timeout Property (Office365Mail 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 (Office365Mail 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 (Office365Mail 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 (Office365Mail 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.

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();

public Certificate(string certificateFile);

public Certificate(byte[] certificateData);

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

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

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

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

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 (Office365Mail 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.

Office365Mail Config Settings

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