 | Smtp Class |
SMTP client implementation. It allows sending emails using SMTP server.
Inheritance HierarchyNamespace: Limilabs.Client.SMTP
Assembly: Mail (in Mail.dll) Version: 3.0.26106.1555
SyntaxThe Smtp type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Smtp | Initializes new instance of the Smtp class. |
| Smtp(AddressFamily) | Initializes new instance of the Smtp class. |
Properties| Name | Description | |
|---|---|---|
 | AllowPartialSending |
Gets or sets the value indicating if SendMessage(IMail) and SendMessage(SmtpMail) should send message
even if some recipients were rejected.
Setting this value to true when Pipelining is used improves performance.
Default is false.
Obsolete |
| Configuration | Gets or sets SMTP protocol configuration. |
| Connected |
Gets a value indicating whether the underlying Socket is connected to a remote host.
This property makes a nonblocking, zero-byte Send call to determine the current state of the connection.
(Inherited from ClientBase) |
| CustomHost |
Gets or sets the value, which, if set, is used when sending HELO or EHLO commands.
Obsolete |
| DeliveryNotification |
Gets or sets the delivery notification options (Delivery Status Notifications, DSN) for email.
Available when DSN is reported by SupportedExtensions.
Obsolete |
| DisableValidation |
Gets or sets the value indicating if SmtpMail instance validation is performed before sending.
It ensures that the message has a sender, at least one recipient and a body.
Default is false.
Obsolete |
| EnableChunking |
Gets or sets the value indicating if Chunking should be used when sending messages.
Default is true.
Obsolete |
| EnablePipelining |
Gets or sets the value indicating if Pipelining should be used when sending messages.
Default is true.
Obsolete |
| InstanceId |
Gets a randomly generated unique id that identifies this instance.
(Inherited from ClientBase) |
| IsCompressed |
Gets a Boolean value that indicates whether communication to the remote server is compressed.
You can turn compression on by using Compress method.
(Inherited from ClientBase) |
| IsEncrypted |
Gets a Boolean value that indicates whether communication to the remote server is encrypted.
(Inherited from ClientBase) |
| IsMutuallyAuthenticated |
Gets a Boolean value that indicates whether communication to the remote server is mutually authenticated.
(Inherited from ClientBase) |
| IsSigned |
Gets a Boolean value that indicates whether communication to the remote server is signed.
(Inherited from ClientBase) |
| ReadStream |
Gets underlying read stream for current connection.
(Inherited from ClientBase) |
| ReceiveTimeout |
Gets or sets the amount of time the underlying Socket will wait to receive data once a read operation is initiated.
(Inherited from ClientBase) |
| SendTimeout |
Gets or sets the amount of time the underlying Socket will wait for a send operation to complete successfully.
(Inherited from ClientBase) |
| ServerGreeting | Gets the server greeting (initial response). |
| Socket |
Gets the underlying Socket.
(Inherited from ClientBase) |
| SSLConfiguration |
Gets SSL/TLS configuration (client certificates, enabled SSL/TLS protocols).
(Inherited from ClientBase) |
| WriteStream |
Gets underlying write stream for current connection.
(Inherited from ClientBase) |
Methods| Name | Description | |
|---|---|---|
| Attach(Socket) |
Attaches client to specified connected socket.
(Inherited from ClientBase) |
| Attach(Socket, Boolean) |
Attaches client to specified connected socket.
(Inherited from ClientBase) |
| AttachSSL |
Attaches client to specified connected socket.
(Inherited from ClientBase) |
| BeginConnect(String) | Begins an asynchronous request for a remote server connection using DefaultPort. |
| BeginConnect(IPEndPoint, Boolean) |
Begins an asynchronous request for a remote server connection.
(Inherited from ClientBase) |
| BeginConnect(String, Int32) |
Begins an asynchronous request for a remote server connection. You can use BeginConnectSSL(String, Int32) when SSL/TLS connection is needed.
(Inherited from ClientBase) |
| BeginConnect(String, AsyncCallback) | Begins an asynchronous request for a remote server connection using DefaultPort. |
| BeginConnect(String, Int32, Boolean) |
Begins an asynchronous request for a remote server connection.
(Inherited from ClientBase) |
| BeginConnect(String, Int32, Boolean, AsyncCallback) |
Begins an asynchronous request for a remote server connection.
(Inherited from ClientBase) |
| BeginConnectSSL(String) | Begins an asynchronous request for a remote server secure connection using DefaultSSLPort and SSL/TLS. |
| BeginConnectSSL(String, Int32) |
Begins an asynchronous request for a remote server secure connection using SSL/TLS.
(Inherited from ClientBase) |
| BeginConnectSSL(String, AsyncCallback) | Begins an asynchronous request for a remote server secure connection using DefaultSSLPort and SSL/TLS. |
| BeginConnectSSL(String, Int32, AsyncCallback) |
Begins an asynchronous request for a remote server secure connection using SSL/TLS.
(Inherited from ClientBase) |
| Close | Sends QUIT command. Disconnects and releases all resources acquired by this object. |
| Close(Boolean) | Sends QUIT command. Disconnects and releases all resources acquired by this object. |
| CloseAsync(CancellationToken) | Sends QUIT command. Disconnects and releases all resources acquired by this object. |
| CloseAsync(Boolean, CancellationToken) | Sends QUIT command. Disconnects and releases all resources acquired by this object. |
| Connect(String) | Connects to SMTP server on port 587. Use ConnectSSL(String) when SSL/TLS connection is needed. |
| Connect(IPEndPoint, Boolean) |
Establishes connection to a remote server.
(Inherited from ClientBase) |
| Connect(String, Int32) |
Establishes connection to a remote server. You can use ConnectSSL(String, Int32) when SSL/TLS connection is needed.
(Inherited from ClientBase) |
| Connect(IPAddress, Int32, Boolean) |
Establishes connection to a remote server.
(Inherited from ClientBase) |
| Connect(String, Int32, Boolean) |
Establishes connection to a remote server.
(Inherited from ClientBase) |
| ConnectAsync(String, CancellationToken) | Connects to SMTP server on port 587. Use ConnectSSL(String) when SSL/TLS connection is needed. |
| ConnectAsync(IPEndPoint, Boolean, CancellationToken) |
Establishes connection to a remote server.
(Inherited from ClientBase) |
| ConnectAsync(String, Int32, CancellationToken) |
Establishes connection to a remote server. You can use ConnectSSL(String, Int32) when SSL/TLS connection is needed.
(Inherited from ClientBase) |
| ConnectAsync(IPAddress, Int32, Boolean, CancellationToken) |
Establishes connection to a remote server.
(Inherited from ClientBase) |
| ConnectAsync(String, Int32, Boolean, CancellationToken) |
Establishes connection to a remote server.
(Inherited from ClientBase) |
| ConnectSSL(String) | Connects to SMTP server using SSL/TLS on port 465. |
| ConnectSSL(String, Int32) |
Establishes connection to a remote server using SSL.
(Inherited from ClientBase) |
| ConnectSSLAsync(String, CancellationToken) | Connects to SMTP server using SSL/TLS on port 465. |
| ConnectSSLAsync(String, Int32, CancellationToken) |
Establishes connection to a remote server using SSL.
(Inherited from ClientBase) |
| Dispose |
Releases all resources acquired by this object. Closes connection, without issuing any quit commands.
(Inherited from ClientBase) |
 | Dispose(Boolean) |
Releases all resources acquired by this object. Closes connection, without issuing any quit commands.
(Inherited from ClientBase) |
| EndConnect |
Ends a pending asynchronous connection request.
(Inherited from ClientBase) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Login | Logs user in using AUTH LOGIN command. This method sends the password in clear text (BASE64), unless SSL/TLS connection is used. |
| LoginAsync | Logs user in using AUTH LOGIN command. This method sends the password in clear text (BASE64), unless SSL/TLS connection is used. |
| LoginCRAM | Logs user in using AUTH CRAM-MD5 command. This method does NOT send the password in clear text. |
| LoginCRAMAsync | Logs user in using AUTH CRAM-MD5 command. This method does NOT send the password in clear text. |
| LoginDIGEST(String, String) | Logs user in using AUTH DIGEST-MD5 command. This method does NOT send the password in clear text. |
| LoginDIGEST(String, String, String) | Logs user in using AUTH DIGEST-MD5 command. This method does NOT send the password in clear text. |
| LoginDIGESTAsync(String, String, CancellationToken) | Logs user in using AUTH DIGEST-MD5 command. This method does NOT send the password in clear text. |
| LoginDIGESTAsync(String, String, String, CancellationToken) | Logs user in using AUTH DIGEST-MD5 command. This method does NOT send the password in clear text. |
| LoginOAUTH | Logs user in using AUTH XOAUTH command. This method does NOT send the password. You can use OAuth class to create the key. |
| LoginOAUTH2 | Logs user in using AUTH XOAUTH2 command. This method does NOT send the password. You can use DotNetOpenAuth to create the key. You can check which authentication methods remote server supports using SupportedAuthenticationMethods method. |
| LoginOAUTH2Async | Logs user in using AUTH XOAUTH2 command. This method does NOT send the password. You can use DotNetOpenAuth to create the key. You can check which authentication methods remote server supports using SupportedAuthenticationMethods method. |
| LoginOAUTHAsync | Logs user in using AUTH XOAUTH command. This method does NOT send the password. You can use OAuth class to create the key. |
| LoginPLAIN(String, String) | Logs user in using AUTH PLAIN command. This method sends the password in clear text (BASE64), unless SSL/TLS connection is used. |
| LoginPLAIN(String, String, String) | Logs user in using AUTH PLAIN command. This method sends the password in clear text (BASE64), unless SSL/TLS connection is used. |
| LoginPLAINAsync(String, String, CancellationToken) | Logs user in using AUTH PLAIN command. This method sends the password in clear text (BASE64), unless SSL/TLS connection is used. |
| LoginPLAINAsync(String, String, String, CancellationToken) | Logs user in using AUTH PLAIN command. This method sends the password in clear text (BASE64), unless SSL/TLS connection is used. |
| LoginSSPI | Logs user in using Negotiate mechanism. Target will be constructed as "smtp/" + TargetHost name. |
| LoginSSPI(SSPIMechanism) | Logs user in using specified mechanism (Negotiate, Kerberos or NTLM). Target will be constructed as "smtp/" + TargetHost name. |
| LoginSSPI(SSPIMechanism, String) | Logs user in using specified mechanism (Negotiate, Kerberos or NTLM). |
| LoginSSPI(SSPIMechanism, String, String) | Logs user in using specified mechanism (Negotiate, Kerberos or NTLM). Target will be constructed as "smtp/" + TargetHost name. |
| LoginSSPI(SSPIMechanism, String, String, String) | Logs user in using specified mechanism (Negotiate, Kerberos or NTLM). |
| LoginSSPIAsync(CancellationToken) | Logs user in using Negotiate mechanism. Target will be constructed as "smtp/" + TargetHost name. |
| LoginSSPIAsync(SSPIMechanism, CancellationToken) | Logs user in using specified mechanism (Negotiate, Kerberos or NTLM). Target will be constructed as "smtp/" + TargetHost name. |
| LoginSSPIAsync(SSPIMechanism, String, CancellationToken) | Logs user in using specified mechanism (Negotiate, Kerberos or NTLM). |
| LoginSSPIAsync(SSPIMechanism, String, String, CancellationToken) | Logs user in using specified mechanism (Negotiate, Kerberos or NTLM). Target will be constructed as "smtp/" + TargetHost name. |
| LoginSSPIAsync(SSPIMechanism, String, String, String, CancellationToken) | Logs user in using specified mechanism (Negotiate, Kerberos or NTLM). |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| Noop | Sends NOOP command to the server. It does nothing and always succeeds. Can be used to reset any inactivity auto-logout timer on the server. |
| NoopAsync | Sends NOOP command to the server. It does nothing and always succeeds. Can be used to reset any inactivity auto-logout timer on the server. |
| Send |
Sends specified byte array to the server.
(Inherited from ClientBase) |
| SendAsync |
Sends specified byte array to the server.
(Inherited from ClientBase) |
| SendCommand(String) | Sends command to the SMTP server (e.g. "EHLO"). |
| SendCommand(String, Boolean) | Sends command to the SMTP server (e.g. "EHLO"). |
| SendCommandAsync(String, CancellationToken) | Sends command to the SMTP server (e.g. "EHLO"). |
| SendCommandAsync(String, Boolean, CancellationToken) | Sends command to the SMTP server (e.g. "EHLO"). |
| SendMessage(IMail) | Sends a single email message. |
| SendMessage(SmtpMail) | Sends a single email message. |
| SendMessageAsync(IMail, CancellationToken) | Sends a single message. |
| SendMessageAsync(SmtpMail, CancellationToken) | Sends a single message. |
| StartTLS | Sends 'STARTTLS' command and initializes SSL/TLS connection (issues EHLO command afterwards). Not all servers support StartTLS. You can check which extensions remote server supports using SupportedExtensions method. |
| StartTLSAsync | Sends 'STARTTLS' command and initializes SSL/TLS connection (issues EHLO command afterward). |
| SupportedAuthenticationMethods | Lists authentication methods supported by the remote server. |
| SupportedExtensions | Lists extensions supported by the remote server (e.g. StartTLS) |
| TcpKeepAlive |
Turns TCP protocol keep alive (SO_KEEPALIVE) option on.
(Inherited from ClientBase) |
| TestMessageEnvelope(SmtpMail) | Sends message envelope to the SMTP server. Doesn't send or verify message contents. It can be used to verify if SMTP server accepts sender and recipient addresses. |
| TestMessageEnvelope(String, String) | Sends message envelope to the SMTP server. Doesn't send or verify message contents. It can be used to verify if SMTP server accepts sender and recipient addresses. |
| TestMessageEnvelopeAsync(SmtpMail, CancellationToken) | Sends message envelope to the SMTP server. Doesn't send or verify message contents. It can be used to verify if SMTP server accepts sender and recipient addresses. |
| TestMessageEnvelopeAsync(String, String, CancellationToken) | Sends message envelope to the SMTP server. Doesn't send or verify message contents. It can be used to verify if SMTP server accepts sender and recipient addresses. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UseBestLogin | Logs user in using best method available. When no AUTH capability is found, this method switches to SSL/TLS (StartTLS) and tries again. |
| UseBestLoginAsync | Logs user in using best method available. When no AUTH capability is found, this method switches to SSL/TLS (StartTLS) and tries again. |
Events| Name | Description | |
|---|---|---|
 | ServerCertificateValidate |
Event which is called for custom server certificate validation.
(Inherited from ClientBase) |
Fields| Name | Description | |
|---|---|---|
  | DefaultPort | Default SMTP protocol port (587). If you need to use different port please use port parameter in Connect(String, Int32) or Connect(String, Int32, Boolean) method. |
| DefaultSSLPort | Default SMTP protocol over SSL/TLS port (465). If you need to use different port please use port parameter in ConnectSSL(String, Int32) or Connect(String, Int32, Boolean) method. |
See Also