 | Pop |
POP3 client implementation.
It allows listing, downloading and deleting emails from POP3 servers.
Inheritance HierarchyNamespace: Limilabs.Client.POP3
Assembly: Mail (in Mail.dll) Version: 3.0.26106.1555
SyntaxThe Pop3 type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | Pop3 | Initializes new instance of the Pop3 class. |
| Pop3(AddressFamily) | Initializes new instance of the Pop3 class. |
Properties| Name | Description | |
|---|---|---|
 | Configuration | Gets POP3 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) |
| HasTimeStamp | Gets the value that indicates if there was a timestamp in server's greeting. Usually it means that APOP command (LoginAPOP(String, String)) is supported, but not always. |
| 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) |
| Capability | Sends CAPA command. Retrieves POP3 server capability list. |
| CapabilityAsync | Sends CAPA command. Retrieves POP3 server capability list. |
| 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 POP3 server on port 110. 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 POP3 server on port 110. 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 POP3 server using SSL/TLS on port 995. |
| ConnectSSL(String, Int32) |
Establishes connection to a remote server using SSL.
(Inherited from ClientBase) |
| ConnectSSLAsync(String, CancellationToken) | Connects to POP3 server using SSL/TLS on port 995. |
| ConnectSSLAsync(String, Int32, CancellationToken) |
Establishes connection to a remote server using SSL.
(Inherited from ClientBase) |
| DeleteMessageByNumber | Marks specified message for deletion. POP3 server does not actually delete the message until successful QUIT command issued by Close or Close(Boolean). |
| DeleteMessageByNumberAsync | Marks specified message for deletion. POP3 server does not actually delete the message until successful QUIT command issued by Close or Close(Boolean). |
| DeleteMessageByUID | Deletes message specified by the uid. POP3 server does not actually delete the message until successful QUIT command issued by Close or Close(Boolean). |
| DeleteMessageByUIDAsync | Deletes message specified by the uid. POP3 server does not actually delete the message until successful QUIT command issued by Close or Close(Boolean). |
| 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) |
| GetAccountStat | Gets stat information from server. |
| GetAccountStatAsync | Gets stat information from server. |
| GetAll | Gets UIDS of all messages. |
| GetAllAsync | Gets UIDS of all messages. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetHeadersByNumber | Gets headers of the specified email message from server. Use MailBuilder class to create IMail object. |
| GetHeadersByNumberAsync | Gets specified mail message containing only headers. Use MailBuilder class to create IMail object. |
| GetHeadersByUID | Gets headers of the specified email message from server. Use MailBuilder class to create IMail object. |
| GetHeadersByUIDAsync | Gets headers of the specified mail message from server. Use MailBuilder class to create IMail object. |
| GetMessageByNumber | Gets specified email message from server. Use MailBuilder class to create IMail object. |
| GetMessageByNumberAsync | Gets specified mail message from server. Use MailBuilder class to create IMail object. |
| GetMessageByUID | Gets specified email message from server. Use MailBuilder class to create IMail object. |
| GetMessageByUIDAsync | Gets specified mail message from server. Use MailBuilder class to create IMail object. |
| GetSizeByNumber | Returns the size (in bytes) of all messages. Keys are message numbers (starting from 1), value is the size of the message. |
| GetSizeByNumber(Int64) | Returns the size (in bytes) of specified message in bytes. |
| GetSizeByNumberAsync(CancellationToken) | Returns the size (in bytes) of all messages. Keys are message numbers (starting from 1), value is the size of the message. |
| GetSizeByNumberAsync(Int64, CancellationToken) | Returns the size (in bytes) of specified message in bytes. |
| GetSizeByUID | Returns the size (in bytes) of all messages. Keys are message uids, value is the size of the message. |
| GetSizeByUID(String) | Returns the size (in bytes) of specified message in bytes. |
| GetSizeByUIDAsync(CancellationToken) | Returns the size (in bytes) of all messages. Keys are message uids, value is the size of the message. |
| GetSizeByUIDAsync(String, CancellationToken) | Returns the size (in bytes) of specified message in bytes. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetUID | Sends UIDL command to the pop3 server. Returns a key value collection. Keys are message numbers (starting from 1), value is a unique-id of the message. |
| GetUID(Int64) | Sends UIDL command to the pop3 server. Returns unique-id for that message. |
| GetUIDAsync(CancellationToken) | Sends UIDL command to the pop3 server. Returns a key value collection. Keys are message numbers (starting from 1), value is a unique-id of the message. |
| GetUIDAsync(Int64, CancellationToken) | Sends UIDL command to the pop3 server. Returns unique-id for that message. |
| Login | Logs user in using USER and PASS commands. This method sends the password in clear text, unless SSL/TLS connection is used. |
| LoginAPOP | Logs user in using APOP command. This method does NOT send the password in clear text. |
| LoginAPOPAsync | Logs user in using APOP command. This method does NOT send the password in clear text. |
| LoginAsync | Logs user in using USER and PASS commands. This method sends the password in clear text, 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. |
| LoginOAUTH2 | Logs user in using AUTHENTICATE 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 AUTHENTICATE 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. |
| LoginPLAIN(String, String) | Logs user in using AUTHENTICATE 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 AUTHENTICATE 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 "pop/" + TargetHost name. |
| LoginSSPI(SSPIMechanism) | Logs user in using specified mechanism (Negotiate, Kerberos or NTLM). Target will be constructed as "pop/" + 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 "pop/" + 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 "pop/" + TargetHost name. |
| LoginSSPIAsync(SSPIMechanism, CancellationToken) | Logs user in using specified mechanism (Negotiate, Kerberos or NTLM). Target will be constructed as "pop/" + 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 "pop/" + 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, which expects to receive single-line response, to POP3 server (e.g. "STAT"). |
| SendCommand(String, Boolean) | Sends command, which expects to receive single-line response, to POP3 server (e.g. "STAT"). |
| SendCommandAsync(String, CancellationToken) | Sends command, which expects to receive single-line response, to POP3 server (e.g. "STAT"). |
| SendCommandAsync(String, Boolean, CancellationToken) | Sends command, which expects to receive single-line response, to POP3 server (e.g. "STAT"). |
| SendMultiLineCommand(String) | Sends command, which expects to receive multi-line response, to POP3 server (e.g. "RETR"). |
| SendMultiLineCommand(String, Boolean) | Sends command, which expects to receive multi-line response, to POP3 server (e.g. "RETR"). |
| SendMultiLineCommandAsync(String, CancellationToken) | Sends command, which expects to receive multi-line response, to POP3 server (e.g. "RETR"). |
| SendMultiLineCommandAsync(String, Boolean, CancellationToken) | Sends command, which expects to receive multi-line response, to POP3 server (e.g. "RETR"). |
| StartTLS | Sends 'STLS' command and initializes SSL/TLS connection (issues CAPA command afterwards). Not all servers support STLS. You can check which extensions remote server supports using SupportedExtensions method. |
| StartTLSAsync | Sends 'STLS' command and initializes SSL/TLS connection (issues CAPA command afterwards). Not all servers support STLS. You can check which extensions remote server supports using SupportedExtensions method. |
| STLS | Sends 'STLS' command and initializes SSL/TLS connection (issues CAPA command afterwards). Not all servers support STLS. You can check which extensions remote server supports using SupportedExtensions method. |
| STLSAsync | Sends 'STLS' command and initializes SSL/TLS connection (issues CAPA command). |
| SupportedAuthenticationMethods | Lists authentication methods supported by the remote POP3 server. |
| SupportedExtensions | Lists extensions supported by the remote POP3 server (e.g. STLS, TOP) |
| TcpKeepAlive |
Turns TCP protocol keep alive (SO_KEEPALIVE) option on.
(Inherited from ClientBase) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| UseBestLogin | Logs user in using best method available. When no SASL capability is found, this method switches to SSL/TLS (STLS) and tries again. |
| UseBestLoginAsync | Logs user in using best method available. When no SASL capability is found, this method switches to SSL/TLS (STLS) and tries again. |
Events| Name | Description | |
|---|---|---|
 | ServerCertificateValidate |
Event which is called for custom server certificate validation.
(Inherited from ClientBase) |
Fields| Name | Description | |
|---|---|---|
  | DefaultPort | Default POP3 protocol port (110). If you need to use different port please use port parameter in Connect(String, Int32) or Connect(String, Int32, Boolean) method. |
| DefaultSSLPort | Default POP3 protocol over SSL/TLS port (995). If you need to use different port please use use port parameter in ConnectSSL(String, Int32) or Connect(String, Int32, Boolean) method. |
See Also