ImapClient
Contents
[
Hide
]ImapClient class
Inherits: Aspose::Email::Clients::EmailClient
Allows applications to access and manipulate messages by using the Internet Message Access Protocol (IMAP).
Constructors
| Name | Description |
|---|---|
| ImapClient (19 overloads) | Initializes a new instance of the ImapClient class |
Methods
| Name | Description |
|---|---|
| AddMessageFlags (28 overloads) | Adds the flags to the message |
| AppendMessage (8 overloads) | Uploads the mail message to the current folder If current folder hasn’t been specified default folder is used. |
| AppendMessages (4 overloads) | Uploads the mail message to the current folder If current folder hasn’t been specified default folder is used. |
| Backup (4 overloads) | Backups the content of the specified folders |
| BeginAddMessageFlags (84 overloads) | Adds the flags to the message asynchronously |
| BeginAppendMessage (16 overloads) | Begins append message to the end of the specified folder If current folder hasn’t been specified default folder is used. |
| BeginAppendMessages (16 overloads) | Begins append message to the end of the specified folder If current folder hasn’t been specified default folder is used. |
| BeginBackup (12 overloads) | Begins to backup the content of the specified folders |
| BeginChangeMessageFlags (84 overloads) | Changes the flags of the message |
| BeginClientCapabilities (6 overloads) | Notifies server which extensions are supported by client asyncronously. Please note, this operation works only in case if server supports RFC5161 See more https://tools.ietf.org/html/rfc5161 |
| BeginCommitDeletes (28 overloads) | Begins to commit the deletions |
| BeginCopyMessage (12 overloads) | Begins an asynchronous copying. |
| BeginCopyMessages (30 overloads) | Begins copy operation asynchronously. |
| BeginCreateFolder (6 overloads) | Begins an asynchronous folder creation. |
| BeginDeleteFolder (6 overloads) | Begins an asynchronous folder deletion. |
| BeginDeleteMessage (36 overloads) | Marks a message with the specified sequence number as deleted asynchronously |
| BeginDeleteMessages (96 overloads) | Marks a message with the specified sequence number as deleted asynchronously |
| BeginExistFolder (6 overloads) | Check whether this folder exists |
| BeginFetchAttachment (6 overloads) | Begins fetch an attachment. |
| BeginFetchMessage (18 overloads) | Begins an asynchronous message fetching. |
| BeginFetchMessages (12 overloads) | Begins FetchMessages operation asynchronously |
| BeginGetFolderInfo (6 overloads) | Begins an asynchronous folder listing. |
| BeginGetMessageThreads (2 overloads) | Begins getting message threads asynchronously. |
| BeginGetNamespaces (6 overloads) | Begins getting namespaces that are available on a server asynchronously. |
| BeginGetQuota (6 overloads) | Begins getting quota information |
| BeginGetQuotaRoot (6 overloads) | Begins getting quota root information for mailbox |
| BeginIntroduceClient (12 overloads) | Begins introduce client information to a server asynchronously. |
| BeginListAttachments (2 overloads) | |
| BeginListFolders (30 overloads) | Begins to get the list of folders in the mailbox |
| BeginListMessage (24 overloads) | Begins to get information about a message. |
| BeginListMessages (44 overloads) | Begins getting the list of messages asynchronously in the current folder |
| BeginListMessagesByPage (2 overloads) | Begins getting the list of messages asynchronously |
| BeginLogin (6 overloads) | Begins to sign in to a server |
| BeginLogout (6 overloads) | Begins to sign in to a server |
| BeginMoveFolder (6 overloads) | Moves specified folder and its subfolders to new location asynchronously. |
| BeginMoveMessage (24 overloads) | Begins an asynchronous moving. |
| BeginMoveMessages (60 overloads) | Begins an asynchronous moving. |
| BeginNoop (6 overloads) | Begins to execute ‘No operation’ command |
| BeginRemoveMessageFlags (84 overloads) | Removes the flags of the message asynchronously |
| BeginRenameFolder (6 overloads) | Begins RenameFolder operation asynchronously |
| BeginRequestCheckpoint (6 overloads) | Begins request a checkpoint of the currently selected mailbox. |
| BeginRestore | Begins to restore imap folders from the given personal storage. |
| BeginSaveMessage (24 overloads) | Begins SaveMessage operation asynchronously |
| BeginSelectFolder (8 overloads) | Begins select the specified folder asynchronously. |
| BeginSetQuota (6 overloads) | Begins setting quota information |
| BeginSortMessageThreads (2 overloads) | Begins sorting message threads asynchronously. |
| BeginSubscribeFolder (6 overloads) | Begins subscribe operation that adds the specified mailbox name to the server’s set of “active” mailboxes. |
| BeginUndeleteMessage (24 overloads) | Marks a message with the specified sequence number as not deleted. |
| BeginUnselectFolder (12 overloads) | Begins permanently removes all messages marked as deleted for currently selected folder and removes selected-state for current folder asyncronously. |
| BeginUnsubscribeFolder (6 overloads) | Begins unsubscribe operation that removes the specified mailbox name from the server’s set of “active” mailboxes |
| BeginValidateCredentials (6 overloads) | Begins to execute credentials validation |
| ChangeMessageFlags (28 overloads) | Changes the flags of the message |
| ClientCapabilities (2 overloads) | Notifies server which extensions are supported by client. Please note, this operation works only in case if server supports RFC5161 See more https://tools.ietf.org/html/rfc5161 |
| CommitDeletes (10 overloads) | Commit the deletions |
| ConnectionFinalize | Performs finalization operation for specified connection |
| CopyMessage (4 overloads) | Copies the message |
| CopyMessages (11 overloads) | Copy messages |
| CreateFolder (2 overloads) | Creates a folder with the specified name |
| DeleteFolder (2 overloads) | Deletes a specified folder. This method represents IMAP DELETE command |
| DeleteMessage (12 overloads) | Marks a message with the specified sequence number as deleted |
| DeleteMessages (32 overloads) | Marks a message with the specified sequence number as deleted |
| Dispose | Finalizes all operations with a server. |
| EndAddMessageFlags | Waits for the pending asynchronous operation to complete. |
| EndAppendMessage | Waits for the pending asynchronous operation to complete. |
| EndAppendMessages | Waits for the pending asynchronous operation to complete. |
| EndBackup | Waits for the pending asynchronous operation to complete. |
| EndChangeMessageFlags | Waits for the pending asynchronous operation to complete. |
| EndClientCapabilities | Waits for the pending asynchronous operation to complete. Please note, this operation works only in case if server supports RFC5161 See more https://tools.ietf.org/html/rfc5161 |
| EndCommitDeletes | Waits for the pending asynchronous operation to complete. |
| EndCopyMessage | Waits for the pending asynchronous operation to complete. |
| EndCopyMessages | Waits for the pending asynchronous operation to complete. |
| EndCreateFolder | Waits for the pending asynchronous folder creation to complete. |
| EndDeleteFolder | Waits for the pending asynchronous folder deletion to complete. |
| EndDeleteMessage | Waits for the pending asynchronous message deletion to complete. |
| EndDeleteMessages | Waits for the pending asynchronous message deletion to complete. |
| EndExistFolder (2 overloads) | Waits for the pending asynchronous operation to complete. |
| EndFetchAttachment | Waits for the asynchronous operation to complete. |
| EndFetchMessage | Waits for the pending asynchronous message fetching to complete. |
| EndFetchMessages | Waits for the asynchronous operation to complete. |
| EndGetFolderInfo | Waits for the pending asynchronous folder listing to complete. |
| EndGetMessageThreads | Waits for the pending asynchronous folder deletion to complete. |
| EndGetNamespaces | Waits for the pending asynchronous operation to complete. |
| EndGetQuota | Waits for the pending asynchronous operation to complete. |
| EndGetQuotaRoot | Waits for the pending asynchronous operation to complete. |
| EndIntroduceClient | Waits for the pending asynchronous operation to complete. |
| EndListAttachments | |
| EndListFolders | Waits for the pending asynchronous operation to complete. |
| EndListMessage | Waits for the asynchronous ListMessage operation to complete. |
| EndListMessages | Waits for the asynchronous ListMessages operation to complete. |
| EndListMessagesByPage | Waits for the asynchronous ListMessagesByPage operation to complete. |
| EndLogin | Waits for the pending asynchronous operation to complete. |
| EndLogout | Waits for the pending asynchronous operation to complete. |
| EndMoveFolder | Waits for completion of the asynchronous operation. |
| EndMoveMessage | Waits for the pending asynchronous operation to complete. |
| EndMoveMessages | Waits for the pending asynchronous operation to complete. |
| EndNoop | Waits for the pending asynchronous operation to complete. |
| EndRemoveMessageFlags | Waits for the pending asynchronous operation to complete. |
| EndRenameFolder | Waits for the asynchronous operation to complete. |
| EndRequestCheckpoint | Waits for the pending asynchronous operation to complete. |
| EndRestore | Waits for the pending asynchronous operation to complete. |
| EndSaveMessage | Waits for the asynchronous operation to complete. |
| EndSelectFolder | Waits for the pending asynchronous message fetching to complete. |
| EndSetQuota | Waits for the pending asynchronous operation to complete. |
| EndSortMessageThreads | Waits for the pending asynchronous folder deletion to complete. |
| EndSubscribeFolder | Waits for the pending asynchronous operation to complete. |
| EndUndeleteMessage | Waits for the pending asynchronous operation to complete. |
| EndUnselectFolder | Waits for the pending asynchronous operation to complete. |
| EndUnsubscribeFolder | Waits for the pending asynchronous operation to complete. |
| EndValidateCredentials | Waits for the pending asynchronous operation to complete. |
| ExistFolder (4 overloads) | Check whether this folder exists |
| FetchAttachment (2 overloads) | Fetches the specified attachment |
| FetchMessage (6 overloads) | Fetches the message |
| FetchMessages (4 overloads) | Fetches the messages |
| get_AllowedAuthentication | Gets enumeration of allowed by user authentication types |
| get_AnnotateSupported | Gets information whether ANNOTATE extension is supported See more: https://tools.ietf.org/html/rfc5257 |
| get_AutoCommit | Indicates, whether commit operation are executed automatically when folder is changed or before connection is closed. |
| get_ChildrenSupported | Gets information whether CHILDREN extension is supported See more: https://tools.ietf.org/html/rfc3348 |
| get_ClientIdentificationInfo | Gets client identification information See more: https://tools.ietf.org/html/rfc2971 |
| get_CompressSupported | Gets information whether COMPRESS extension is supported See more: https://tools.ietf.org/html/rfc4978 |
| get_CondstoreSupported | Gets information whether CONDSTORE extension is supported See more: https://tools.ietf.org/html/rfc7162 |
| get_CurrentFolder | Gets the current folder |
| get_DefaultFolder | Default folder for ImapClients |
| get_DefaultPort | Gets default port for client |
| get_Delimiter | Gets delimiter of folders hierarhy. |
| get_EnableSupported | Gets information whether ENABLE extension is supported See more: https://tools.ietf.org/html/rfc5161 |
| get_ESearchSupported | Gets information whether ESEARCH extension is supported See more: https://tools.ietf.org/html/rfc4731 |
| get_ExchangeIdAutomatically | Gets value which indicates whether client should to introduce information about itself to a server automatically. See more: https://tools.ietf.org/html/rfc2971 |
| get_ExtendedListSupported | Gets information whether LIST Command Extension is supported See more https://tools.ietf.org/html/rfc5258 |
| get_GmExt1Supported | Defines if Google X-GM-EXT-1 extension is supported |
| get_IdSupported | Gets information whether ID extension is supported See more: https://tools.ietf.org/html/rfc2971 |
| get_MailboxInfo | Gets set of special-use mailboxes See more: http://tools.ietf.org/html/rfc6154 and https://tools.ietf.org/html/rfc8457 |
| get_MoveSupported | Gets information whether MOVE extension is supported See more: https://tools.ietf.org/html/rfc6851 |
| get_NamespaceSupported | Gets information whether NAMESPACE extension is supported See more: https://tools.ietf.org/html/rfc2342 |
| get_Pool | Gets connection pool for the client |
| get_QresyncSupported | Gets information whether QRESYNC extension is supported See more: https://tools.ietf.org/html/rfc7162 |
| get_QuotaSupported | Gets information whether quota is supported |
| get_ReadOnly | Gets value which indicates if changes to the permanent state of the mailbox, including per-user state, are permitted. |
| get_SaslIrSupported | Gets information whether SASL Initial Client Response extension is supported See more: https://tools.ietf.org/html/rfc4959 |
| get_SelectedCompression | Gets compression type which is used to communicate with a server. See more: https://tools.ietf.org/html/rfc4978 |
| get_ServerIdentificationInfo | Gets server identification information See more: https://tools.ietf.org/html/rfc2971 |
| get_ServerSupportedCompression | Gets information which compression types are supported by a server. See more: https://tools.ietf.org/html/rfc4978 |
| get_SortSupported | Gets information whether Sort command are supported |
| get_SpecialUseSupported | Gets information whether Special-Use Mailboxes is supported See more: https://tools.ietf.org/html/rfc6154 |
| get_SupportedAuthentication | Gets enumeration of supported by server authentication types |
| get_SupportOldServer | Indicates whether the old servers need to be supported when receiving messages. |
| get_ThreadAlgorithms | Gets supported thread algorithms |
| get_ThreadSupported | Gets information whether Thread command are supported |
| get_UidPlusSupported | Gets information whether UIDPLUS extension is supported See more: https://tools.ietf.org/html/rfc4315 |
| get_UnselectSupported | Gets information whether UNSELECT extension is supported See more: https://tools.ietf.org/html/rfc2342 |
| GetFolderInfo (2 overloads) | Returns information about the specified folder without selecting it |
| GetMessageThreads (2 overloads) | Get message threads. |
| GetNamespaces (2 overloads) | Gets namespaces that are available on a server. |
| GetQuota (2 overloads) | Gets quota information |
| GetQuotaRoot (2 overloads) | Gets quota root information for mailbox |
| IntroduceClient (4 overloads) | Introduces client information to a server. |
| ListAttachments (2 overloads) | Gets the message attachments list. Gets an information for each attachment in message. |
| ListFolders (10 overloads) | Gets the list of folders in the mailbox |
| ListMessage (8 overloads) | Gets information about a message. |
| ListMessages (27 overloads) | Gets the list of messages in the current folder |
| ListMessagesByPage (4 overloads) | Gets the list of messages |
| Login (2 overloads) | Sign in to a server |
| Logout (2 overloads) | Sign in to a server |
| MoveFolder (2 overloads) | Moves specified folder and its subfolders to new location. |
| MoveMessage (8 overloads) | Moves the message |
| MoveMessages (20 overloads) | Moves the message |
| NeedSupportOldServers | |
| Noop (3 overloads) | ‘No operation’ command |
| RemoveMessageFlags (28 overloads) | Removes the flags of the message |
| RenameFolder (2 overloads) | Renames a specified folder to a new name |
| RequestCheckpoint (2 overloads) | Requests a checkpoint of the currently selected mailbox. |
| Restore | Begins to restore imap folders from the given personal storage. |
| ResumeMonitoring | Resumes monitoring of message changes for specified folder. Unlike the StartMonitoring method, it will find all missing mailbox changes and call the callback for them. |
| SaveMessage (8 overloads) | Downloads the message with the specified sequence number and writes its data into a supplied stream |
| SelectFolder (4 overloads) | Selects the specified folder |
| set_AllowedAuthentication | Sets enumeration of allowed by user authentication types |
| set_AnnotateSupported | Gets information whether ANNOTATE extension is supported See more: https://tools.ietf.org/html/rfc5257 |
| set_AutoCommit | Indicates, whether commit operation are executed automatically when folder is changed or before connection is closed. |
| set_ChildrenSupported | Gets information whether CHILDREN extension is supported See more: https://tools.ietf.org/html/rfc3348 |
| set_ClientIdentificationInfo | Sets client identification information See more: https://tools.ietf.org/html/rfc2971 |
| set_CompressSupported | Gets information whether COMPRESS extension is supported See more: https://tools.ietf.org/html/rfc4978 |
| set_CondstoreSupported | Gets information whether CONDSTORE extension is supported See more: https://tools.ietf.org/html/rfc7162 |
| set_CurrentFolder | Gets the current folder |
| set_DefaultFolder | Default folder for ImapClients |
| set_Delimiter | Sets delimiter of folders hierarhy. |
| set_EnableSupported | Gets information whether ENABLE extension is supported See more: https://tools.ietf.org/html/rfc5161 |
| set_ESearchSupported | Gets information whether ESEARCH extension is supported See more: https://tools.ietf.org/html/rfc4731 |
| set_ExchangeIdAutomatically | Sets value which indicates whether client should to introduce information about itself to a server automatically. See more: https://tools.ietf.org/html/rfc2971 |
| set_ExtendedListSupported | Gets information whether LIST Command Extension is supported See more https://tools.ietf.org/html/rfc5258 |
| set_GmExt1Supported | Defines if Google X-GM-EXT-1 extension is supported |
| set_IdSupported | Gets information whether ID extension is supported See more: https://tools.ietf.org/html/rfc2971 |
| set_MoveSupported | Gets information whether MOVE extension is supported See more: https://tools.ietf.org/html/rfc6851 |
| set_NamespaceSupported | Gets information whether NAMESPACE extension is supported See more: https://tools.ietf.org/html/rfc2342 |
| set_QresyncSupported | Gets information whether QRESYNC extension is supported See more: https://tools.ietf.org/html/rfc7162 |
| set_QuotaSupported | Gets information whether quota is supported |
| set_ReadOnly | Sets value which indicates if changes to the permanent state of the mailbox, including per-user state, are permitted. |
| set_SaslIrSupported | Gets information whether SASL Initial Client Response extension is supported See more: https://tools.ietf.org/html/rfc4959 |
| set_SelectedCompression | Sets compression type which is used to communicate with a server. See more: https://tools.ietf.org/html/rfc4978 |
| set_SortSupported | Gets information whether Sort command are supported |
| set_SpecialUseSupported | Gets information whether Special-Use Mailboxes is supported See more: https://tools.ietf.org/html/rfc6154 |
| set_SupportOldServer | Indicates whether the old servers need to be supported when receiving messages. |
| set_ThreadSupported | Gets information whether Thread command are supported |
| set_UidPlusSupported | Gets information whether UIDPLUS extension is supported See more: https://tools.ietf.org/html/rfc4315 |
| set_UnselectSupported | Gets information whether UNSELECT extension is supported See more: https://tools.ietf.org/html/rfc2342 |
| SetQuota (2 overloads) | Sets quota information |
| SortMessageThreads (2 overloads) | Get message threads. |
| StartMonitoring | Starts monitoring of message changes for specified folder. |
| StopMonitoring (2 overloads) | Stops any monitoring of changes. |
| SubscribeFolder (2 overloads) | Sent the SUBSCRIBE command that adds the specified mailbox name to the server’s set of “active” mailboxes. |
| UndeleteMessage (8 overloads) | Marks a message with the specified sequence number as not deleted |
| UnselectFolder (4 overloads) | Permanently removes all messages marked as deleted for currently selected folder and removes selected-state for this folder. |
| UnsubscribeFolder (2 overloads) | Sent the UNSUBSCRIBE command that removes the specified mailbox name from the server’s set of “active” mailboxes |
| ValidateCredentials (2 overloads) | Executes credentials validation |