Office365Mail Task

Properties   Config Settings  

The Office365Mail Component adds Outlook 365 send and receive capabilities to your SSIS Package.

Remarks

The Office365Mail Task 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 task 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 task. The task 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 Task

At runtime the task will connect to Outlook 365 and search the emails on the server. All emails that match the Filter will be downloaded and submitted to the SSIS Package as individual messages.

Office365Mail Send Task

The task 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.

Receiver Property List

---

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

AttachmentDirectory	Specifies the directory to which attachments are saved.
Delete	Controls if the email is deleted after download.
Filter	A filter to be applied to the inbox when selecting messages.
Firewall	A set of properties related to firewall access.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
MailFolder	Name of the mailbox selected on the server.
OAuthAuthorization	OAuth Authorization Information.
Other	Defines a set of configuration settings to be used by the component.
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.
SSLAcceptServerCertAcceptAny	Tells the component to accept any server certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
Timeout	A timeout for the component.

Sender Property List

---

The following is the full list of the properties of the sender task 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.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
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.
SSLAcceptServerCertAcceptAny	Tells the component to accept any server 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.

Config Settings

---

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

AttachmentName[index]	Filename for the 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.
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.

AttachmentDirectory Property (Office365Mail Task)

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 Task)

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 Task)

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 Task)

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.

Delete Property (Office365Mail Task)

Controls if the email is deleted after download.

Data Type

Boolean

Default Value

false

Remarks

If this property is set to True, each email is deleted from the server after download.

This property is not available in the Sender.

DeliveryReceipt Property (Office365Mail Task)

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.

Filter Property (Office365Mail Task)

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

Data Type

String

Default Value

""

Remarks

If this value is set, the task will use it to filter out which messages to download from the server. The task 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 Task)

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 task will attempt to connect.

From Property (Office365Mail Task)

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.

LogFile Property (Office365Mail Task)

The file to write logging information to at runtime.

Data Type

String

Default Value

""

Remarks

To write logging information to a file instead of using the task's logging API, set this property to a valid file on disk.

When set, any logging information is appended to the specified file and not written to the task's logging API.

LogMode Property (Office365Mail Task)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)

Default Value

3

Remarks

This property controls what information the task logs. The possible values have the following affect on the task's behavior:

MailFolder Property (Office365Mail Task)

Name of the mailbox selected on the server.

Data Type

String

Default Value

"Inbox"

Remarks

This property tells the task which mailbox folder to check for messages.

This property is not available in the Sender.

MessageBody Property (Office365Mail Task)

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 Task)

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.

OAuthAuthorization Property (Office365Mail Task)

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 Task)

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

Data Type

String

Default Value

""

Remarks

The task 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 task, 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

ReadReceipt Property (Office365Mail Task)

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 Task)

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.

RuntimeLicense Property (Office365Mail Task)

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 task license.

Select Property (Office365Mail Task)

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 task (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 Task)

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 Task)

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 task 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 task 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 task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Note: You may also set SSLAcceptServerCertAcceptAny to True without opening the certificate selection dialog to force the task to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLAcceptServerCertAcceptAny Property (Office365Mail Task)

Tells the component to accept any server certificate.

Data Type

Boolean

Default Value

false

Remarks

When set to true, the task will unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes.

SSLCert Property (Office365Mail Task)

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 task will attempt to verify that certificate selection. If successful, the subject of the certificate will be displayed in the property field. If the task was not able to verify the selection, a dialog box will appear instead detailing the verification error.

Subject Property (Office365Mail Task)

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 Task)

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 task will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the task 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 task may be changed to absolute timeouts, i.e. the task 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).

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

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

OAuthAuthorizationParam Type

This type holds details of the OAuth authorization.

Remarks

This type holds details of the OAuth authorization.

Fields

Config Settings (Office365Mail Task)

The task 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 task, access to these internal properties is provided through the Other property.

Office365Mail Config Settings

SSL Config Settings