EmailClient Class

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

Namespace:  Aspose.Email.Clients
Assembly:  Aspose.Email (in Aspose.Email.dll) Version: 21.3
Syntax
public abstract class EmailClient : IDisposable

The EmailClient type exposes the following members.

Constructors
  NameDescription
Protected methodEmailClient(String)
Initializes a new instance of the EmailClient class.
Protected methodEmailClient(String, String, Int32)
Initializes a new instance of the EmailClient class.
Protected methodEmailClient(String, String, Int32, SecurityOptions)
Initializes a new instance of the EmailClient class.
Protected methodEmailClient(String, String, Int32, String, ITokenProvider)
Initializes a new instance of the EmailClient class.
Protected methodEmailClient(String, String, Int32, String, String)
Initializes a new instance of the EmailClient class.
Protected methodEmailClient(String, String, Int32, String, ITokenProvider, SecurityOptions)
Initializes a new instance of the EmailClient class.
Protected methodEmailClient(String, String, Int32, String, String, SecurityOptions)
Initializes a new instance of the EmailClient class.
Protected methodEmailClient(String, String, Int32, String, String, Boolean)
Initializes a new instance of the EmailClient class.
Protected methodEmailClient(String, String, Int32, String, String, Boolean, SecurityOptions)
Initializes a new instance of the EmailClient class.
Properties
  NameDescription
Public propertyAccessToken
Gets or sets the access token.
Public propertyClientCertificates
Contains collection of clients certificates
Public propertyConnectionAsgmtMode
Gets 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.
Public propertyConnectionCheckupPeriod
Period of connection checking up in milliseconds. Default value is 5 min.
Public propertyConnectionsQuantity
Gets or sets quantity of connections in multy-connection mode
Public propertyConnectionState
Gets the current state of the connection.
Public propertyCurrentConnection
Gets current connection according to ConnectionAsgmtMode option
Public propertyDefaultPort
Gets default port for client
Public propertyEnableLogger
Gets or sets value which allows enable/disable logger
Public propertyHost
Gets or sets the host name.
Public propertyLogFileName
Gets or sets log file name
Public propertyPassword
Gets or sets the password.
Public propertyPort
Gets or sets the port.
Public propertyProxy
Gets or sets proxy for the client
Public propertySecurityOptions
Security mode for a mail client
Public propertySupportedEncryption
Defines the versions of SSL/TLS encription protocols to be uised.
Public propertyTimeout
Gets or sets the timeout for mail operations
Public propertyTokenProvider
Gets or sets TokenProvider allowing to retrieve access token.
Public propertyUseAuthentication
Indicates whether authentication is used.
Public propertyUseDateInLogFileName
Gets or sets value which indicates if date has to be used in log file name.
Public propertyUseDefaultCredentials
Gets or sets a Boolean value that controls whether the DefaultCredentials are sent with requests.
Public propertyUseMultiConnection
Gets 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.
Public propertyUsePipelining
Gets or sets object which indicates whether the pipelining mode is enabled.
Public propertyUsername
Gets or sets the username.
Methods
  NameDescription
Public methodCancelAsyncOperation
Cancels asynchronous operation.
Public methodCreateConnection
Creates new independent connection for operations not linked to threads (not default connection). Invocation of this method is similar to invocation of CreateConnection(createAsDefaultConnection = false) Please see more in documentation for EmailClient.ConnectionAsgmtMode property.
Public methodCreateConnection(Boolean)
Creates new (default or independent) connection for operations. Please see more in documentation for EmailClient.ConnectionAsgmtMode property.
Public methodDispose
Finalizes all operations with a server.
Protected methodDispose(Boolean)
Finalizes all operations with a server.
Public methodEquals (Inherited from Object.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the EmailClient is reclaimed by garbage collection.
(Overrides ObjectFinalize.)
Public methodGetCapabilities
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodNoop
'No operation' command
Public methodNoop(IConnection)
'No operation' command
Public methodResetLogSettings
Resets logging settings to default.
Public methodToString (Inherited from Object.)
Public methodValidateCredentials
Checks if the credentials are valid
Events
  NameDescription
Public eventBindIPEndPoint
Associates a Socket with a local endpoint.
Public eventOnConnect
The OnConnect event occurs when the clent establishes connection.
See Also