Email ConfigurationThe 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 Configuration 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.|
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:
|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=%SourceFileNameNoExt%.txt".|
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:
|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.|
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:
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 false.|
|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.|
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.|
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.
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 Configuration Settings
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 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.
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_3DESPossible values when UseInternalSecurityAPI is False (default) include:
// 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_SHAPossible values when UseInternalSecurityAPI is True include:
If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:
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:
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.
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.
Flags that control certificate verification.The following flags are defined (specified in hexadecimal
notation). They can be or-ed together to exclude multiple
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-dsaThe 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.
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:
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:
The allowed certificate signature algorithms.This setting holds a comma separated list of allowed signature algorithms. Possible values are:
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:
General Configuration Settings
|AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.|
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).
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: Tells the connector whether or not to use the system security libraries or an internal implementation. By default the connector will use the system security libraries to perform cryptographic functions. Setting this to True tells the connector to use the internal implementation instead of using the system's security API.|