The Pop3 type exposes the following members.

Constructors

  NameDescription
Public methodPop3
Initializes a new instance of the Pop3 class.

Methods

  NameDescription
Public methodAbort
Aborts the current operation.
Public methodConnect(String)
Connects to the POP3 server.
Public methodConnect(String, SslMode)
Connects to the POP3 server with the specified security. Use a port corresponding to the specified security mode.
Public methodConnect(String, Int32)
Connects to the POP3 server.
Public methodConnect(String, Int32, SslMode)
Connects to the POP3 server with the specified security.
Public methodConnect(String, Int32, TlsParameters, Pop3Security) Obsolete.
Public methodConnectAsync(String, Object)
Begins asynchronous Connect operation. Connects to the POP3 server.
Public methodConnectAsync(String, SslMode, Object)
Begins asynchronous Connect operation. Connects to the POP3 server with the specified security. Use a port corresponding to the specified security mode.
Public methodConnectAsync(String, Int32, Object)
Begins asynchronous Connect operation. Connects to the POP3 server.
Public methodConnectAsync(String, Int32, SslMode, Object)
Begins asynchronous Connect operation. Connects to the POP3 server with the specified security.
Public methodDelete
Marks a message as deleted. Messages marked as deleted will actually be deleted after a call to Disconnect()()()() method.
Public methodDeleteAsync
Begins asynchronous Delete operation. Marks a message as deleted. Messages marked as deleted will actually be deleted after a call to Disconnect()()()() method.
Public methodDisconnect()()()()
Deletes any messages marked as deleted and terminates the connection.
Public methodDisconnect(Boolean)
Deletes any messages marked as deleted and terminate the connection.
Public methodDisconnectAsync
Begins asynchronous Disconnect operation. Deletes any messages marked as deleted and terminate the connection.
Public methodDispose()()()()
Disposes the Pop3 object and all the socket objects.
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the Pop3 and optionally releases the managed resources.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Finalizer. Called by garbage collector during object destruction.
(Overrides Object..::..Finalize()()()().)
Public methodGetConnectionState
Checks whether the POP3 session is still connected and returns its state.
Public methodGetHashCode
Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
Public methodGetMailboxSize
Retrieve the size of the mailbox - the sum of lengths of all messages.
Public methodGetMailboxSizeAsync
Begins asynchronous GetMailboxSize operation. Retrieve the size of the mailbox - the sum of lengths of all messages.
Public methodGetMailMessage
Downloads a message with a specified number from the server and loads it into an instance of MailMessage.
Public methodGetMailMessageAsync
Begins asynchronous GetMailMessage operation. Downloads a message with a specified number from the server and loads it into an instance of MailMessage.
Public methodGetMessage(Int32, Stream)
Downloads the message with a specified number from the server and writes its data into a supplied stream.
Public methodGetMessage(Int32, String)
Downloads the message with a specified number from the server and writes its data into a local file.
Public methodGetMessageAsync(Int32, Stream, Object)
Begins asynchronous GetMessage operation. Downloads the message with a specified number from the server and writes its data into a supplied stream.
Public methodGetMessageAsync(Int32, String, Object)
Begins asynchronous GetMessage operation. Downloads the message with a specified number from the server and writes its data into a local file.
Public methodGetMessageCount
Retrieve the number of messages in the mailbox.
Public methodGetMessageCountAsync
Begins asynchronous GetMessageCount operation. Retrieve the number of messages in the mailbox.
Public methodGetMessageHeaders
Downloads the headers of a message with a specified number from the server and writes it into a supplied stream.
Public methodGetMessageHeadersAsync
Begins asynchronous GetMessageHeaders operation. Downloads the headers of a message with a specified number from the server and writes it into a supplied stream.
Public methodGetMessageInfo
Gets information about a message with the specified sequence number.
Public methodGetMessageInfoAsync
Begins asynchronous GetMessageInfo operation. Gets information about a message with the specified sequence number.
Public methodGetMessageList()()()()
Retrieves a list of messages in the mailbox with unique IDs and lengths.
Public methodGetMessageList(Pop3ListFields)
Retrieves a list of messages in the mailbox.
Public methodGetMessageListAsync
Begins asynchronous GetMessageList operation. Retrieves a list of messages in the mailbox.
Public methodGetMessageSequenceNumber
Converts a unique ID to sequence number. Returns the sequence number of the specified message, or null (Nothing in VB.NET) if not found.
Public methodGetMessageSequenceNumberAsync
Begins asynchronous GetMessageSequenceNumber operation. Converts a unique ID to sequence number. Returns the sequence number of the specified message, or null (Nothing in VB.NET) if not found.
Public methodGetMimeMessage
Downloads a message with a specified number from the server and loads it into an instance of MimeMessage.
Public methodGetMimeMessageAsync
Begins asynchronous GetMimeMessage operation. Downloads a message with a specified number from the server and loads it into an instance of MimeMessage.
Public methodGetSupportedAuthenticationMethods
Gets the list of supported authentication methods.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodCheckConnectionState
Checks whether the POP3 session is still connected. Throws an exception on error.
Public methodLogin(GssApiProvider)
Authenticates the user to the POP3 server using the specified GSSAPI provider. Only supported on Windows and partially on Mono.
Public methodLogin(Pop3Authentication)
Authenticates the user to the POP3 server using the specified authentication method that does not require credentials (NTLM or GSSAPI). Only supported on Windows.
Public methodLogin(String, Pop3Authentication)
Authenticates the user to the POP3 server using an OAuth token.
Public methodLogin(String, String)
Authenticates the user to the POP3 server.
Public methodLogin(String, String, Pop3Authentication)
Authenticates the user to the POP3 server using the specified authentication method.
Public methodLoginAsync(GssApiProvider, Object)
Begins asynchronous Login operation. Authenticates the user to the POP3 server using the specified GSSAPI provider. Only supported on Windows and partially on Mono.
Public methodLoginAsync(Pop3Authentication, Object)
Begins asynchronous Login operation. Authenticates the user to the POP3 server using the specified authentication method that does not require credentials (NTLM or GSSAPI). Only supported on Windows.
Public methodLoginAsync(String, Pop3Authentication, Object)
Begins asynchronous Login operation. Authenticates the user to the POP3 server using an OAuth token.
Public methodLoginAsync(String, String, Object)
Begins asynchronous Login operation. Authenticates the user to the POP3 server.
Public methodLoginAsync(String, String, Pop3Authentication, Object)
Begins asynchronous Login operation. Authenticates the user to the POP3 server using the specified authentication method.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnCommandSent
Raises the CommandSent event.
Protected methodOnResponseRead
Raises the ResponseRead event.
Protected methodOnStateChanged
Raises the StateChanged event.
Protected methodOnTlsDebug Obsolete.
Protected methodOnTransferProgress
Raises the TransferProgress event.
Public methodReadResponse
Returns a single line of response of the POP3 server to the command.
Public methodReadResponseAsync
Begins asynchronous ReadResponse operation. Returns a single line of response of the POP3 server to the command.
Public methodSecure()()()()
Secures the connection with TLS/SSL using default parameters.
Public methodSecure(TlsParameters) Obsolete.
Public methodSecureAsync
Begins asynchronous Secure operation. Secures the connection with TLS/SSL using default parameters.
Public methodSendCommand
Sends a custom command to the POP3 server.
Public methodSendCommandAsync
Begins asynchronous SendCommand operation. Sends a custom command to the POP3 server.
Public methodSetSocketFactory
Sets the socket factory to be used to create communication sockets.
Public methodToString
Returns a string representation of this object.
(Overrides Object..::..ToString()()()().)
Public methodUndelete
Unmarks any messages that have been marked as deleted.
Public methodUndeleteAsync
Begins asynchronous Undelete operation. Unmarks any messages that have been marked as deleted.

Extension Methods

  NameDescription
Public Extension MethodBeginConnect(String, AsyncCallback, Object)Overloaded.
Begins asynchronous Connect operation. Connects to the POP3 server.
(Defined by Pop3Extensions.)
Public Extension MethodBeginConnect(String, Int32, AsyncCallback, Object)Overloaded.
Begins asynchronous Connect operation. Connects to the POP3 server.
(Defined by Pop3Extensions.)
Public Extension MethodBeginConnect(String, SslMode, AsyncCallback, Object)Overloaded.
Begins asynchronous Connect operation. Connects to the POP3 server with the specified security. Use a port corresponding to the specified security mode.
(Defined by Pop3Extensions.)
Public Extension MethodBeginConnect(String, Int32, SslMode, AsyncCallback, Object)Overloaded.
Begins asynchronous Connect operation. Connects to the POP3 server with the specified security.
(Defined by Pop3Extensions.)
Public Extension MethodBeginConnect(String, Int32, TlsParameters, Pop3Security, AsyncCallback, Object)Overloaded. (Defined by Pop3Extensions.)
Public Extension MethodBeginDelete
Begins asynchronous Delete operation. Marks a message as deleted. Messages marked as deleted will actually be deleted after a call to Disconnect()()()() method.
(Defined by Pop3Extensions.)
Public Extension MethodBeginDisconnect
Begins asynchronous Disconnect operation. Deletes any messages marked as deleted and terminate the connection.
(Defined by Pop3Extensions.)
Public Extension MethodBeginGetMailboxSize
Begins asynchronous GetMailboxSize operation. Retrieve the size of the mailbox - the sum of lengths of all messages.
(Defined by Pop3Extensions.)
Public Extension MethodBeginGetMailMessage
Begins asynchronous GetMailMessage operation. Downloads a message with a specified number from the server and loads it into an instance of MailMessage.
(Defined by Pop3Extensions.)
Public Extension MethodBeginGetMessage(Int32, Stream, AsyncCallback, Object)Overloaded.
Begins asynchronous GetMessage operation. Downloads the message with a specified number from the server and writes its data into a supplied stream.
(Defined by Pop3Extensions.)
Public Extension MethodBeginGetMessage(Int32, String, AsyncCallback, Object)Overloaded.
Begins asynchronous GetMessage operation. Downloads the message with a specified number from the server and writes its data into a local file.
(Defined by Pop3Extensions.)
Public Extension MethodBeginGetMessageCount
Begins asynchronous GetMessageCount operation. Retrieve the number of messages in the mailbox.
(Defined by Pop3Extensions.)
Public Extension MethodBeginGetMessageHeaders
Begins asynchronous GetMessageHeaders operation. Downloads the headers of a message with a specified number from the server and writes it into a supplied stream.
(Defined by Pop3Extensions.)
Public Extension MethodBeginGetMessageInfo
Begins asynchronous GetMessageInfo operation. Gets information about a message with the specified sequence number.
(Defined by Pop3Extensions.)
Public Extension MethodBeginGetMessageList
Begins asynchronous GetMessageList operation. Retrieves a list of messages in the mailbox.
(Defined by Pop3Extensions.)
Public Extension MethodBeginGetMessageSequenceNumber
Begins asynchronous GetMessageSequenceNumber operation. Converts a unique ID to sequence number. Returns the sequence number of the specified message, or null (Nothing in VB.NET) if not found.
(Defined by Pop3Extensions.)
Public Extension MethodBeginGetMimeMessage
Begins asynchronous GetMimeMessage operation. Downloads a message with a specified number from the server and loads it into an instance of MimeMessage.
(Defined by Pop3Extensions.)
Public Extension MethodBeginLogin(GssApiProvider, AsyncCallback, Object)Overloaded.
Begins asynchronous Login operation. Authenticates the user to the POP3 server using the specified GSSAPI provider. Only supported on Windows and partially on Mono.
(Defined by Pop3Extensions.)
Public Extension MethodBeginLogin(Pop3Authentication, AsyncCallback, Object)Overloaded.
Begins asynchronous Login operation. Authenticates the user to the POP3 server using the specified authentication method that does not require credentials (NTLM or GSSAPI). Only supported on Windows.
(Defined by Pop3Extensions.)
Public Extension MethodBeginLogin(String, Pop3Authentication, AsyncCallback, Object)Overloaded.
Begins asynchronous Login operation. Authenticates the user to the POP3 server using an OAuth token.
(Defined by Pop3Extensions.)
Public Extension MethodBeginLogin(String, String, AsyncCallback, Object)Overloaded.
Begins asynchronous Login operation. Authenticates the user to the POP3 server.
(Defined by Pop3Extensions.)
Public Extension MethodBeginLogin(String, String, Pop3Authentication, AsyncCallback, Object)Overloaded.
Begins asynchronous Login operation. Authenticates the user to the POP3 server using the specified authentication method.
(Defined by Pop3Extensions.)
Public Extension MethodBeginReadResponse
Begins asynchronous ReadResponse operation. Returns a single line of response of the POP3 server to the command.
(Defined by Pop3Extensions.)
Public Extension MethodBeginSecure(AsyncCallback, Object)Overloaded.
Begins asynchronous Secure operation. Secures the connection with TLS/SSL using default parameters.
(Defined by Pop3Extensions.)
Public Extension MethodBeginSecure(TlsParameters, AsyncCallback, Object)Overloaded. (Defined by Pop3Extensions.)
Public Extension MethodBeginSendCommand
Begins asynchronous SendCommand operation. Sends a custom command to the POP3 server.
(Defined by Pop3Extensions.)
Public Extension MethodBeginUndelete
Begins asynchronous Undelete operation. Unmarks any messages that have been marked as deleted.
(Defined by Pop3Extensions.)
Public Extension MethodEndConnect
Ends an asynchronous BeginConnect operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndDelete
Ends an asynchronous BeginDelete operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndDisconnect
Ends an asynchronous BeginDisconnect operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndGetMailboxSize
Ends an asynchronous BeginGetMailboxSize operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndGetMailMessage
Ends an asynchronous BeginGetMailMessage operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndGetMessage
Ends an asynchronous BeginGetMessage operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndGetMessageCount
Ends an asynchronous BeginGetMessageCount operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndGetMessageHeaders
Ends an asynchronous BeginGetMessageHeaders operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndGetMessageInfo
Ends an asynchronous BeginGetMessageInfo operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndGetMessageList
Ends an asynchronous BeginGetMessageList operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndGetMessageSequenceNumber
Ends an asynchronous BeginGetMessageSequenceNumber operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndGetMimeMessage
Ends an asynchronous BeginGetMimeMessage operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndLogin
Ends an asynchronous BeginLogin operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndReadResponse
Ends an asynchronous BeginReadResponse operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndSecure
Ends an asynchronous BeginSecure operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndSendCommand
Ends an asynchronous BeginSendCommand operation.
(Defined by Pop3Extensions.)
Public Extension MethodEndUndelete
Ends an asynchronous BeginUndelete operation.
(Defined by Pop3Extensions.)

Fields

  NameDescription
Public fieldStatic memberDefaultImplicitSslPort
Default POP3/Implicit SSL port (995).
Public fieldStatic memberDefaultPort
Default POP3 port (110).

Properties

  NameDescription
Public propertyAbortTimeout
Gets or sets the length of time before the abort operation times out.
Public propertyEncoding
Gets or sets the Encoding used to encode command arguments sent to the server and decode received answers.
Protected propertyInstanceId
Gets instance ID (intended for logging purposes).
(Inherited from NetworkSession.)
Public propertyIsAuthenticated
Returns a value indicating whether the session is authenticated.
(Overrides NetworkSession..::..IsAuthenticated.)
Public propertyIsBusy
Gets a value indicating whether there any operation (method) in progress.
Public propertyIsConnected
Gets a value indicating whether the session is connected.
(Overrides NetworkSession..::..IsConnected.)
Public propertyIsSecured
Gets the value indicating whether the control connection is secured.
Public propertyLocalEndPoint
Gets the local client EndPoint.
Public propertyLogWriter
Gets or sets the LogWriter used by this object.
(Inherited from NetworkSession.)
Public propertyOptions Obsolete.
Public propertyProxy
Gets or sets the network proxy to use to access a remote server.
Public propertyRemoteEndPoint
Gets the remote server EndPoint.
Public propertyServerName
Gets the server name, if available.
(Inherited from NetworkSession.)
Public propertyServerPort
Gets the server port, if available.
(Inherited from NetworkSession.)
Public propertySettings
Gets or sets POP3 object settings.
Public propertyState
Gets the current state of the Pop3 object.
Public propertySupportedExtensions
Gets the bit field specifying the extensions supported by the server.
Public propertyTimeout
Gets or sets the length of time in milliseconds before the operation times out (specify -1 or 0 to indicate that the request does not time out).
Public propertyTlsDebugLevel Obsolete.
Public propertyTlsSocket
Returns the TLS/SSL socket of secured control connection.
Public propertyUserName
Gets the authenticated user name, if available.
(Inherited from NetworkSession.)
Public propertyStatic memberVersion
Returns the version of the POP3 component.

Events

  NameDescription
Public eventCommandSent
Occurs when a command is send to the server.
Public eventResponseRead
Occurs when a response is received from the server.
Public eventStateChanged
Occurs when the state of the Pop3 object is changed.
Public eventTlsDebug Obsolete.
Public eventTransferProgress
Occurs when data is send or received.
Public eventValidatingCertificate
Occurs when a server certificate needs to be validated.

See Also