EmailClient
Contents
[
Hide
]EmailClient class
Represents the client that creates server connection by using the host credentials.
Constructors
| Name | Description |
|---|---|
| EmailClient (9 overloads) | Initializes a new instance of the EmailClient class. |
Methods
| Name | Description |
|---|---|
| CancelAsyncOperation | Cancels asynchronous operation. This method is used only with APM operations also known as Begin/End methods. Please do not use this method with TAP operations! |
| ConnectionFinalize | Performs finalization operation for specified connection |
| CreateConnection (2 overloads) | 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. |
| Dispose (2 overloads) | Finalizes all operations with a server. |
| EndGroupOperation | Waits for the pending asynchronous operation to complete. |
| get_AccessToken | Gets the access token. |
| get_ClientCertificates | Contains collection of clients certificates |
| get_ConnectionAsgmtMode | Gets value which defines mode of connection allocation in multiple threads environment |
| get_ConnectionCheckupPeriod | Period of connection checking up in milliseconds. Default value is 5 min. |
| get_ConnectionPool | Gets connection pool for the client |
| get_ConnectionsQuantity | Gets quantity of connections in multy-connection mode |
| get_ConnectionState | Gets the current state of the connection. |
| get_Credentials | |
| get_CurrentConnection | Gets current connection according to ConnectionAsgmtMode option |
| get_DefaultEncoding | Gets default encoding for email client |
| get_DefaultPort | Gets default port for client |
| get_EnableLogger | Gets value which allows enable/disable logger |
| get_GreetingTimeout | Gets the greeting timeout that is used when establishing a connection. Please note, greeting timeout can’t be infinite. |
| get_Host | Gets the host name. |
| get_LogFileName | Gets log file name |
| get_Logger | |
| get_Password | Gets the password. Password limitations are defined by server implementation, which client connects. |
| get_Port | Gets the port. |
| get_Proxy | Gets proxy for the client |
| get_SecurityOptions | Security mode for a mail client |
| get_SupportedEncryption | Defines 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 SetSupportedEncryptionUnsafe method if you want to set the encryption protocols without any compatibility checks. Default value is: Tls |
| get_Timeout | Gets the timeout for mail operations |
| get_TokenProvider | Gets TokenProvider allowing to retrieve access token. |
| get_UseAuthentication | Indicates whether authentication is used. |
| get_UseDateInLogFileName | Gets value which indicates if date has to be used in log file name. |
| get_UseDefaultCredentials | Gets a Boolean value that controls whether the DefaultCredentials are sent with requests. This option is used with NTLM authentication ONLY! |
| get_UseMultiConnection | Gets 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. |
| get_UsePipelining | Gets object which indicates whether the pipelining mode is enabled. |
| get_Username | Gets the username. |
| GetCapabilities | |
| InitializeConnectionPool | |
| initializeLogger | |
| Noop (3 overloads) | ‘No operation’ command |
| ResetLogSettings | Resets logging settings to default. |
| set_AccessToken | Sets the access token. |
| set_ConnectionAsgmtMode | Sets value which defines mode of connection allocation in multiple threads environment |
| set_ConnectionCheckupPeriod | Period of connection checking up in milliseconds. Default value is 5 min. |
| set_ConnectionPool | Sets connection pool for the client |
| set_ConnectionsQuantity | Sets quantity of connections in multy-connection mode |
| set_Credentials | |
| set_DefaultEncoding | Sets default encoding for email client |
| set_EnableLogger | Sets value which allows enable/disable logger |
| set_GreetingTimeout | Sets the greeting timeout that is used when establishing a connection. Please note, greeting timeout can’t be infinite. |
| set_Host | Sets the host name. |
| set_LogFileName | Sets log file name |
| set_Logger | |
| set_Password | Sets the password. Password limitations are defined by server implementation, which client connects. |
| set_Port | Sets the port. |
| set_Proxy | Sets proxy for the client |
| set_SecurityOptions | Security mode for a mail client |
| set_SupportedEncryption | Defines 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 SetSupportedEncryptionUnsafe method if you want to set the encryption protocols without any compatibility checks. Default value is: Tls |
| set_Timeout | Sets the timeout for mail operations |
| set_TokenProvider | Sets TokenProvider allowing to retrieve access token. |
| set_UseAuthentication | Indicates whether authentication is used. |
| set_UseDateInLogFileName | Sets value which indicates if date has to be used in log file name. |
| set_UseDefaultCredentials | Sets a Boolean value that controls whether the DefaultCredentials are sent with requests. This option is used with NTLM authentication ONLY! |
| set_UseMultiConnection | 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. |
| set_UsePipelining | Sets object which indicates whether the pipelining mode is enabled. |
| set_Username | Sets the username. |
| SetCredentials | |
| SetSupportedEncryptionUnsafe | Defines the versions of SSL/TLS encryption protocols to be used. This method is not safe and sets the encryption protocols without any compatibility checks. Use SupportedEncryption property to safely set only protocols that definitely supported by .net framework. Please note, if your current .net framework does not support this level of security, an exception will be thrown when trying to establish a connection to the server. |
| ValidateCredentials | Checks if the credentials are valid |
| Aspose::Email::Clients::Imap::ImapClient | |
| Aspose::Email::Clients::Pop3::Pop3Client | |
| Aspose::Email::Clients::Smtp::SmtpClient | |
| accessToken | |
| clientType | |
| connectionPool | |
| logger | |
| loggerSyncObj | |
| logManagerSyncObj | |
| password | |
| tokenProvider | |
| username |