PopClient Class |
Represents mail client that can be used for retrieving messages using Post Office Protocol (POP).
Inheritance HierarchyNamespace: GemBox.Email.Pop
Assembly: GemBox.Email (in GemBox.Email.dll) Version: 13.0.35.1019
SyntaxThe PopClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PopClient(String) |
Initializes new instance of PopClient class with specified host address.
|
| PopClient(String, Boolean) |
Initializes new instance of PopClient class with specified host address, ConnectionSecurity option and option to ignore SSL certificate errors.
|
| PopClient(String, Int32) |
Initializes new instance of PopClient class with specified host address and port number.
|
| PopClient(String, ConnectionSecurity, Boolean) |
Initializes new instance of PopClient class with specified host address, ConnectionSecurity option and option to ignore SSL certificate errors.
|
| PopClient(String, Int32, ConnectionSecurity) |
Initializes new instance of PopClient class with specified host address, port number and ConnectionSecurity option.
|
| PopClient(String, Int32, ConnectionSecurity, RemoteCertificateValidationCallback) |
Initializes new instance of PopClient class with specified host address, port number, ConnectionSecurity option and host certificate validation delegate method.
|
Properties| Name | Description | |
|---|---|---|
 | ConnectTimeout |
Gets or sets the connect timeout.
|
| Host |
Gets the server address.
|
| IsAuthenticated |
Gets whether or not client is authenticated.
|
| IsConnected |
Gets whether or not client is connected to the server.
|
| LogOutput |
Gets or sets the log output writer.
|
| Port |
Gets the server IP port.
|
| ReadTimeout |
Gets or sets the read timeout.
|
| Security |
Gets the current connection security mode.
|
| SupportedAuthentications |
Gets collection of supported authentication mechanisms.
|
| SupportedCapabilities |
Gets the collection of supported capabilities.
|
| WriteTimeout |
Gets or sets the write timeout.
|
Methods| Name | Description | |
|---|---|---|
| Authenticate(String, String) |
Authenticates client with specified user name and password.
|
| Authenticate(String, String, PopAuthentication) |
Authenticates client with specified user name, password and PopAuthentication mechanism.
|
| Connect |
Connects to the server.
|
| DeleteMessage(Int32) |
Deletes the specified message.
|
| DeleteMessage(String) |
Deletes the specified message.
|
| Disconnect |
Disconnects client from the server.
|
| Dispose |
Disconnects client from the server and disposes all used resources.
|
| GetCount |
Gets the count of messages available on the server.
|
| GetHeaders(Int32) |
Gets the headers for the specified message.
|
| GetHeaders(String) |
Gets the headers for the specified message.
|
| GetMessage(Int32) |
Gets the specified message.
|
| GetMessage(String) |
Gets the specified message.
|
| GetSize |
Gets the size of all message available on the server.
|
| KeepAlive |
Executes NOOP command.
|
| ListMessages |
Lists all available messages on the server.
|
| ListMessages(Boolean) |
Lists all available messages on the server.
|
| SaveMessage(Int32, Stream) |
Saves the specified message to a stream.
|
| SaveMessage(Int32, String) |
Saves the specified message to a file.
|
| SaveMessage(String, Stream) |
Saves the specified message to a stream.
|
| SaveMessage(String, String) |
Saves the specified message to a file.
|
| UndeleteMessages |
Undeletes all messages.
|
Events| Name | Description | |
|---|---|---|
 | Terminated |
Occurs when connection with server is terminated.
|
RemarksPopClient is implemented according to RFC 1939.
See Also