Email Connector

The Email Component adds SSL-protected email capability to the MuleSoft.

Remarks

The Email Connector provides an all-encompassing email client implementation to your Mule Project. The connector supports both send and receive functionality over multiple protocols.

Email Receive Connector

The Email Receive Connector implements the IMAP and POP3 internet mail protocols. In order to use the Email Receiver connector, you must first select a ServerType. You must also enter a MailServer and User. For servers that require authentication, you will also have to enter a Password.

To activate SSL, you must also select an SSLCert, and set the SSLAcceptServerCert and SSLStartMode. The connector 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 connector 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 connector 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.

Receive Example

Drag and drop the Email Receive Connector into the source position of a flow. All that is necessary to get started is to configure the connection settings. You can control which messages are downloaded using DeleteMode and Filter.

The connector will handle connecting to the server and downloading a group of emails. One Mule event is generated for each downloaded email. Behind the Email Receive connector additional properties about each message are available in the attributes collection.

Email Send Connector

The Email Send Connector is a complete SMTP client. To send emails from the connector 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.

Send Example

To get started, simply drag the Email Send Connector into your application. All that is necessary to get started is to configure the connection settings. Set the MessageHTML or MessageText property to a string value containing the message to send. That is all that is required to send an email.

Receiver Property List

The following is the full list of the properties of the receiver Connector 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 .
DeleteMode	Controls if and when 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.
IncludeHeaders	Instructs the component to include or ignore message headers.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
LogType	How information gets logged during component execution.
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).
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.
RuntimeLicense	Specifies the component runtime license key.
ServerType	The type of server for your email account.
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.
Timeout	A timeout for the component.
User	A user id for login.

Sender Property List

The following is the full list of the properties of the sender Connector 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).
DeliveryReceipt	Whether or not a delivery receipt should be returned to the sender.
Firewall	A set of properties related to firewall access.
From	The email address of the sender (required).
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
LogType	How information gets logged during component execution.
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.
PersistentConnection	Instructs the component whether to keep the connection to the server open.
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).
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).
Timeout	A timeout for the component.
User	A user id for login.

Config Settings

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


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.
AutoDecodeHeaders	Whether to decode headers.
AutoDecodeMessageText	Whether to decode non-MIME message text.
DuplicateAttachmentAction	Specifies what action to take when a duplicate filename is encountered.
FoldHeaders	Whether incoming message headers should be folded.
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.
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.

AttachmentDirectory Property (Email Connector)

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 (Email Connector)

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 (Email Connector)

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

Data Type

Enumeration

Possible Values

Default Value

Remarks

The following authentication modes are supported by the Email connector:


Login	The User and Password are sent in a basic authentication command.
CRAMMD5	The User and Password are digested using MD5 and sent to the server in a secure authentication command.
NTLM	Windows NTLM authentication. If User and Password are not supplied, the credentials for the current Windows account are used.
APOP	POP authentication. This value is only valid for the Email receiver connector when ServerType is set to POP3.
SASL Plain	The User and Password are concatenated into a plaintext SASL authentication command. This value is only valid for the Email receiver connector when ServerType is set to IMAP.
XOAUTH2	OAuth authentication. Use OAuthAuthorization to acquire and set an access token.

The default AuthMode is Login.

BCc Property (Email Connector)

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 connector 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 (Email Connector)

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

This property is not available in the Receiver.

DeleteMode Property (Email Connector)

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

Remarks

This property informs the connector 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:


Never	The remote file is never deleted.
OnSuccess	The remote file is deleted after a successful download.
OnFailure	The remote file is deleted if the transfer fails.
Always	The remote file is deleted regardless of success or failure of the transfer.

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

This property is not available in the Sender.

DeliveryReceipt Property (Email Connector)

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.

Filter Property (Email Connector)

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

Data Type

String

Default Value

Remarks

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


<message set>	Messages with message sequence numbers corresponding to the specified message sequence number set
ALL	All messages in the mailbox - this is the default initial key for AND-ing.
ANSWERED	Messages with the \Answered flag set.
BCC <string>	Messages that contain the specified string in the envelope structure's BCC field.
BEFORE <date>	Messages whose internal date is earlier than the specified date.
BODY <string>	Messages that contain the specified string in the body of the message.
CC <string>	Messages that contain the specified string in the envelope structure's CC field.
DELETED	Messages with the \Deleted flag set.
DRAFT	Messages with the \Draft flag set.
FLAGGED	Messages with the \Flagged flag set.
FROM <string>	Messages that contain the specified string in the envelope structure's FROM field.
HEADER <field-name> <string>	Messages that have a header with the specified field-name (as defined in [RFC-822]) and that contains the specified string in the [RFC-822] field-body.
KEYWORD <flag>	Messages with the specified keyword set.
LARGER <n>	Messages with an RFC822.SIZE larger than the specified number of octets.
NEW	Messages that have the \Recent flag set but not the \Seen flag. This is functionally equivalent to "(RECENT UNSEEN)".
NOT <search-key>	Messages that do not match the specified search key.
OLD	Messages that do not have the \Recent flag set. This is functionally equivalent to "NOT RECENT" (as opposed to "NOT NEW").
ON <date>	Messages whose internal date is within the specified date.
OR <search-key1> <search-key2>	Messages that match either search key.
RECENT	Messages that have the \Recent flag set.
SEEN	Messages that have the \Seen flag set.
SENTBEFORE <date>	Messages whose [RFC-822] Date: header is earlier than the specified date.
SENTON <date>	Messages whose [RFC-822] Date: header is within the specified date.
SENTSINCE <date>	Messages whose [RFC-822] Date: header is within or later than the specified date.
SINCE <date>	Messages whose internal date is within or later than the specified date.
SMALLER <n>	Messages with an RFC822.SIZE smaller than the specified number of octets.
SUBJECT <string>	Messages that contain the specified string in the envelope structure's SUBJECT field.
TEXT <string>	Messages that contain the specified string in the header or body of the message.
TO <string>	Messages that contain the specified string in the envelope structure's TO field.
UID <message set>	Messages with unique identifiers corresponding to the specified unique identifier set.
UNANSWERED	Messages that do not have the \Answered flag set.
UNDELETED	Messages that do not have the \Deleted flag set.
UNDRAFT	Messages that do not have the \Draft flag set.
UNFLAGGED	Messages that do not have the \Flagged flag set.
UNKEYWORD <flag>	Messages that do not have the specified keyword set.
UNSEEN	Messages that do not have the \Seen flag set.

This property is not available in the Sender.

Firewall Property (Email Connector)

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

From Property (Email Connector)

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.

IncludeHeaders Property (Email Connector)

Instructs the component to include or ignore message headers.

Data Type

Boolean

Default Value

false

Remarks

If IncludeHeaders is set to True, the connector 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.

LogFile Property (Email Connector)

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 connector's logging API, set this property to a valid file on disk and set the LogType property to "File".

LogMode Property (Email Connector)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

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

Default Value

Remarks

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


Verbose	The connector will report all information regarding the transport.
Info	The connector will report all major operations, as well as all warnings and errors.
Warning	The connector will report any conditions that could result in unpredictable behavior as well as errors.
Error	The connector will report all errors that prevent normal operations from completing.
Fatal	The connector will report only serious errors that cause the connector to completely stop functioning.

LogType Property (Email Connector)

How information gets logged during component execution.

Data Type

Enumeration

Possible Values

None (0)
Console (1)
File (2)

Default Value

Remarks

This property controls where the connector will log the information. The possible values have the following affect on the connector's behavior:


None	The connector will not report any logging information.
Console	The connector will report all logging information to the console.
File	The connector will report all logging information to a file. The desired file must be specified in the LogFile when this type has been selected.

MailFolder Property (Email Connector)

Name of the mailbox selected on the server.

Data Type

String

Default Value

"Inbox"

Remarks

This property tells the connector 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 (Email Connector)

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

Data Type

Integer

Default Value

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 connector

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 (Email Connector)

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.

MessageCc Property (Email Connector)

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 (Email Connector)

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 (Email Connector)

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 (Email Connector)

Message headers associated with the current email message.

Data Type

String

Default Value

Remarks

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

This property is not available in the Sender.

MessageHTML Property (Email Connector)

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 connector will send the email as an HTML encoded message.

This property is not available in the Receiver.

MessageId Property (Email Connector)

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 (Email Connector)

The globally unique identifier of the message.

Data Type

String

Default Value

Remarks

The connector 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 (Email Connector)

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 (Email Connector)

The size of the current message.

Data Type

Integer

Default Value

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 (Email Connector)

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 (Email Connector)

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 (Email Connector)

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 (Email Connector)

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 (Email Connector)

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

Data Type

String

Default Value

Remarks

The connector 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 connector, 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 (Email Connector)

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 (Email Connector)

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

Data Type

Boolean

Default Value

false

Remarks

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

ReadReceipt Property (Email Connector)

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.

ReplyTo Property (Email Connector)

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.

RuntimeLicense Property (Email Connector)

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

SendTo Property (Email Connector)

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

This property is not available in the Receiver.

ServerType Property (Email Connector)

The type of server for your email account.

Data Type

Enumeration

Possible Values

IMAP (0)
POP3 (1)

Default Value

Remarks

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

This property is not available in the Sender.

SMTPMessageId Property (Email Connector)

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 connector will automatically calculate the MessageId. It is recommended that this property be left blank to allow the connector 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 (Email Connector)

The server port for SMTP (default 25).

Data Type

Integer

Default Value

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 connector

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 (Email Connector)

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 connector 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 (Email Connector)

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

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the connector 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 connector to report the server's credentials to Location.

SSLCert Property (Email Connector)

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.

SSLStartMode Property (Email Connector)

Determines how the component starts the SSL negotiation.

Data Type

Enumeration

Possible Values

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

Default Value

Remarks

The SSLStartMode property may have one of the following values:


Automatic	If the remote port is set to the standard plaintext port of the protocol (where applicable), the connector will behave the same as if SSLStartMode is set to Explicit. In all other cases, SSL negotiation will be implicit (Implicit).
Implicit	The SSL negotiation will start immediately after the connection is established.
Explicit	The connector will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
None	No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Subject Property (Email Connector)

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.

Timeout Property (Email Connector)

A timeout for the component.

Data Type

Integer

Default Value

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

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

User Property (Email Connector)

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

Store
String
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.

StorePassword
String
Default Value: ""

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

StoreType
CertStoreTypes
Default Value: 0

The type of certificate store for this certificate.

The connector supports both public and private keys in a variety of formats. When the cstAuto value is used, the connector will automatically determine the type. This field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CERTMGR connector. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String
Default Value: ""

The subject of the certificate used for client authentication.

When this property is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the property.

When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

Control.CertSubject = "Test"

If a match is not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

If a matching certificate is found, Subject is set to the full subject of the matching certificate.

Thumbprint
String (read-only)
Default Value: ""

The thumbprint of the certificate.

This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them.

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

AutoDetect
Boolean
Default Value: False

Tells the connector whether or not to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes
Default Value: 0

Determines the type of firewall to connect through. The applicable values are the following:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.

Host
String
Default Value: ""

Name or IP address of firewall (optional). If a Host is given, requested connections will be authenticated through the specified firewall when connecting.

If the Host field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the Host field is set to the corresponding address. If the search is not successful, an error is returned.

Password
String
Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

Port
Integer
Default Value: 0

The TCP port for the firewall Host. See the description of the Host field for details.

Note that the Port is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
String
Default Value: ""

A user name if authentication is to be used connecting through a firewall. If the Host is specified, the User and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, a trappable error is fired.

OAuthAuthorizationParam Type

This type holds details of the OAuth authorization.

Remarks

This type holds details of the OAuth authorization.

Fields

AuthorizationScopes
String
Default Value: ""

A space separated list of scopes as defined by the authorization server.

AuthorizationString
String
Default Value: ""

The OAuth Authorization string. This field holds the current OAuth authorization string. This is retrieved during the OAuth authorization process and is used to authenticate the request. This is a string like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ

CacheLocation
String
Default Value: ""

The location on disk of the OAuth Cache File.

This field specifies the location on disk of the OAuth cache file. This file holds OAuth credentials that may be automatically used during runtime and by other ports using the same provider. The connector uses the data within the cache file to automatically refresh expired tokens at runtime. Do not alter the contents of the file directly.

One file for each provider is used by default. For instance for Box the value is: %APPDATA%\nsoftware\CloudStorage BizTalk Adapter\BoxOAuthCache.txt

This value may be specified manually as well.

CallbackURL
String
Default Value: ""

The Callback URL used during OAuth authorization.

This field specifies the local URL to which the browser is redirected when initially performing authorization. When initially establishing Authorization set this value to the redirect URI that is registered for your application with the service provider. For instance "http://localhost:7777".

The connector will parse this URL and start a small embedded web server on the specified port to receive the OAuth response from the provider during OAuth authorization.

This value is required to perform OAuth authorization.

ClientId
String
Default Value: ""

The id of the client assigned when registering the application.

This field holds the id of the client that was assigned when initially registering the application.

This value is required to perform OAuth authorization.

ClientSecret
String
Default Value: ""

The secret of the client assigned when registering the application.

This field holds the secret of the client that was assigned when initially registering the application.

This value is required to perform OAuth authorization.

ExpiresIn
Integer
Default Value: 0

The expiration time of the current OAuth authorization string.

This value is populated after OAuth authorization and holds the expiration time of the OAuth access token as reported by the service provider. This is used at runtime to calculate whether the token should be refreshed before attempting an operation. If the token is expired the connector will automatically refresh the token. If the token is not expired the connector will use the current token.

This value should not be set manually.

Note: Not all providers provide this value. For instance Dropbox access tokens never expire.

RefreshToken
String
Default Value: ""

The refresh token received from or sent to the authorization server.

This field holds the refresh token received during the initial OAuth authorization. It is used by the connector to automatically request a new AuthorizationString when the current value expires.

ServerAuthURL
String
Default Value: ""

The URL of the authorization server.

ServerTokenURL
String
Default Value: ""

The URL of the token server.

ServiceProvider
String
Default Value: ""

The service provider to authenticate with.

This field defines the service provider. This is used when performing OAuth authorization. OAuth authorization is only applicable to some providers. If the provider does not support OAuth a warning will be displayed. Possible values when using the Email connector are:

Gmail
Other

TimeStamp
String
Default Value: "0"

The timestamp of the OAuth authorization string.

This field holds the timestamp of when the AuthorizationString was retrieved. This is used in conjunction with ExpiresIn to calculate if refreshing the token is required. For more details see ExpiresIn.

This value should not be set manually.

Config Settings (Email Connector)

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

Email Config Settings

AddAttachmentsAsMessageParts: Includes attachments as additional parts on the message.

When retrieving messages from a mail server, this setting may be set to True to include incoming attachments as additional message parts. This setting is valid only when receiving messages, and is supported when using both the IMAP and POP protocols. If DuplicateAttachmentAction is set to "overwrite", an error will be thrown if there are duplicate attachments on the same email.

AttachmentEncoding[index]: Content-Transfer-Encoding for attached file (at index).

This configuration setting allows you to set the Content-Transfer-Encoding for each attached file in the Attachments array property. Valid array indices are from 0 to AttachmentCount - 1. When set to one of the below integer values, the attachment will be encoded using the specified encoding. The following encodings are supported:


0	7-bit
1	Quoted-Printable
2	Base64
3	8-bit

AttachmentName[index]: Filename for the attached file (at index).

This configuration setting allows you to set the filename for each attached file when IncludeAttachments is used. Valid array indices are from 0 to AttachmentCount - 1. An index of -1 can be used to set the filename to the same value for all potential attachments. To set the filename for the attachment at index 2, you would set the string "AttachmentName[2]=%SourceFileNameNoExt%.txt".

AttachmentNameSource: Specifies the source location in the MIME entity from which the filename is retrieved.

When set to 0 (default), the connector will use the usual header attributes to determine the filename of the attachment that is saved to disk. If these values are not present, the name attribute from the Content-Type header may be used by setting this configuration setting to 1. Note that use of the name attribute for Content-Type is deprecated, but this configuration setting is present to allow for backward compatibility. Possible value are:


0	Auto (default)
1	Auto including legacy attributes

AutoDecodeHeaders: Whether to decode headers.

When retrieving messages from the server, this setting specifies whether headers are automatically decoded by the connector. When IncludeHeaders is set to True this setting may also be set to False to ensure that the original header values are included without any processing applied. This is helpful in scenarios when further processing of the message is done outside of the connector. The default value is True.

AutoDecodeMessageText: Whether to decode non-MIME message text.

When retrieving non-MIME encoded messages from the server, this setting specifies whether encoded messages (e.g., Base64 encoded message) are automatically decoded by the connector. This configuration option is only valid for messages that are not MIME encoded. The default value is False.

DuplicateAttachmentAction: Specifies what action to take when a duplicate filename is encountered.

This setting determines what happens when AttachmentDirectory is set and a duplicate filename is encountered. Possible values are:


0	Overwrite. The file is overwritten in the AttachmentDirectory.
1 (default)	Rename. The file is renamed so both files are kept.

The default value is 1 (Rename). With that setting the filename will include text indicating it is a duplicate. For instance "test.txt" would be renamed to "test-duplicate-1.txt" in the event of a filename conflict. If set to 0 (Overwrite) the previous file will be overwritten.

FoldHeaders: Whether incoming message headers should be folded.

By default, when IncludeHeaders is true, the connector will unfold headers so that each header is on a single line. To instruct the connector to fold the headers, set this configuration setting to True. Folding the headers may resolve line-length issues if the header value is long.

This is only applicable when receiving. The default value is False.

MaskSensitive: Whether sensitive properties should be masked when logging.

By default, Verbose logging will include the raw commands sent to the mail server in plain text. To mask sensitive values such as passwords and prevent them from appearing in the log, set this option to True. The default value is true.

MaxParts: The maximum number of parts to be parsed from a mime message.

This config should be set to limit the amount of parts that will be parsed from an email. By default, this value is 100. Therefore up to 100 parts (the body and 99 attachments) will be parsed from an email by default.

MessageHTMLFile: Specifies a file that will be included as the email's HTML content.

This configuration setting can be used to specify a file that will be included in the HTML content of the email. If the MessageHTML property is also specified, the contents of the file will be included after the value in the MessageHTML property.

MoveTo: Specifies the IMAP folder on the server to which messages will be moved.

If set, the connector will move the downloaded messages to the folder specified. This is only applicable when ServerType is set to IMAP. Only successfully downloaded messages will be moved.

This is only applicable when receiving.

ReturnOnlyPlainTextPart: Specifies if the connector should return the first plain text part or the entire message.

If set to true the connector will return only the first plain text part of a message. This is false by default. This is only applicable when receiving messages.

ReturnPath: Sets the Return-Path to be used for sending email.

Setting this property sets the Return-Path to be used for sending email. If this is not set, the value in From is used.

This is only applicable when sending emails.

UIDMode: If True, permanent message identifiers will be used instead of temporary identifiers.

When False, the IMAP server uses temporary message identifiers that are valid only during the current session. If this configuration setting is True (default), permanent message identifiers will be used instead.

The IMAP protocol operations where UID mode is used are the following: COPY, FETCH, STORE, SEARCH.

Note: This configuration setting only applies when ServerType is set to IMAP;

SSL Config Settings

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the connector will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the connector is the same.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the connector will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when UseInternalSecurityAPI is False (default): // The "Other" property could contain ONE of the following lines: SSLEnabledCipherSuites=* SSLEnabledCipherSuites=CALG_AES_256 SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES Possible values when UseInternalSecurityAPI is False (default) include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when UseInternalSecurityAPI is True:

// The "Other" property could contain ONE of the following lines:
SSLEnabledCipherSuites=*
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA

Possible values when UseInternalSecurityAPI is True include:

TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:

TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:


TLS1.3	12288 (Hex 3000) (Experimental)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the transport log contains the full certificate chain. By default this value is False and only the leaf certificate will be present.

If set to True all certificates returned by the server will be present in the transport log. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider.

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the connector will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the connector will fail with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: // The "Other" could contain ALL of these lines: UseInternalSecurityAPI=true SSLEnabledProtocols=3072 TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa The default value for this setting is "sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-dsa".

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)

The default value is rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

General Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

LocalHost: The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the connector initiate connections (or accept in the case of server connectors) only through that interface.

If the connector is connected, the LocalHost configuration shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

TcpNoDelay: Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to False, the connector will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to True tells the connector to use the internal implementation instead of using the system security libraries.

This setting is set to False by default on all platforms.