| Pop3 Class |
Namespace: MailBee.Pop3Mail
The Pop3 type exposes the following members.
| Name | Description | |
|---|---|---|
| Pop3 |
Creates an instance of Pop3 class.
| |
| Pop3(String) |
Creates and unlocks an instance of Pop3 class.
|
| Name | Description | |
|---|---|---|
| Abort |
Forces MailBee to cancel all pending operations and close all opened connections
as soon as possible.
| |
| BeginConnect | Obsolete.
Begins an asynchronous request for a connecting to a POP3 server.
| |
| BeginDeleteMessage | Obsolete.
Begins an asynchronous request for flagging the specified message for deletion from the server.
| |
| BeginDeleteMessages | Obsolete.
Begins an asynchronous request for flagging the specified range of messages for deletion from the server.
| |
| BeginDisconnect | Obsolete.
Begins an asynchronous request for a disconnection from the server.
| |
| BeginDownloadMessage | Obsolete.
Begins an asynchronous request for downloading the specified message header or entire message from the server.
| |
| BeginDownloadMessages | Obsolete.
Begins an asynchronous request for downloading the entire or partial messages in the specified range from the server.
| |
| BeginExecuteCustomCommand | Obsolete.
Begins an asynchronous request for sending the specified user-defined command to the server and getting the response.
| |
| BeginLogin | Obsolete.
Begins an asynchronous request for a logging in an account on a POP3 server.
| |
| BeginStartTls | Obsolete.
Begins an asynchronous request to start TLS/SSL negotiation with the server.
| |
| Connect(String) |
Connects to a POP3 server on the standard POP3 port (110).
| |
| Connect(String, Int32) |
Connects to a POP3 server.
| |
| Connect(String, Int32, Boolean) |
Connects to a POP3 server.
| |
| ConnectAsync(String) |
async/await version of Connect(String).
| |
| ConnectAsync(String, Int32) |
async/await version of Connect(String, Int32).
| |
| ConnectAsync(String, Int32, Boolean) |
async/await version of Connect(String, Int32, Boolean).
| |
| DeleteMessage |
Flags the specified message for deletion from the server.
| |
| DeleteMessageAsync |
async/await version of DeleteMessage(Int32).
| |
| DeleteMessages |
Flags all the messages in the inbox for deletion from the server.
| |
| DeleteMessages(Int32, Int32) |
Flags the specified range of messages for deletion from the server.
| |
| DeleteMessagesAsync |
async/await version of DeleteMessages.
| |
| DeleteMessagesAsync(Int32, Int32) |
async/await version of DeleteMessages(Int32, Int32).
| |
| Disconnect |
Disconnects from the POP3 server and releases any used resources.
| |
| DisconnectAsync |
async/await version of Disconnect.
| |
| Dispose |
Closes opened network connections (if any) and releases any used system resources.
| |
| Dispose(Boolean) |
When overridden in a derived class, must release unmananged and optionally managed
resources used by the component.
| |
| DownloadEntireMessage |
Completely downloads the specified message from the server.
| |
| DownloadEntireMessageAsync |
async/await version of DownloadEntireMessage(Int32).
| |
| DownloadEntireMessages |
Completely downloads all the messages from the inbox on the server.
| |
| DownloadEntireMessages(Int32, Int32) |
Completely downloads the messages in the specified range from the server.
| |
| DownloadEntireMessagesAsync |
async/await version of DownloadEntireMessages.
| |
| DownloadEntireMessagesAsync(Int32, Int32) |
async/await version of DownloadEntireMessages(Int32, Int32).
| |
| DownloadMessageHeader(Int32) |
Downloads the header of the specified message from the server.
| |
| DownloadMessageHeader(Int32, Int32) |
Downloads the header and the specified number of body lines of the message on the server.
| |
| DownloadMessageHeaderAsync(Int32) |
async/await version of DownloadMessageHeader(Int32).
| |
| DownloadMessageHeaderAsync(Int32, Int32) |
async/await version of DownloadMessageHeader(Int32, Int32).
| |
| DownloadMessageHeaders |
Downloads headers of all messages in the inbox on the server.
| |
| DownloadMessageHeaders(Int32, Int32) |
Downloads the header of each message in the specified range from the server.
| |
| DownloadMessageHeaders(Int32, Int32, Int32) |
Downloads the header and the specified number of body lines of each message in the specified range from the server.
| |
| DownloadMessageHeadersAsync |
async/await version of DownloadMessageHeaders.
| |
| DownloadMessageHeadersAsync(Int32, Int32) |
async/await version of DownloadMessageHeaders(Int32, Int32).
| |
| DownloadMessageHeadersAsync(Int32, Int32, Int32) |
async/await version of DownloadMessageHeaders(Int32, Int32, Int32).
| |
| EndConnect |
Ends the pending asynchronous connection request.
| |
| EndDeleteMessage |
Ends the pending asynchronous request for flagging the message for deletion.
| |
| EndDeleteMessages |
Ends the pending asynchronous request for flagging the range of messages for deletion.
| |
| EndDisconnect |
Ends a pending asynchronous disconnection request.
| |
| EndDownloadMessage |
Ends the pending asynchronous request for downloading the message and returns
the downloaded message.
| |
| EndDownloadMessages |
Ends the pending asynchronous request for downloading the messages and returns
the downloaded messages.
| |
| EndExecuteCustomCommand |
Ends the pending asynchronous request for sending user-defined command to the server.
| |
| EndLogin |
Ends the pending asynchronous login request.
| |
| EndStartTls |
Ends a pending asynchronous TLS/SSL negotiation request.
| |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
| ExecuteCustomCommand |
Sends user-defined command to the server and receives the server response to this command.
| |
| ExecuteCustomCommandAsync |
async/await version of ExecuteCustomCommand(String, Boolean).
| |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
| GetErrorDescription |
Returns a textual description of the last error.
| |
| GetExtension |
Returns the name or parameters of the specified POP3 capability.
| |
| GetExtensions |
Returns a reference to the key-value list of the server capabilities.
| |
| GetExtensionsAsync |
async/await version of GetExtensions.
| |
| GetExtensionValue |
Returns the parameters of the specified POP3 capability, or an empty string
if the capability has no parameters.
| |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
| GetMessageIndexFromUid |
Gets the message number of the message to which the specified Unique-ID is assigned.
| |
| GetMessageSize |
Gets the length (in bytes) of the specified message in the inbox.
| |
| GetMessageSizes |
Gets the array of lengths (in bytes) of all messages in the inbox. The array is zero-based.
| |
| GetMessageSizesAsync |
async/await version of GetMessageSizes.
| |
| GetMessageUidFromIndex |
Gets the Unique-ID string assigned to the specified message in the inbox on the server.
| |
| GetMessageUids |
Gets the array of Unique-ID's of all messages in the inbox. The array is zero-based.
| |
| GetMessageUidsAsync |
async/await version of GetMessageUids.
| |
| GetServerResponse |
Returns the last response from the server.
| |
| GetSocket |
Returns the underlying Socket MailBee uses for the
current network connection.
| |
| GetSocketError |
Returns a Win32 error code of the last socket-related error.
| |
| GetStream |
Returns the underlying Stream MailBee uses for the
current network connection.
| |
| GetSupportedAuthMethods |
Returns a set of flags indicating which authentication methods are supported by the server.
| |
| GetSupportedAuthMethodsAsync |
async/await version of GetSupportedAuthMethods.
| |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| Last |
Gets the message number of the last message ever accessed in this mailbox during actual
or all prior POP3 sessions.
| |
| LastAsync |
async/await version of Last.
| |
| Login(String, String) |
Logs in a mailbox on the POP3 server.
| |
| Login(String, String, AuthenticationMethods) |
Logs in a mailbox on the POP3 server.
| |
| Login(String, String, AuthenticationMethods, AuthenticationOptions, SaslMethod) |
Logs in a mailbox on the POP3 server.
| |
| Login(String, String, String, String, AuthenticationMethods, AuthenticationOptions, SaslMethod) |
Logs in a mailbox on the POP3 server.
| |
| LoginAsync(String, String) |
async/await version of Login(String, String).
| |
| LoginAsync(String, String, AuthenticationMethods) |
async/await version of Login(String, String, AuthenticationMethods).
| |
| LoginAsync(String, String, AuthenticationMethods, AuthenticationOptions, SaslMethod) |
async/await version of Login(String, String, AuthenticationMethods, AuthenticationOptions, SaslMethod).
| |
| LoginAsync(String, String, String, String, AuthenticationMethods, AuthenticationOptions, SaslMethod) |
async/await version of Login(String, String, String, String, AuthenticationMethods, AuthenticationOptions, SaslMethod).
| |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
| Noop |
Sends a NOOP command to the server.
| |
| Noop2 |
Sends a command to the POP3 server to keep the connection alive.
| |
| Noop2Async |
async/await version of Noop2.
| |
| NoopAsync |
async/await version of Noop.
| |
| OnConnected |
Used by MailBee to raise Connected event.
| |
| OnDataReceived |
Used by MailBee to raise DataReceived event.
| |
| OnDataSent |
Used by MailBee to raise DataSent event.
| |
| OnDisconnected |
Used by MailBee to raise Disconnected event.
| |
| OnErrorOccurred |
Used by MailBee to raise ErrorOccurred event.
| |
| OnHostResolved |
Used by MailBee to raise HostResolved event.
| |
| OnLoggedIn |
Used by MailBee to raise LoggedIn event.
| |
| OnLogNewEntry |
Used by MailBee to raise LogNewEntry event.
| |
| OnLowLevelDataReceived |
Used by MailBee to raise LowLevelDataReceived event.
| |
| OnLowLevelDataSent |
Used by MailBee to raise LowLevelDataSent event.
| |
| OnMessageDataChunkReceived |
Used by MailBee to raise MessageDataChunkReceived event.
| |
| OnMessageDownloaded |
Used by MailBee to raise MessageDownloaded event.
| |
| OnSocketConnected |
Used by MailBee to raise SocketConnected event.
| |
| OnSocketCreating |
Used by MailBee to raise SocketCreating event.
| |
| OnTlsStarted |
Used by MailBee to raise TlsStarted event.
| |
| QuickDownloadMessage(String, String, String, Int32) |
Completely downloads the specified message from the server,
in a single line of code.
| |
| QuickDownloadMessage(String, String, String, Int32, Int32) |
Downloads the specified message (entire message or message header only) from the server,
in a single line of code.
| |
| QuickDownloadMessages(String, String, String) |
Completely downloads all the messages in the inbox on the server,
in a single line of code.
| |
| QuickDownloadMessages(String, String, String, Int32) |
Downloads all the messages (entire messages or message headers only) in the inbox on the server,
in a single line of code.
| |
| ResetDeletes |
Resets the POP3 session, and cancels the deleted status for all messages
flagged for deletion in the inbox.
| |
| ResetDeletesAsync |
async/await version of ResetDeletes.
| |
| ResetState |
Resets the internal state of the component.
| |
| StartTls |
Requests the mail server to start TLS/SSL negotiation and protect the existing connection with a security layer.
| |
| StartTlsAsync |
async/await version of StartTls.
| |
| ToString | Returns a string that represents the current object. (Inherited from Object.) | |
| Wait | Obsolete.
Waits until the currently running (if any) asynchronous method is finished.
| |
| Wait(Int32) | Obsolete.
Waits the completion of the currently running (if any) asynchronous method
for the specified amount of time.
|
| Name | Description | |
|---|---|---|
| EnableLastDownloaded |
Gets or sets whether MailBee should save currently downloaded messages in LastDownloadedMessages property.
| |
| InboxMessageCount |
Gets the number of messages in the inbox.
| |
| InboxPreloadOptions |
Gets or sets the status of whether MailBee will download the list of message
sizes and/or the list of message lengths during logging in the inbox.
| |
| InboxSize |
Gets the total size (in bytes) occupied by all the messages in the inbox.
| |
| IsAborted |
Indicates whether Abort method has been called for the component.
| |
| IsBusy |
Indicates whether the component is performing a lengthy operation.
| |
| IsConnected |
Indicates whether the component is connected to the server.
| |
| IsLoggedIn |
Indicates whether the component has already successfully authenticated on the server
and logged in the user account.
| |
| IsSslConnection |
Indicates whether the current connection (if any) iss secured with TLS/SSL layer.
| |
| LastDownloadedMessages |
Gets the collection of the messages downloaded to the current moment.
| |
| LastResult |
Gets a numeric code of the last error.
| |
| LicenseKey | Obsolete.
Assigns the license key.
| |
| Log |
Gets the object used for logging MailBee activities into a file or memory buffer.
| |
| Proxy |
Provides access to the settings which allow MailBee to connect to a mail server via a proxy server.
| |
| RaiseEvents |
Gets or sets whether the component will raise any events.
| |
| RaiseEventsViaMessageLoop |
Gets or sets whether the events will be raised on the message loop of the application
or not.
| |
| RequestEncoding |
Gets or sets the encoding used to convert a string into a bytes stream
which is then sent to the server.
| |
| ResponseEncoding |
Gets or sets the encoding used to convert a byte data received from the server into a string.
| |
| Site |
Gets or sets the object to be used as a site for the component.
| |
| SslCertificates |
Provides access to the client and server SSL certificate settings.
| |
| SslMode |
Gets or sets how the component should establish TLS/SSL connection with the mail server.
| |
| SslProtocol |
Gets or sets the security protocol to be used for performing TLS/SSL negotiation and data encryption.
| |
| SynchronizingObject |
Gets or sets the object used to marshal the calls of the event handlers.
| |
| ThrowExceptions |
Gets or sets whether the component will throw exceptions on errors.
| |
| Timeout |
Gets or sets the amount of time (in milliseconds) the component will wait for a response from the server.
| |
| TrialDaysLeft |
Gets the number of days left to the date of the trial license key expiration.
| |
| Version |
Gets the version of the MailBee assembly.
|
| Name | Description | |
|---|---|---|
| Connected |
Occurs when the connection with the server is successfully established.
| |
| DataReceived |
Occurs when data is received from the POP3 server.
| |
| DataSent |
Occurs when data is sent to the POP3 server.
| |
| Disconnected |
Occurs when the connection with the server gets closed.
| |
| Disposed |
Occurs after the component was disposed.
| |
| ErrorOccurred |
Occurs when the MailBeeException is thrown.
| |
| HostResolved |
Occurs when the POP3 server name is successully resolved into IP address(es).
| |
| LoggedIn |
Occurs when the component successfully authenticates the user on the server and logs
in the user account.
| |
| LogNewEntry | ||
| LowLevelDataReceived |
Occurs when data is received from the connected socket.
| |
| LowLevelDataSent |
Occurs when data is sent to the connected socket.
| |
| MessageDataChunkReceived |
Occurs on progress of downloading message source data from the server.
| |
| MessageDownloaded |
Occurs when a message was downloaded from the server.
| |
| SocketConnected |
Occurs when the POP3 server accepts the connection attempt and opens the transmission
channel between the remote host (POP3 server) and the client (MailBee).
| |
| SocketCreating |
Occurs when MailBee needs a new socket object for establishing a connection with the POP3 server.
| |
| TlsStarted |
Occurs when the connection with the server becomes secure.
|
// To use the code below, import MailBee namespaces at the top of your code using MailBee; using MailBee.Pop3Mail; using MailBee.Mime; // The actual code (put it into a method of your class). Pop3 pop = new Pop3(); pop.Connect("mail.domain.com"); pop.Login("jdoe", "secret"); MailMessageCollection msgs = pop.DownloadMessageHeaders(1, 10); foreach (MailMessage msg in msgs) { Console.WriteLine("From: " + msg.From.Email + ", To: " + msg.To.AsString + ", Subject: " + msg.Subject); } pop.Disconnect();