SmtpClient Class |
Namespace: Aspose.Email.Clients.Smtp
The SmtpClient type exposes the following members.
Name | Description | |
---|---|---|
SmtpClient |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(Configuration) |
Initializes a new instance of the SmtpClient class
by using configuration file settings.
| |
SmtpClient(String) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, SecurityOptions) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, Int32) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, Int32, SecurityOptions) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, String, ITokenProvider) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, String, String) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, Int32, String, ITokenProvider) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, Int32, String, String) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, String, ITokenProvider, SecurityOptions) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, String, String, SecurityOptions) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, String, String, Boolean) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, Int32, String, ITokenProvider, SecurityOptions) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, Int32, String, String, SecurityOptions) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, Int32, String, String, Boolean) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, String, String, Boolean, SecurityOptions) |
Initializes a new instance of the SmtpClient class.
| |
SmtpClient(String, Int32, String, String, Boolean, SecurityOptions) |
Initializes a new instance of the SmtpClient class.
|
Name | Description | |
---|---|---|
AccessToken |
Gets or sets the access token.
(Inherited from EmailClient.) | |
ClientCertificates |
Contains collection of clients certificates
(Inherited from EmailClient.) | |
ConnectionAsgmtMode |
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.
(Inherited from EmailClient.) | |
ConnectionCheckupPeriod |
Period of connection checking up in milliseconds.
Default value is 5 min.
(Inherited from EmailClient.) | |
ConnectionsQuantity |
Gets or sets quantity of connections in multy-connection mode
(Inherited from EmailClient.) | |
ConnectionState |
Gets the current state of the connection.
(Inherited from EmailClient.) | |
CurrentConnection |
Gets current connection according to ConnectionAsgmtMode option
(Inherited from EmailClient.) | |
DefaultPort |
Gets default port for client
(Overrides EmailClientDefaultPort.) | |
DeliveryMethod |
Gets or sets the delivery method.
| |
EnableLogger |
Gets or sets value which allows enable/disable logger
(Inherited from EmailClient.) | |
Encoding | Obsolete.
Gets or sets the encoding.
| |
HelloMessage |
Gets or sets a HELO/EHLO string.
| |
Host |
Gets or sets the host name.
(Inherited from EmailClient.) | |
LogFileName |
Gets or sets log file name
(Inherited from EmailClient.) | |
Password |
Gets or sets the password.
(Inherited from EmailClient.) | |
PickupDirectoryLocation |
Gets or sets the directory where applications save mail messages to be processed by the local SMTP server.
Please note: only absolute path is allowed.
| |
Port |
Gets or sets the port.
(Inherited from EmailClient.) | |
Proxy |
Gets or sets proxy for the client
(Inherited from EmailClient.) | |
SecurityOptions |
Security mode for a mail client
(Inherited from EmailClient.) | |
SmtpQueueLocation |
Gets or sets the directory where applications save mail messages to be processed by sending in SMTP queue.
Please note: only absolute path is allowed.
| |
SupportedEncryption |
Defines the versions of SSL/TLS encription protocols to be uised.
(Inherited from EmailClient.) | |
Timeout |
Gets or sets the timeout for mail operations
(Inherited from EmailClient.) | |
TokenProvider |
Gets or sets TokenProvider allowing to retrieve access token.
(Inherited from EmailClient.) | |
UseAuthentication |
Indicates whether authentication is used.
(Inherited from EmailClient.) | |
UseDateInLogFileName |
Gets or sets value which indicates if date has to be used in log file name.
(Inherited from EmailClient.) | |
UseDefaultCredentials |
Gets or sets a Boolean value that controls whether the DefaultCredentials are sent with requests.
(Overrides EmailClientUseDefaultCredentials.) | |
UseMultiConnection |
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.
(Inherited from EmailClient.) | |
UseMultyConnection | Obsolete.
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.
(Inherited from EmailClient.) | |
UsePipelining |
Gets or sets object which indicates whether the pipelining mode is enabled.
(Inherited from EmailClient.) | |
Username |
Gets or sets the username.
(Inherited from EmailClient.) | |
UseTnef |
Gets or sets a boolean value that controls whether the messages are sent in TNEF format.
Note, that now message is sent in TNEF format when being loaded a message contains tnef.
|
Name | Description | |
---|---|---|
BindIPEndPoint |
Associates a Socket with a local endpoint.
(Inherited from EmailClient.) | |
FailedQueueSending |
Adds or removes subscriber for notifications about failed sending operations in smtp queue
| |
OnConnect |
The OnConnect event occurs when the clent establishes connection.
(Inherited from EmailClient.) | |
SucceededQueueSending |
Adds or removes subscriber for notifications about succeeded sending operations in smtp queue
|