EmailClient

EmailClient class

Represents the client that creates server connection by using the host credentials.

The EmailClient type exposes the following members:

Properties

NameDescription
enable_loggerGets or sets value which allows enable/disable logger
log_file_nameGets or sets log file name
use_date_in_log_file_nameGets or sets value which indicates if date has to be used in log file name.
supported_encryptionDefines the versions of SSL/TLS encryption protocols to be used.
PLEASE PAY YOUR ATTENTION, you may set only those versions of protocol, which are supported by .net framework.
IF SOME VERSIONS OF PROTOCOL ARE NOT SUPPORTED BY YOUR CURRENT VERSION OF .NET FRAMEWORK, THEY WILL BE IGNORED AND SKIPPED.
IT MAY LEAD TO DOWNGRADE TLS SECURITY LEVEL. IN THIS CASE EXCEPTION WON’T BE GENERATED!!!
Please, see EncryptionProtocols documentation for more details.
Please use
use_pipeliningGets or sets object which indicates whether the pipelining mode is enabled.
hostGets or sets the host name.
default_portGets default port for client
portGets or sets the port.
security_optionsSecurity mode for a mail client
use_authenticationIndicates whether authentication is used.
connection_checkup_periodPeriod of connection checking up in milliseconds.
Default value is 5 min.
use_default_credentialsGets or sets a Boolean value that controls whether the DefaultCredentials are sent with requests.
This option is used with NTLM authentication ONLY!
proxyGets or sets proxy for the client
timeoutGets or sets the timeout for mail operations
greeting_timeoutGets or sets the greeting timeout that is used when establishing a connection.
Please note, greeting timeout can’t be infinite.

Email clients may execute enough long operations. To limit the time of operations users have to use timeout property.
Values for this property have to have long intervals to not prevent long-time operations.
But in some cases, if EmailClient will use only Timeout property connection establishing may take a long time.
For instance, the mail client may use the automatic mode to connection establishing.
In this mode, the email client goes through all possible connection parameters until the connection is established.
SMTP, IMAP, and POP3 servers in case of correct connection establishing send greeting string to the client.
Servers may use implicit or explicit (START TLS) SSL/TLS connection initiation.
If connection mode is mismatched (for instance, the server waits for an implicit SSL connection but the client tries to establish
a non-secured or explicit SSL connection), the server won’t send a greeting string.
In this case, the user will wait a long time until the timeout reaches a greeting string, and the client goes to the next connection option.
To avoid this problem, the GreetingTimeout property has been introduced. This property allows you to set the timeout for greeting string,
and reduce the time of automatic connection establishment.
passwordGets or sets the password.
Password limitations are defined by server implementation, which client connects.
access_tokenGets or sets the access token.
token_providerGets or sets TokenProvider allowing to retrieve access token.
usernameGets or sets the username.
connection_stateGets the current state of the connection.
current_connectionGets current connection according to ConnectionAsgmtMode option
connection_asgmt_modeGets or sets value which defines mode of connection allocation in multiple threads environment

There are folowing connection types:

- Main connection is connection created and disposed together with mail client.It can’t be created or disposed manually.

- Default connection is connection default for some thread.
If default connection exists and ConnectionAsgmtMode allow, all methods of email client executed in this thread will be implicitly use this connection.
Only one default connection can be exist per thread. It can be created manually or automatically. It depends on EmailClient.ConnectionAsgmtMode property.
These connections can be created manually with EmailClient.CreateConnection(createAsDefaultConnection = true) method.
If default connection does not used(depends on connection allocation mode), main connection used implicitly instead of it.

- Independent connections are connections that are not linked to threads.They can be created manually and has to be used explicitly as method parameter.
These connections can be created manually with EmailClient.CreateConnection() method or EmailClient.CreateConnection(createAsDefaultConnection = false) method.

There are folowing connection allocation types:

- ConnectionAsgmtType.UseMainOrDefault

This mode uses by default in email clients.
Email client uses main connection for all operations from multiple threads if default connection hasn’t been created, or connection hasnt been passed as method parameter explicitly.
Main connection is connection which is created in the same time like email client.
User can create default connections for threads with CreateConnection method.
If default connection for thread is created, it’s used implicitly for all methods of email client which are invoked in this thread.
If default connection for thread is not created, main connection is used for all methods of email client which are invoked in this thread.
User also can create connections not linked with threads (not default connections) with CreateConnection method.
If user wants to use other connections (not main and not default) he has to pass this connection explicitly as parameter of a method which he wants to use.
User can additionally create any number of connections. Default connection can be only one per thread.
Please note default connections works correctly if user uses Thread objects for multitasking programming.
If user uses ConnectionPool or uses Task objects for multitasking programming this mode may lead to wrong behaviour of a programm.
To avoid this problem user has to manually dispose default conection (if he uses it) in the end of the code which executes in the thread.

- ConnectionAsgmtType.UseMain

Email client uses main connection for all operations from multiple threads.
Main connection is connection which is created in the same time like email client.
User cann’t create default connections.
User can create connections not linked with threads (not default connections) with CreateConnection method.
If user wants to use other connections (not main and not default) he has to pass this connection explicitly as parameter of a method which he wants to use.
User can additionally create any number of connections.

- ConnectionAsgmtType.UseDefault

Email client uses implicitly only default connections for all operations from multiple threads. Main connection is not used in this mode.
If default connection hasn’t been created for some thread (first invocation of email client method),
email client creates default connection implicitly for thread before first operation is executed.
User can’t create default connections for threads with CreateConnection method because they are created automatically.
When default connection for thread is created, it’s used implicitly for all methods of email client which are invoked in this thread.read.
User also can create connections not linked with threads (not default connections) with CreateConnection method.
If user wants to use other connections (not main and not default) he has to pass this connection explicitly as parameter of a method which he wants to use.
User can additionally create any number of connections. Default connection can be only one per thread.
Please note default connections works correctly if user uses Thread objects for multitasking programming.
If user uses ConnectionPool or uses Task objects for multitasking programming this mode may lead to wrong behaviour of a programm.
To avoid this problem user has to manually dispose default conection in the end of the code which executes in the thread.
use_multi_connectionGets or sets value which indicates if client has to use multiple connections for heavy loaded operations.
Please note, using of this mode not necessary has to lead to performance increasing.
connections_quantityGets or sets quantity of connections in multy-connection mode

Methods

NameDescription
noop()
noop(connection)
create_connection()
create_connection(create_as_default_connection)
reset_log_settings()
set_supported_encryption_unsafe(value)
get_capabilities()
validate_credentials()

See Also

CommandStatus HttpProxy