LumiSoft Net Help
POP3_Client Class
Namespaces ► LumiSoft.Net.POP3.Client ► POP3_Client
POP3 Client. Defined in RFC 1939.
Declaration Syntax

C# | Visual Basic | Visual C++ | F#

    public class POP3_Client : TCP_Client

    Public Class POP3_Client
    	Inherits TCP_Client

    public ref class POP3_Client : public TCP_Client

    type POP3_Client =
        class
            inherit TCP_Client
        end

Members

All Members | Constructors | Methods | Properties
Public Protected | Instance Static | Declared Inherited

Icon | Member | Description
--- | --- | ---
| POP3_Client()()()() | Default constructor.
| Auth(AUTH_SASL_Client) | Sends AUTH command to POP3 server.
| AuthAsync(POP3_Client..::..AuthAsyncOP) | Starts sending AUTH command to POP3 server.
| Authenticate(String, String, Boolean) | Obsolete. Authenticates user.
| AuthenticatedUserIdentity | Gets session authenticated user identity, returns null if not authenticated. (Overrides TCP_Session.AuthenticatedUserIdentity.)
| BeginAuthenticate(String, String, Boolean, AsyncCallback, Object) | Obsolete. Starts authentication.
| BeginConnect(String, Int32, AsyncCallback, Object) | Obsolete. Starts connection to the specified host. (Inherited from TCP_Client.)
| BeginConnect(String, Int32, Boolean, AsyncCallback, Object) | Obsolete. Starts connection to the specified host. (Inherited from TCP_Client.)
| BeginConnect(IPEndPoint, Boolean, AsyncCallback, Object) | Obsolete. Starts connection to the specified remote end point. (Inherited from TCP_Client.)
| BeginConnect(IPEndPoint, IPEndPoint, Boolean, AsyncCallback, Object) | Obsolete. Starts connection to the specified remote end point. (Inherited from TCP_Client.)
| BeginDisconnect(AsyncCallback, Object) | Starts disconnecting connection. (Inherited from TCP_Client.)
| BeginNoop(AsyncCallback, Object) | Obsolete. Starts sending NOOP command to server. This method can be used for keeping connection alive(not timing out).
| BeginReset(AsyncCallback, Object) | Obsolete. Starts resetting session. Messages marked for deletion will be unmarked.
| BeginStartTLS(AsyncCallback, Object) | Obsolete. Starts switching to SSL.
| Capa()()()() | Executes CAPA command.
| CapaAsync(POP3_Client..::..CapaAsyncOP) | Starts sending CAPA command to POP3 server.
| Connect(String, Int32) | Connects to the specified host. If the hostname resolves to more than one IP address, all IP addresses will be tried for connection, until one of them connects. (Inherited from TCP_Client.)
| Connect(String, Int32, Boolean) | Connects to the specified host. If the hostname resolves to more than one IP address, all IP addresses will be tried for connection, until one of them connects. (Inherited from TCP_Client.)
| Connect(IPEndPoint, Boolean) | Connects to the specified remote end point. (Inherited from TCP_Client.)
| Connect(IPEndPoint, IPEndPoint, Boolean) | Connects to the specified remote end point. (Inherited from TCP_Client.)
| Connect(IPEndPoint, IPEndPoint, Boolean, RemoteCertificateValidationCallback) | Connects to the specified remote end point. (Inherited from TCP_Client.)
| ConnectAsync(TCP_Client..::..ConnectAsyncOP) | Starts connecting to remote end point. (Inherited from TCP_Client.)
| ConnectTime | Gets the time when session was connected. (Inherited from TCP_Client.)
| Disconnect()()()() | Closes connection to POP3 server. (Overrides TCP_Client.Disconnect()()()().)
| Dispose()()()() | Clean up any resources being used. (Overrides TCP_Client.Dispose()()()().)
| EndAuthenticate(IAsyncResult) | Obsolete. Ends a pending asynchronous authentication request.
| EndConnect(IAsyncResult) | Obsolete. Ends a pending asynchronous connection request. (Inherited from TCP_Client.)
| EndDisconnect(IAsyncResult) | Ends a pending asynchronous disconnect request. (Inherited from TCP_Client.)
| EndNoop(IAsyncResult) | Obsolete. Ends a pending asynchronous Noop request.
| EndReset(IAsyncResult) | Obsolete. Ends a pending asynchronous reset request.
| EndStartTLS(IAsyncResult) | Obsolete. Ends a pending asynchronous StartTLS request.
| Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
| ExtendedCapabilities | Gets POP3 exteneded capabilities supported by POP3 server.
| ExtenededCapabilities | Obsolete. Gets POP3 exteneded capabilities supported by POP3 server.
| 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 a hash function for a particular type. (Inherited from Object.)
| GetType()()()() | Gets the Type of the current instance. (Inherited from Object.)
| GreetingText | Gets greeting text which was sent by POP3 server.
| ID | Gets session ID. (Inherited from TCP_Client.)
| IsAuthenticated | Gets if this session is authenticated. (Inherited from TCP_Session.)
| IsConnected | Gets if TCP client is connected. (Inherited from TCP_Client.)
| IsDisposed | Gets if this object is disposed. (Inherited from TCP_Client.)
| IsSecureConnection | Gets if this session TCP connection is secure connection. (Inherited from TCP_Client.)
| IsUidlSupported | Gets if POP3 server supports UIDL command.
| LastActivity | Gets the last time when data was sent or received. (Inherited from TCP_Client.)
| LocalEndPoint | Gets session local IP end point. (Inherited from TCP_Client.)
| LogAddException(String, Exception) | Logs exception. (Inherited from TCP_Client.)
| LogAddRead(Int64, String) | Logs read operation. (Inherited from TCP_Client.)
| LogAddText(String) | Logs free text entry. (Inherited from TCP_Client.)
| LogAddWrite(Int64, String) | Logs write operation. (Inherited from TCP_Client.)
| Logger | Gets or sets TCP client logger. Value null means no logging. (Inherited from TCP_Client.)
| Login(String, String) | Executes USER/PASS command.
| LoginAsync(POP3_Client..::..LoginAsyncOP) | Starts executing USER/PASS command.
| MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.)
| Messages | Gets messages collection.
| Noop()()()() | Send NOOP command to server. This method can be used for keeping connection alive(not timing out).
| NoopAsync(POP3_Client..::..NoopAsyncOP) | Starts sending NOOP command to POP3 server.
| OnConnected(TCP_Client..::..CompleteConnectCallback) | This method is called when TCP client has sucessfully connected. (Overrides TCP_Client.OnConnected(TCP_Client..::..CompleteConnectCallback).)
| OnConnected()()()() | This method is called after TCP client has sucessfully connected. (Inherited from TCP_Client.)
| OnError(Exception) | Obsolete. This must be called when unexpected error happens. When inheriting TCP_Client class, be sure that you call OnError method for each unexpected error. (Inherited from TCP_Client.)
| ReadLine()()()() | Reads and logs specified line from connected host. (Inherited from TCP_Client.)
| RemoteEndPoint | Gets session remote IP end point. (Inherited from TCP_Client.)
| Reset()()()() | Obsolete. Resets session. Messages marked for deletion will be unmarked.
| Rset()()()() | Resets session. Messages marked for deletion will be unmarked.
| RsetAsync(POP3_Client..::..RsetAsyncOP) | Starts sending RSET command to POP3 server.
| StartTLS()()()() | Obsolete. Switches POP3 connection to SSL.
| Stls(RemoteCertificateValidationCallback) | Executes STLS command.
| StlsAsync(POP3_Client..::..StlsAsyncOP) | Starts sending STLS command to POP3 server.
| SwitchToSecure()()()() | Switches session to secure connection. (Inherited from TCP_Client.)
| SwitchToSecureAsync(TCP_Client..::..SwitchToSecureAsyncOP) | Starts switching connection to secure. (Inherited from TCP_Client.)
| TcpStream | Gets TCP stream which must be used to send/receive data through this session. (Inherited from TCP_Client.)
| Timeout | Gets or sets default TCP read/write timeout. (Inherited from TCP_Client.)
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.)
| ValidateCertificateCallback | Gets or stes remote callback which is called when remote server certificate needs to be validated. Value null means not sepcified. (Inherited from TCP_Client.)
| WriteLine(String) | Sends and logs specified line to connected host. (Inherited from TCP_Client.)

Examples

| Copy
--- | ---
    /*
     To make this code to work, you need to import following namespaces:
     using LumiSoft.Net.Mail;
     using LumiSoft.Net.POP3.Client;
     */

    using(POP3_Client c = new POP3_Client()){
        c.Connect("ivx",WellKnownPorts.POP3);
        c.Login("test","test");
        // Or Auth(sasl-method);

        // Get first message if there is any
        if(c.Messages.Count > 0){
            // Do your suff

            // Parse message
            Mail_Message m = Mail_Message.Parse(c.Messages[0].MessageToByte());
            string subject = m.Subject;
            // ...
        }
    }

Inheritance Hierarchy

Object
| TCP_Session
|  | TCP_Client
|  |  | POP3_Client

Assembly: LumiSoft.Net (Module: LumiSoft.Net.dll) Version: 4.5.5510.19119