MailBee.NET Objects 4.0

Imap Members

Imap overview

Public Static Fields

AllMessages Specifies the message set (sequence) which includes all messages in the folder.

Public Static Properties

LicenseKey Sets the license key to be used to unlock MailBee.NET IMAP4 component.

Public Static Methods

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

Public Instance Constructors

Imap Constructor Initializes a new instance of the Imap class.

Public Instance Properties

EnableLastDownloaded Gets or sets whether MailBee should save currently downloaded envelopes in LastDownloadedEnvelopes property.
Flags Gets the flags that are applicable for the currently selected folder.
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.
IsFolderSelected Indicates if a folder is currently selected in the mail account.
IsIdle Gets if the component is in IDLE state.
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) if secured with TLS/SSL layer.
LastDownloadedEnvelopes Gets the collection of the envelopes 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.
MessageCount Gets the number of messages in the currently selected folder.
PermanentFlags Gets the flags the client can change permanently.
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.
RecentCount Gets the number of recent messages in the currently selected folder.
RequestEncoding Gets or sets the encoding used to convert a string into a bytes stream which is then sent to the mail server.
ResponseEncoding Gets or sets the encoding used to convert a byte data received from the mail 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.
UidNext Gets the UID to be assigned to the next message in the currently selected folder.
UidValidity Gets the UIDVALIDITY value of the currently selected folder.
Unseen Gets the ordinal message number of the first message which does not have "\Seen" flag set.
Utf7EncodeFolderNames Gets or sets whether MailBee should automatically encode folder names with UTF-7 Modified encoding.
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.
BeginClose Begins an asynchronous request for closing (unselecting) the currently selected folder and optional removing of messages marked as deleted from this folder.
BeginConnect Begins an asynchronous request for a connecting to an IMAP4 server.
BeginCopyOrMoveMessages Begins an asynchronous request for copying or moving the specified messages from the currently selected folder to the specified folder.
BeginDisconnect Begins an asynchronous request for a disconnection from the mail server.
BeginDownloadEnvelopes Begins an asynchronous request for downloading the specified message elements (envelopes, flags, body structures, entire messages or message headers, etc) from the currently selected folder.
BeginDownloadFolders Begins an asynchronous request for downloading IMAP folders matching the specified criteria.
BeginExecuteCustomCommand Begins an asynchronous request for sending the specified user-defined command to the server and getting the response.
BeginIdle Begins an asynchronous request for starting idling mode.
BeginLogin Begins an asynchronous request for a logging in an account on an IMAP4 server.
BeginSearch Begins an asynchronous request for searching the currently selected folder for messages meeting the specified criteria.
BeginSelectFolder Begins an asynchronous request for selecting a folder in an account on an IMAP4 server.
BeginSetMessageFlags Begins an asynchronous request to set or reset the specified message flags for the specified messages in the currently selected folder.
BeginSortedSearch Begins an asynchronous request for searching the currently selected folder for messages meeting the specified criteria and sorting them accordingly the specified sort condition.
BeginStartTls Begins an asynchronous request to start TLS/SSL negotiation with the server.
BeginUploadMessage Begins an asynchronous request for uploading the message into the specified folder on the server.
CloseOverloaded. Unselects the currently selected folder and optionally removes all messages having \Deleted flag set from the folder.
ConnectOverloaded. Connects to an IMAP4 server.
CopyMessagesOverloaded. Copies the specified messages from the currently selected folder to the specified folder, and retrieves UIDs assigned to the copied messages in the destination folder.
CreateFolder Creates a new folder (mailbox in IMAP4 terms) in the IMAP4 account.
DeleteFolder Deletes an existing folder (mailbox in IMAP4 terms) from the IMAP4 account.
DeleteMessages Marks the specified messages in the currently selected folder as deleted.
Disconnect Disconnects from the IMAP4 server and releases any used resources.
DisposeOverloaded. Closes all opened network connections (if any) and releases any used system resources.
DownloadEntireMessage Completely downloads the specified message from the server.
DownloadEntireMessages Completely downloads the specified messages from the server.
DownloadEnvelopesOverloaded. Fetches message envelopes, bodies, headers, flags, attributes, and other message-related information from the server.
DownloadFoldersOverloaded. Downloads the list of IMAP folders matching the specified criteria.
DownloadMessageHeaders Downloads the header of each message in the specified set from the server.
EndClose Ends the pending asynchronous close folder request.
EndConnect Ends the pending asynchronous connection request.
EndCopyOrMoveMessages Ends a pending asynchronous request for copying or moving messages.
EndDisconnect Ends a pending asynchronous disconnection request.
EndDownloadEnvelopes Ends the pending asynchronous download envelopes request.
EndDownloadFolders Ends the pending asynchronous download folders request.
EndExecuteCustomCommand Ends the pending asynchronous request for sending user-defined command to the server.
EndIdle Ends the pending asynchronous request for idling termination.
EndLogin Ends the pending asynchronous login request.
EndSearch Ends the pending asynchronous search request.
EndSelectFolder Ends the pending asynchronous select folder request.
EndSetMessageFlags Ends a pending asynchronous setting message flags request.
EndSortedSearch Ends the pending asynchronous sorted search request.
EndStartTls Ends a pending asynchronous TLS/SSL negotiation request.
EndUploadMessage Ends the pending asynchronous upload message request.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
ExamineFolder Selects the specified folder (mailbox in IMAP4 terms) for read-only access.
ExecuteCustomCommand Sends user-defined command to the server and receives the server response to this command.
ExpungeOverloaded. Permanently removes the messages marked as deleted from the currently selected folder.
GetAccountQuota Gets the quota (resource usage limit) of the entire mail account on the server.
GetErrorDescription Returns a textual description of the last occurred error.
GetExtension Returns the name of the specified IMAP4 capability if it's supported by the mail server.
GetExtensions Returns a reference to the key-value list of the mail server capabilities.
GetFolderQuota Gets the quota (resource usage limit) of the specified folder.
GetFolderSize Downloads the size of each message in the currently selected folder and returns the total size occupied by all messages in this folder.
GetFolderStatus Gets the status of the specified folder without selecting it.
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.
GetServerResponse Returns the last response from the server.
GetServerResponses Returns the specified individual responses from the last group of responses received 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.
Idle Attempts to start idling mode which makes the client wait for any notifications from the server regarding the currently selected folder.
LoginOverloaded. Logs in a mail account on the IMAP4 server.
MoveMessagesOverloaded. Moves the specified messages from the currently selected folder to the specified folder, and retrieves UIDs assigned to the moved messages in the destination folder.
Noop Sends a NOOP command to the mail server.
RenameFolder Renames an existing folder (mailbox in IMAP4 terms) of the IMAP4 account.
ResetState Resets the internal state of the component.
SearchOverloaded. Searches the currently selected folder for messages that meet the specified criteria.
SelectFolder Selects the specified folder (mailbox in IMAP4 terms) for read-write access.
SetMessageFlagsOverloaded. Sets or resets the specified flags for the specified messages in the currently selected folder.
SortedSearch Searches the currently selected folder for messages that meet the specified criteria and returns them as a collection sorted by the specified condition.
StartTls Requests the mail server to start TLS/SSL negotiation and protect the connection with security layer.
StopIdle Notifies MailBee to terminate idling when appropriate.
SubscribeFolder Subscribes to the specified folder (mailbox in IMAP4 terms) of the IMAP4 account.
ToString (inherited from Object) Returns a String that represents the current Object.
UnsubscribeFolder Unsubscribes the previously subscribed folder (mailbox in IMAP4 terms) of the IMAP4 account.
UploadMessageOverloaded. Uploads a mail message to the specified folder, assigns the specified date and flags to this message, and retrieves UID assigned to the uploaded message by the server.
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 IMAP4 server.
DataSent Occurs when data is sent to the IMAP4 server.
Disconnected Occurs when the connection with the server gets closed.
Disposed Occurs after the component was disposed.
EnvelopeDataChunkReceived Occurs on progress of downloading FETCH responses (containing message source data, envelopes, and other message-related information) from the server.
EnvelopeDownloaded Occurs when a FETCH response is received from the IMAP4 server and the method which receives mail messages or envelopes (such as DownloadEnvelopes) is in progress.
ErrorOccurred Occurs when the MailBeeException is thrown.
HostResolved Occurs when the IMAP4 server name is successfully resolved into IP address(es).
Idling Ticks every 10 milliseconds while in idle state.
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 Imap.Log.MemoryLog is true).
LowLevelDataReceived Occurs when data is received from the connected socket.
LowLevelDataSent Occurs when data is sent to the connected socket.
MessageStatus Occurs when the IMAP4 server informs the client of any changes to mail messages in the currently selected folder.
ServerStatus Occurs when the IMAP4 server reports mailbox or server status information to the client.
SocketConnected Occurs when the IMAP4 server accepts the connection attempt and opens the transmission channel between the remote host (IMAP4 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 unmanaged 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.
OnEnvelopeDataChunkReceived Used by MailBee to raise EnvelopeDataChunkReceived event.
OnEnvelopeDownloaded Used by MailBee to raise EnvelopeDownloaded event.
OnErrorOccurred Used by MailBee to raise ErrorOccurred event.
OnHostResolved Used by MailBee to raise HostResolved event.
OnIdling Used by MailBee to raise Idling 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.
OnMessageStatus Used by MailBee to raise MessageStatus event.
OnServerStatus Used by MailBee to raise ServerStatus event.
OnSocketConnected Used by MailBee to raise SocketConnected event.
OnTlsStarted Used by MailBee to raise TlsStarted event.

See Also

Imap Class | MailBee.ImapMail Namespace