PIMAP Configuration
The class 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 class, access to these internal properties is provided through the Config method.PIMAP Configuration Settings
Comment: The OpenPGP message comment.OpenPGP messages may contain a comment. This setting holds the comment (if any) after calling Decrypt, DecryptAndVerifySignature, or VerifySignature. | |||||||||
ProcessAttachments: Whether or not to process attachments.This setting controls whether attachments are processed when calling Decrypt, DecryptAndVerifySignature, or VerifySignature. When set to True if an attachment is a valid OpenPGP message it will be decrypted and/or verified. If it is not a valid OpenPGP message it will be left as is. When set to False the attachments are not processed. The default value is True. | |||||||||
LogLevel: Specifies the level of detail that is logged.This setting controls the level of detail that is logged through the Status event. Possible values are:
| |||||||||
RequireValidSignature: Specifies if an invalid signature is considered an error condition.By default, if the signature is not valid the class fails with an error. This setting may be set to False to disable this requirement. When False, the Status parameter of the VerificationStatus event should be checked to determine the result of the operation. The default value is True. | |||||||||
SymmetricPassphrase: The password used for symmetric encryption or decryption.This setting specifies the passphrase when using symmetric encryption. If a value is provided, symmetric encryption/decryption will be attempted. In this case no keys are used for either encryption or decryption. Only Encrypt and Decrypt are valid operations when a value is set. Sign, SignAndEncrypt, VerifySignature, and DecryptAndVerifySignature are not valid operations when using this option. | |||||||||
VersionHeader: The Version header value in the ASCII armored OpenPGP message.This setting specifies the Version header value included in the ASCII armored OpenPGP message.
This may be set before calling Encrypt, Sign, or SignAndEncrypt. The default
value is "IPWorks! OpenPGP v9.0".
This setting will be populated after calling Decrypt, VerifySignature, or DecryptAndVerifySignature. |
IMAP Configuration Settings
AlwaysReturnUIDs: Instructs the server to return UIDs even if not in UIDMode.
If UIDMode is set to false the MessageSet contains session message ids,
and the response from the server is going to contain session message ids
as well. In some cases it is desirable that the server sends back UIDs;
set the AlwaysReturnUIDs to True to instruct the server to do so.
The default value for this setting is False. | |
AppendToMailboxDateTime: Specifies the date-time parameter used in the initial APPEND request.
When appending to a mailbox using the AppendToMailbox method, the IMAP RFC specifies a date-time parameter that can be used to set the internal date of the resulting message. This configuration setting can be used to specify the date-time parameter used in this case.
The date-time should be formatted according to the IMAP RFC specifications. For example, "22-Jan-2013 12:34:56 -0500" indicates January 22nd, 2013 at 12:34:56 PM EST. By default, if this setting is not specified, no date-time is sent with the APPEND request and the server will use the current time. | |
AuthorizationIdentity: The value to use as the authorization identity when SASL authentication is used.
When AuthMechanism is set to amSASLPlain, amSASLDigestMD5, or amXOAUTH2 you may use this setting to specify an authorization
identity to be used when authenticating.
In the case of amXOAUTH2 this should be your OAUTH authorization string. For instance:
Bearer ya29.AHES6ZRmS-8xPbpGetC1VbABJIBRdKm-c4X7wMVGAbgxdGt5q8Ts3QNote: When using amXOAUTH2 User must be specified, but Password is not required. | |
AutoDecodeSubject: Instructs the class to automatically decode message subjects.Subjects that have been Quoted-Printable or Base-64 encoded are automatically decoded when this configuration setting is True (default). Only subjects in the format "=?iso-8859-1?Q?data?=" will be correctly decoded. | |
EnableIMAPIDLE: Enables or disables IDLE command support in the class.If set to True, Command may then be set to "IDLE" to begin idling. Set Command to "DONE" to stop idling. | |
FetchAfterSearch: Determines if messages matching the SearchCriteria are fetched after calling SearchMailbox.If set to False, FetchMessageInfo will not be called for messages matching the SearchCriteria after calling SearchMailbox. MessageInfo will still fire, but the MessageId parameter will be the only parameter populated. The default value of this setting is True. | |
IncludeHeaders: Instructs the class to include the headers in the LocalFile.When set to true, the headers for the message you are fetching will be written to the LocalFile before the message body. In this manner, the whole content of a MIME-encoded message will be written to the file. | |
UTF7MailboxNames: Specifies whether or not to automatically encode and decode UTF-7 mailbox names.IMAP servers may represent some characters in a mailbox name in UTF-7 format. This setting determines whether or not the class should automatically encode and decode these values. When set to false no encoding or decoding will be performed by the class. The default value is true. |
IPPort Configuration Settings
ConnectionTimeout: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data. | |||||||||
FirewallAutoDetect: Tells the class whether or not to automatically detect and use firewall system settings, if available.This is the same as FirewallAutoDetect. This setting is provided for use by classs that do not directly expose Firewall properties. | |||||||||
FirewallHost: Name or IP address of firewall (optional).If a FirewallHost is given, requested connections will be authenticated through the specified firewall
when connecting.
If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This is the same as FirewallHost. This setting is provided for use by classs that do not directly expose Firewall properties. | |||||||||
FirewallPassword: Password to be used if authentication is to be used when connecting through the firewall.If FirewallHost is specified, the FirewallUser and FirewallPassword settings
are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.
NOTE: This is the same as FirewallPassword. This setting is provided for use by classs that do not directly expose Firewall properties. | |||||||||
FirewallPort: The TCP port for the FirewallHost;.Note that the FirewallPort is set automatically when FirewallType is set to a valid value.
NOTE: This is the same as FirewallPort. This setting is provided for use by classs that do not directly expose Firewall properties. | |||||||||
FirewallType: Determines the type of firewall to connect through.The appropriate values are as follows:
NOTE: This is the same as FirewallType. This setting is provided for use by classs that do not directly expose Firewall properties. | |||||||||
FirewallUser: A user name if authentication is to be used connecting through a firewall.If the FirewallHost is specified, the FirewallUser and FirewallPassword
settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.
NOTE: This is the same as FirewallUser. This setting is provided for use by classs that do not directly expose Firewall properties. | |||||||||
KeepAliveTime: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, TCPKeepAlive will automatically be set to true.
By default the operating system will determine the
time a connection is idle before a TCP keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many
cases a shorter interval is more useful. Set this value to the desired interval in milliseconds.
Note: This value is not applicable in Java. | |||||||||
KeepAliveInterval: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, TCPKeepAlive will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet
will be re-sent. This setting specifies the interval at which the successive keep-alive packets are sent in milliseconds.
This system default if this value is not specified here is 1 second.
Note: This value is not applicable in Java or MAC. | |||||||||
KeepAliveRetryCount: The number of keep-alive packets to be sent before the remotehost is considered disconnected.When set, TCPKeepAlive will automatically be set to true.
A TCP keep-alive packet will be sent after a period of inactivity as
defined by KeepAliveTime. If no acknowledgement is received from the remote host the keep-alive packet
will be re-sent. This setting specifies the number of times that the keep-alive packets will be re-sent before the remote host
is considered disconnected.
The system default if this value is not specified here is 9.
Note: This configuration setting is only available in the Unix platform, and isn't supported in Mac OS or FreeBSD. | |||||||||
Linger: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.
In the case that Linger is True (default), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires. In the second scenario, LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data is sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (by a client acknowledgment, for example), setting this property to False might be the appropriate course of action. | |||||||||
LingerTime: Time in seconds to have the connection linger. LingerTime is the time, in seconds, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol timeout. | |||||||||
LocalHost: The name of the local host through which connections are initiated or accepted.
The LocalHost setting 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. If the class is connected, the LocalHost setting 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 multi-homed hosts (machines with more than one IP interface). | |||||||||
LocalPort: The TCP port in the local host where the class binds.
This must be set before a connection is
attempted. It instructs the class to bind to a specific
port (or communication endpoint) in the local machine.
Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established. LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems. | |||||||||
MaxLineLength: The maximum amount of data to accumulate when no EOL is found.MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL
string.
If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset. If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset. The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes. The maximum value is 65536 bytes. | |||||||||
MaxTransferRate: The transfer rate limit in bytes per second.This setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default this is not set and there is no limit. | |||||||||
RecordLength: The length of received data records.If set to a positive value, this setting defines the length of data records to be received. The class will accumulate data
until RecordLength is reached and only then fire the DataIn event with data of length RecordLength.
This allows data to be received as records of known length. This value can be changed at any time, including within the DataIn event.
The default value is 0, meaning this setting is not used. | |||||||||
TCPKeepAlive: Determines whether or not the keep alive socket option is enabled.If set to true, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically
to maintain the connection. Set KeepAliveTime and KeepAliveInterval to
configure the timing of the keep-alive packets.
Note: This value is not applicable in Java. | |||||||||
UseIPv6: Whether to use IPv6.When set to 0 (default), the class will use IPv4 exclusively.
When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0.
Possible values are:
| |||||||||
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. |
SSL Configuration Settings
ReuseSSLSession: Determines if the SSL session is reused.
If set to true, the component will reuse the context if and only if the following criteria are met:
| |||||||||||||||||||||||||
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. The actual cipher strength used for the connection is shown by the SSLStatus event. Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting. | |||||||||||||||||||||||||
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:
When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting. TLS 1.1 and TLS1.2 support are only available starting with Windows 7. | |||||||||||||||||||||||||
SSLProvider: The name of the security provider to use.
Change this setting to use security providers other than the system default.
Use this setting with caution. Disabling SSL security or pointing to the wrong provider could potentially cause serious security vulnerabilities in your application. The special value "*" (default) picks the default SSL provider defined in the system. Note: On Windows systems, the default SSL Provider is "Microsoft Unified Security Protocol Provider" and cannot be changed. | |||||||||||||||||||||||||
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:
This functionality is currently not available when the provider is OpenSSL. | |||||||||||||||||||||||||
OpenSSLCADir: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.
The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. | |||||||||||||||||||||||||
OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.
This functionality is available only when the provider is OpenSSL.
The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details. | |||||||||||||||||||||||||
OpenSSLCipherList: A string that controls the ciphers to be used by SSL.
This functionality is available only when the provider is OpenSSL. The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH". | |||||||||||||||||||||||||
OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).
This functionality is available only when the provider is OpenSSL.
By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG. |
Socket 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.
Note: This option is not valid for UDP ports. | |
FirewallData: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes). | |
InBufferSize: The size in bytes of the incoming queue of the socket.
This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be receiving. Increasing the value of the
InBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. | |
OutBufferSize: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack.
You can increase or decrease its size depending on the amount
of data that you will be sending. Increasing the value of the
OutBufferSize setting can provide significant improvements in
performance in some cases.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small. |
Base Configuration Settings
SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. |
Base Configuration Settings
CodePage: The system code page used for Unicode to Multibyte translations.
The default code page is the Active Code Page (0).
The following is a list of valid code page identifiers:
|