Click or drag to resize

ImapClient Class

Represents mail client that can be used for manipulating folders and retrieving messages using Internet Mail Access Protocol (IMAP).
Inheritance Hierarchy
SystemObject
  GemBox.Email.ImapImapClient

Namespace:  GemBox.Email.Imap
Assembly:  GemBox.Email (in GemBox.Email.dll) Version: 11.3.30.1016
Syntax
public sealed class ImapClient : IDisposable

The ImapClient type exposes the following members.

Constructors
  NameDescription
Public methodImapClient(String)
Initializes new instance of ImapClient class with specified host address.
Public methodImapClient(String, Boolean)
Initializes new instance of ImapClient class with specified host address and option to ignore SSL certificate errors.
Public methodImapClient(String, ConnectionSecurity, Boolean)
Initializes new instance of ImapClient class with specified host address, ConnectionSecurity option and option to ignore SSL certificate errors.
Public methodImapClient(String, Int32, ConnectionSecurity, RemoteCertificateValidationCallback)
Initializes new instance of ImapClient class with specified host address and port, ConnectionSecurity option and host certificate validation delegate method.
Top
Properties
  NameDescription
Public propertyHost
Gets the server address.
Public propertyIdleEnabled
Gets whether or not IDLE mode is enabled.
Public propertyIsAuthenticated
Gets whether or not client is authenticated.
Public propertyIsConnected
Gets whether or not client is connected to remote server.
Public propertyLogOutput
Gets or sets the log output writer.
Public propertyPort
Gets the server IP port.
Public propertySecurity
Gets the current connection security mode.
Public propertySelectedFolder
Gets the currently selected IMAP folder.
Public propertySupportedAuthentications
Gets collection of supported authentication mechanisms.
Public propertySupportedCapabilities
Gets the collection of supported capabilities.
Top
Methods
  NameDescription
Public methodAddMessageFlags(Int32, IEnumerableString)
Adds the message flags.
Public methodAddMessageFlags(Int32, String)
Adds the message flags.
Public methodAddMessageFlags(String, IEnumerableString)
Adds the message flags.
Public methodAddMessageFlags(String, String)
Adds the message flags.
Public methodAddMessageRangeFlags(Int32, Int32, IEnumerableString)
Adds the flags to specified range of messages.
Public methodAddMessageRangeFlags(Int32, Int32, String)
Adds the flags to specified range of messages.
Public methodAuthenticate(String, String)
Authenticates client with specified user name and password.
Public methodAuthenticate(String, String, ImapAuthentication)
Authenticates client with specified user name, password and ImapAuthentication mechanism.
Public methodCloseSelectedFolder
Closes the currently selected folder.
Public methodConnect
Connects to the server.
Public methodCreateFolder
Creates new folder with specified name.
Public methodDeleteFolder
Deletes the specified folder.
Public methodDeleteMessage(Int32, Boolean)
Deletes the specified message.
Public methodDeleteMessage(String, Boolean)
Deletes the specified message.
Public methodDeleteMessageRange
Deletes the specified messages.
Public methodDisconnect
Disconnects client from the server.
Public methodDispose
Disconnects client from the server and disposes all used resources.
Public methodExpunge
Expunges the selected folder.
Public methodGetFolderStatus
Gets the status of specified folder.
Public methodGetHeaders(Int32)
Gets the headers for the specified message.
Public methodGetHeaders(String)
Gets the headers for the specified message.
Public methodGetMessage(Int32)
Gets the specified message.
Public methodGetMessage(String)
Gets the specified message.
Public methodGetMessageFlags(Int32)
Gets the message flags.
Public methodGetMessageFlags(String)
Gets the message flags.
Public methodGetMessageRange
Gets the collection of specified messages.
Public methodIdleDisable
Disables IDLE mode.
Public methodIdleEnable
Enables IDLE mode with the refresh interval set to 29 minutes.
Public methodIdleEnable(Int32)
Enables IDLE mode with the specified refresh interval.
Public methodKeepAlive
Executes NOOP command.
Public methodListFolders
Lists all folders on the server.
Public methodListMessages
Lists all messages in the selected folder.
Public methodListMessages(Int32, Int32)
Lists specified range of messages in the selected folder.
Public methodListSubscribedFolders
Lists all subscribed folders on the server.
Public methodMoveMessage(Int32, String)
Moves the specified message to another folder.
Public methodMoveMessage(String, String)
Moves the specified message to another folder.
Public methodMoveMessageRange
Moves the specified range of messages to another folder.
Public methodRemoveMessageFlags(Int32, IEnumerableString)
Removes the message flags.
Public methodRemoveMessageFlags(Int32, String)
Removes the message flags.
Public methodRemoveMessageFlags(String, IEnumerableString)
Removes the message flags.
Public methodRemoveMessageFlags(String, String)
Removes the message flags.
Public methodRemoveMessageRangeFlags(Int32, Int32, IEnumerableString)
Removes the flags from specified range of messages.
Public methodRemoveMessageRangeFlags(Int32, Int32, String)
Removes the flags from specified range of messages.
Public methodRenameFolder
Renames the folder.
Public methodSaveMessage(Int32, Stream)
Saves the specified message to a stream.
Public methodSaveMessage(Int32, String)
Saves the specified message to a file.
Public methodSaveMessage(String, Stream)
Saves the specified message to a stream.
Public methodSaveMessage(String, String)
Saves the specified message to a file.
Public methodSearchMessageNumbers
Searches for messages on the server that match the specified criteria.
Public methodSearchMessageUids
Searches for messages on the server that match the specified criteria.
Public methodSelectFolder
Selects the specified folder.
Public methodSelectInbox
Selects INBOX folder.
Public methodSetMessageFlags(Int32, IEnumerableString)
Sets the message flags.
Public methodSetMessageFlags(Int32, String)
Sets the message flags.
Public methodSetMessageFlags(String, IEnumerableString)
Sets the message flags.
Public methodSetMessageFlags(String, String)
Sets the message flags.
Public methodSetMessageRangeFlags(Int32, Int32, IEnumerableString)
Sets the flags to specified range of messages.
Public methodSetMessageRangeFlags(Int32, Int32, String)
Sets the flags to specified range of messages.
Public methodSubscribeFolder
Adds specified folder to the subscribed folders list.
Public methodUndeleteMessage(Int32)
Undeletes the specified message.
Public methodUndeleteMessage(String)
Undeletes the specified message.
Public methodUndeleteMessageRange
Undeletes the specified messages.
Public methodUndeleteMessages
Undeletes all the messages marked for deletion.
Public methodUnsubscribeFolder
Removes specified folder the from subscribed folders list.
Top
Events
  NameDescription
Public eventTerminated
Occurs when connection with server is terminated.
Top
Remarks
ImapClient is implemented according to RFC 3501.
See Also