MailBee.NET Objects 7.1

Pop3 Members

Pop3 overview

Public Static Properties

LicenseKeyObsolete. Assigns the license key.

Public Static Methods

QuickDownloadMessageOverloaded. Downloads the specified message (entire message or message header only) from the server, in a single line of code.
QuickDownloadMessagesOverloaded. Downloads all the messages (entire messages or message headers only) in the inbox on the server, in a single line of code.

Public Instance Constructors

Pop3 Constructor Initializes a new instance of the Pop3 class.

Public Instance Properties

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.
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.

Public Instance Methods

Abort Forces MailBee to cancel all pending operations and close all opened connections as soon as possible.
BeginConnect Begins an asynchronous request for a connecting to a POP3 server.
BeginDeleteMessage Begins an asynchronous request for flagging the specified message for deletion from the server.
BeginDeleteMessages Begins an asynchronous request for flagging the specified range of messages for deletion from the server.
BeginDisconnect Begins an asynchronous request for a disconnection from the server.
BeginDownloadMessage Begins an asynchronous request for downloading the specified message header or entire message from the server.
BeginDownloadMessages Begins an asynchronous request for downloading the entire or partial messages in the specified range from the server.
BeginExecuteCustomCommand Begins an asynchronous request for sending the specified user-defined command to the server and getting the response.
BeginLogin Begins an asynchronous request for a logging in an account on a POP3 server.
BeginStartTls Begins an asynchronous request to start TLS/SSL negotiation with the server.
ConnectOverloaded. Connects to a POP3 server.
DeleteMessage Flags the specified message for deletion from the server.
DeleteMessagesOverloaded. Flags messages for deletion from the server.
Disconnect Disconnects from the POP3 server and releases any used resources.
DisposeOverloaded. Closes opened network connections (if any) and releases any used system resources.
DownloadEntireMessage Completely downloads the specified message from the server.
DownloadEntireMessagesOverloaded. Completely downloads all or the specified messages from the server.
DownloadMessageHeaderOverloaded. Downloads the header of the specified message from the server.
DownloadMessageHeadersOverloaded. Downloads headers of all or the specified messages from the server.
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 (inherited from Object) Determines whether the specified Object is equal to the current Object.
ExecuteCustomCommand Sends user-defined command to the server and receives the server response to this command.
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.
GetExtensionValue Returns the parameters of the specified POP3 capability, or an empty string if the capability has no parameters.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
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.
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.
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.
GetSupportedAuthMethods Returns a set of flags indicating which authentication methods are supported by the server.
GetType (inherited from Object) Gets the Type of the current instance.
Last Gets the message number of the last message ever accessed in this mailbox during actual or all prior POP3 sessions.
LoginOverloaded. Logs in a mailbox on the POP3 server.
Noop Sends a NOOP command to the server.
Noop2 Sends a command to the POP3 server to keep the connection alive.
ResetDeletes Resets the POP3 session, and cancels the deleted status for all messages flagged for deletion in the inbox.
ResetState Resets the internal state of the component.
StartTls Requests the mail server to start TLS/SSL negotiation and protect the connection with security layer.
ToString (inherited from Object) Returns a String that represents the current Object.
WaitOverloaded. Waits until the currently running (if any) asynchronous method is finished.

Public Instance Events

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 Occurs when an entry is written into the log file (or into the memory buffer if Pop3.Log.MemoryLog is true).
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).
TlsStarted Occurs when the connection with the server becomes secure.

Protected Instance Methods

DisposeOverloaded. When overridden in a derived class, must release unmananged and optionally managed resources used by the component.
Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

Protected Internal Instance Methods

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.
OnTlsStarted Used by MailBee to raise TlsStarted event.

See Also

Pop3 Class | MailBee.Pop3Mail Namespace