TChilkatImap

Controls cancellation of the method currently running on this Imap object.

• Set this property to 1 to request that a long-running network operation abort.
• Short methods that do not perform lengthy processing or network communication are generally unaffected.
• Both synchronous and asynchronous calls can be aborted. A synchronous call may be canceled by setting this property from another thread.

The property is automatically reset to 0 when the abort is processed. If no method is running, it is reset when the next method begins.

Controls the initial \Seen flag when a message is appended to a mailbox.

• 1 (the default): the appended message is marked as seen.
• 0: the appended message is initially unseen.

This setting applies to append operations that do not explicitly supply message flags.

Contains the UID assigned by the server to the message most recently added by an append method.

A value of 0 means the server did not return the appended message's UID. Not all IMAP servers support reporting this value.

Selects the IMAP authentication mechanism. The default is LOGIN, and an empty string also selects the default login behavior.

The selected mechanism must be supported by the IMAP server. If NTLM authentication fails because of an NTLM-version compatibility issue, set Global.DefaultNtlmVersion to 1 and retry.

Specifies the optional authorization identity used with the PLAIN authentication mechanism.

Leave this property empty unless the IMAP server requires an authorization identity that differs from the login identity supplied to Login.

Controls whether full-message fetch operations automatically include attachment data. The default is 1.

• 1: attachments are downloaded with the message.
• 0: the message is downloaded without ordinary attachment bodies, reducing transferred data.

Header-only methods ignore this property and never download attachment bodies. Related MIME parts used by an HTML body are still downloaded. Signed or encrypted messages are always downloaded in full because the complete MIME is required for verification or decryption.

When 1 (the default), adjusts the effective TLS settings when Connect is called for the standard IMAP ports:

• Port 993: uses implicit TLS by setting Ssl to 1 and StartTls to 0.
• Port 143: sets Ssl to 0 so the connection begins as ordinary IMAP. Explicit TLS may still be requested with StartTls.

Set this property to 0 when the server uses nonstandard port and TLS combinations that must be controlled explicitly.

Specifies the local IP address to bind when the computer has multiple network interfaces or addresses.

Leave this property empty for the usual case. The operating system will select the default local interface. When set, use a numeric IP address such as 165.164.55.124, not a hostname.

Contains the hostname or IP address of the IMAP server to which the object is currently connected.

Returns an empty string when no connection is active.

The maximum number of seconds to wait while establishing the TCP connection to the IMAP server.

The default is 30 seconds. This timeout applies to connection establishment, not to later reads from the server.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

Specifies the Windows domain used for NTLM authentication.

This property is optional and may be left empty when the login name already identifies the domain or when NTLM is not used.

Enables automatic resolution of credential values from secure operating-system storage. The default is 0.

When 1, supported password arguments and properties may contain a secret specification beginning with !! instead of a literal secret. Chilkat resolves the value from Windows Credential Manager or Apple Keychain.

!![appName|]service[|domain]|username

This applies to HttpProxyPassword, SocksPassword, the password supplied to Login, and the password supplied to SshAuthenticatePw.

Sets the interval, in milliseconds, between AbortCheck event callbacks during operations that support cancellation.

The default is 0, which disables periodic AbortCheck callbacks.

Contains the HIGHESTMODSEQ value of the currently selected mailbox as a decimal string.

The value is 0 when no mailbox is selected or the server does not provide this information. A string is used because the value may exceed the integer range of some programming languages.

Specifies the authentication mechanism used by an HTTP proxy.

Valid values are Basic and NTLM. This property is used only when HttpProxyHostname identifies an HTTP proxy that requires authentication.

Specifies the optional Windows domain for HTTP-proxy NTLM authentication.

It is ignored when the proxy does not use NTLM authentication.

Specifies the hostname or numeric IPv4 address of an HTTP proxy through which the IMAP connection is established.

Leave this property empty to connect directly or to use another configured transport such as SOCKS or SSH tunneling.

Specifies the password used to authenticate with the configured HTTP proxy.

It is used only when the proxy requires authentication.

Specifies the TCP port of the configured HTTP proxy.

Common values include 8080 and 3128, but the correct value is determined by the proxy server configuration.

Specifies the username used to authenticate with the configured HTTP proxy.

It is used only when the proxy requires authentication.

Enables or disables the in-memory IMAP protocol log. The default is 0.

When enabled, SessionLog contains the raw commands sent to the server and the raw responses received. Use ClearSessionLog to reset it.

Contains the MIME source most recently sent by AppendMail or AppendMime.

This is useful for diagnostics or for examining the exact MIME submitted to the server.

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

Contains the most recent raw IMAP command sent to the server.

This property is primarily intended for diagnostics when an IMAP operation fails or produces an unexpected response.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Contains the most recent intermediate response received from the IMAP server while a command was in progress.

Use it for protocol-level diagnostics when a command involves continuations or multiple response stages.

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

Contains the raw response received for the most recent IMAP command.

The property is cleared when a new command is sent. It remains empty if the server sends no response. Use it with LastResponseCode and LastCommand when troubleshooting server behavior.

Contains the optional IMAP response code from the most recent server response.

Response codes appear inside square brackets and provide information beyond the final OK, NO, or BAD result. Examples include NONEXISTENT, AUTHENTICATIONFAILED, and UIDVALIDITY. Exact values vary by server implementation.

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

The length, in characters, of the string contained in the LastStringResult property.

Contains the username of the authenticated IMAP session.

Returns an empty string when the object is not logged in.

Contains the number of messages in the currently selected mailbox.

The value is updated by SelectMailbox and ExamineMailbox, and may also change when the server reports mailbox updates.

Controls whether fetching message content marks the message as seen.

• 0 (the default): a fetch may set the \Seen flag.
• 1: message data is fetched without setting \Seen, using IMAP peek semantics.

Sets the scale used by PercentDone event callbacks. The default is 100.

For example, a scale of 1000 gives tenths-of-a-percent precision, so a callback value of 453 represents 45.3% complete. Values are limited to the range 10 through 100000.

This property applies only to languages and environments that support event callbacks and only to operations for which progress can be measured.

Specifies the IMAP server port.

• 993 is the standard port for implicit TLS and is normally used with Ssl set to 1.
• 143 is the standard port for ordinary IMAP and for explicit TLS requested with StartTls.

When AutoFix is enabled, standard port values are used to adjust the effective TLS configuration when connecting.

Controls address-family preference when a hostname resolves to both IPv4 and IPv6 addresses.

• 0 (the default): prefer IPv4.
• 1: prefer IPv6.

The other address family may still be used when the preferred one is unavailable.

The maximum number of seconds that an incoming IMAP response may stall with no additional bytes received.

The default is 30 seconds. This is an inactivity timeout, not a limit on the total time allowed for a large response.

Controls verification of the IMAP server's TLS certificate chain.

• 0 (the default): a connection is not rejected solely because normal certificate-chain verification fails.
• 1: the connection fails when the certificate is expired, its signature is invalid, or the chain cannot be trusted.

Specifies the IMAP CHARSET used by Search and QueryMbx when search criteria contain non-ASCII characters. The default is UTF-8.

If the criteria contain only 7-bit ASCII characters, no CHARSET is needed and this property has no effect. The value AUTO enables the legacy behavior of selecting a charset by examining the criteria text.

Most applications should leave this property unchanged unless a particular server rejects non-English search text.

Contains the name of the currently selected or examined mailbox.

Returns an empty string when no mailbox is selected.

Specifies the application-level buffer size used when sending data through the underlying TCP connection.

The default is 32767 bytes. Most applications should leave this setting unchanged.

Contains the mailbox-hierarchy delimiter reported by the IMAP server, typically / or ..

MbxList and the legacy mailbox-listing methods update this property from the server's LIST response. The value is a string containing one character.

Contains the in-memory log of raw IMAP commands and server responses.

KeepSessionLog must be 1 for logging to occur. Call ClearSessionLog to remove previously collected entries.

Specifies the hostname or numeric IP address of the SOCKS proxy.

This property is used only when SocksVersion is 4 or 5.

Specifies the SOCKS5 proxy password.

It is ignored for SOCKS4 because SOCKS4 does not define password authentication.

Specifies the SOCKS proxy port. The default is 1080.

This property is used only when SocksVersion is 4 or 5.

Specifies the username sent to a SOCKS4 or SOCKS5 proxy.

This property is used only when SocksVersion is 4 or 5.

Selects whether the IMAP connection uses a SOCKS proxy.

Sets the operating system's TCP receive-buffer size. The default is 4194304 bytes.

Most applications should leave this unchanged. Increasing it may improve download throughput on high-latency or high-bandwidth networks. Values that are multiples of 4096 are recommended.

Specifies the server-side sort order used by QueryMbx. The default is an empty string, which performs an ordinary IMAP search without requesting sorting.

Provide space-separated sort keys. Sorting is ascending unless REVERSE appears immediately before a key.

• ARRIVAL
• CC
• DATE
• FROM
• SIZE
• SUBJECT
• TO

Examples include SUBJECT REVERSE DATE, REVERSE SIZE, and ARRIVAL. The server must advertise the IMAP SORT capability.

Sets the operating system's TCP send-buffer size. The default is 262144 bytes.

Most applications should leave this unchanged. Increasing it may improve upload throughput; values such as 524288 or 1048576 may be tested when needed.

Controls implicit TLS for the IMAP connection.

• 1: begin the connection with a TLS handshake, typically on port 993.
• 0: begin with ordinary IMAP. Use StartTls when the server requires an explicit STARTTLS upgrade.

Restricts the cipher suites and selected TLS security requirements offered for an IMAP TLS connection.

Leave this property empty to allow all cipher suites implemented by the installed Chilkat version. To restrict negotiation, provide a comma-separated list in preference order, for example:

TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

The server chooses from the cipher suites offered by the client; the client cannot force a suite the server does not support.

The list may also contain these policy keywords:

• rsa1024 or rsa2048 to require a minimum RSA server-key size.
• secure-renegotiation to require secure TLS renegotiation.
• best-practices to use the security policy recommended by the installed Chilkat version.

Legacy keywords such as aes256-cbc, aes128-cbc, 3des-cbc, and rc4 remain recognized for compatibility, but explicitly listing acceptable suites is preferred.

Selects the TLS protocol version or minimum version allowed for secure IMAP connections.

Supported values include default, exact versions such as TLS 1.2 and TLS 1.3, and minimum-version forms such as TLS 1.2 or higher.

The default value is default, which lets Chilkat negotiate a protocol supported by both client and server. A minimum-version setting is generally more interoperable than requiring one exact version.

Indicates whether the IMAP server's TLS certificate chain was successfully verified for the current or most recent TLS connection.

This property reports certificate-chain verification. A failed required verification prevents the connection from succeeding.

Controls explicit TLS using the IMAP STARTTLS command.

• 1: connect in clear text, issue STARTTLS, and then continue through an encrypted channel.
• 0: do not request an explicit TLS upgrade.

Explicit TLS is commonly used on port 143. For implicit TLS, set Ssl to 1 and normally use port 993.

Contains the cipher suite negotiated for the current or most recent TLS connection, for example TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384.

The value is empty before a TLS connection has been established or after a failed TLS negotiation.

Specifies one or more expected SPKI fingerprints for TLS public-key pinning. The TLS handshake fails unless the server certificate matches at least one configured pin.

The format is:

hashAlgorithm, encoding, fingerprint1, fingerprint2, ...

Example:

sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE=

Supported hash algorithms include sha1, sha256, sha384, sha512, md2, md5, haval, and the RIPEMD variants. Common encodings include base64 and hex.

Contains the protocol version negotiated for the current or most recent TLS connection, such as TLS 1.2 or TLS 1.3.

The value is empty before a TLS connection has been established or after a failed TLS negotiation.

Contains the mailbox's reported UIDNEXT value—the UID expected to be assigned to the next appended message.

The value is 0 when no mailbox is selected or when the server did not provide UIDNEXT.

Contains the UIDVALIDITY value of the currently selected mailbox, or 0 when no mailbox is selected.

An application that stores message UIDs should also store this value. If UIDVALIDITY changes in a later session, previously stored UIDs must no longer be assumed to identify the same messages.

Provides comma-separated compatibility or platform-specific options for uncommon cases. The default is an empty string, and most applications should leave it unchanged.

• ProtectFromVpn: on Android, bypasses an installed or active VPN.
• EnableTls13: legacy option that enabled offering TLS 1.3 in versions where it was not yet enabled by default.

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version of the component/library, such as "10.1.0"

Adds the PKCS #12/PFX data in the BinData in bd as a source of certificates and private keys for S/MIME processing.

password contains the PFX password. Call this method once for each additional source.

Returns 1 for success, 0 for failure.

Adds a PKCS #12/PFX source that may be searched for certificates and private keys needed for S/MIME decryption or signature processing.

pfxBytes contains the PFX bytes, and pfxPassword contains its password. Call this method once for each additional source. Common file extensions are .pfx and .p12.

Returns 1 for success, 0 for failure.

Adds a PKCS #12/PFX file that may be searched for certificates and private keys needed for S/MIME decryption or signature processing.

pfxFilePath is the local filesystem path of the PFX file, and pfxPassword contains its password. Call this method once for each additional source.

On Windows, system certificate stores are also searched automatically. On macOS, the Keychain is searched automatically.

Returns 1 for success, 0 for failure.

Appends the Email in email to the mailbox named by mailbox.

AppendSeen controls the initial \Seen flag unless flags are supplied by another append method. After a successful append, AppendUid contains the UID when the server reports it, and LastAppendedMime contains the MIME sent to the server.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the AppendMail method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Appends the MIME message in mimeText to the mailbox named by mailbox.

mimeText must contain a complete RFC 822/MIME message. After a successful append, AppendUid contains the UID when the server reports it, and LastAppendedMime contains the MIME sent.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the AppendMime method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Appends the MIME message in mimeText to the mailbox named by mailbox while explicitly setting the server-side internal date from internalDateStr.

internalDateStr is an RFC 822 date/time string, for example Fri, 10 Jul 2026 20:15:30 GMT. The internal date is mailbox metadata and is distinct from the message's Date header.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the AppendMimeWithDateStr method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Appends the MIME message in mimeText to the mailbox named by mailbox and sets its initial system flags.

• seen controls \Seen.
• flagged controls \Flagged.
• answered controls \Answered.
• draft controls \Draft.

Use 1 to set a flag and 0 to leave it unset.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the AppendMimeWithFlags method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Appends the MIME contained in the StringBuilder in sbMime to mailbox mailbox and sets its initial flags.

• seen controls \Seen.
• flagged controls \Flagged.
• answered controls \Answered.
• draft controls \Draft.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the AppendMimeWithFlagsSb method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the IMAP CAPABILITY command and returns the server's raw capability response.

Use HasCapability to test the returned text for a particular capability such as IDLE, MOVE, SORT, or QUOTA.

Returns a zero-length WideString on failure

Creates an asynchronous task to call the Capability method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Checks whether the underlying TCP socket is currently connected to the IMAP server.

This performs a low-level socket-state check and does not send an IMAP command. To verify that the server is responsive and the session remains usable, call Noop.

Clears the in-memory text returned by SessionLog.

Session logging remains enabled or disabled according to KeepSessionLog.

Closes the currently selected mailbox while keeping the IMAP connection and authenticated session open.

mailbox identifies the mailbox to close. In IMAP terminology, mailbox and folder refer to the same server-side container.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the CloseMailbox method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Establishes the TCP connection to the IMAP server identified by domainName but does not authenticate.

domainName may be a hostname, IPv4 address, or IPv6 address. Configure Port, Ssl, StartTls, proxy settings, and timeouts before calling this method. Call Login after the connection succeeds.

Connection failures can also be caused by DNS, local or remote firewalls, antivirus software, routing, or other network infrastructure outside Chilkat.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the Connect method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Copies one message from the currently selected mailbox to the destination mailbox in copyToMailbox.

msgId identifies the source message. If bUid is 1, msgId is a UID; otherwise, msgId is a sequence number. The original message remains in the selected mailbox.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the Copy method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Copies the messages identified by the MessageSet in messageSet from the selected mailbox to the destination mailbox in copyToMailbox.

The MessageSet.HasUids setting determines whether its values are UIDs or sequence numbers. The original messages remain in the selected mailbox.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the CopyMultiple method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Copies a contiguous range of messages, identified by sequence number, from the selected mailbox to the destination mailbox in copyToMailbox.

startSeqNum is the first sequence number and count is the number of messages to copy. IMAP sequence numbers begin at 1 and can change when messages are expunged.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the CopySequence method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Creates the mailbox named by mailbox on the IMAP server.

Use the hierarchy delimiter reported in SeparatorChar when creating a nested mailbox. In IMAP terminology, mailbox and folder are synonymous.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the CreateMailbox method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deletes the mailbox named by mailbox from the IMAP server.

This deletes the mailbox itself, not merely the messages it contains. Server rules may require the mailbox to be empty first.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the DeleteMailbox method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Closes the connection to the IMAP server.

A failure indicates that the connection could not be closed cleanly; the socket is nevertheless no longer intended for further use. In many applications, a disconnect failure during shutdown can be treated as nonfatal.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the Disconnect method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Opens the mailbox in mailbox as read-only.

Use this instead of SelectMailbox when the application must not change message flags or mailbox state. Successful examination updates properties such as NumMessages, UidValidity, and UidNext.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the ExamineMailbox method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Permanently removes all messages marked with the \Deleted flag from the currently selected mailbox.

Setting \Deleted alone does not remove message data; expunging commits those deletions and may change sequence numbers for the remaining messages.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the Expunge method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Permanently removes all messages marked with \Deleted from the selected mailbox and then closes the mailbox.

The authenticated IMAP connection remains available after the mailbox is closed.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the ExpungeAndClose method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Obtains attachment attachmentIndex from the Email in emailObject and writes it to the local filesystem path in saveToPath. Attachment indexes are zero-based.

If emailObject already contains the attachment bytes, the data is saved locally without contacting the IMAP server. If emailObject was fetched without attachment bodies, Chilkat uses the IMAP metadata stored in its ckx-imap-* headers to download the requested attachment.

Related MIME parts used by an HTML body are not counted as ordinary attachments. Signed and encrypted messages are fetched in full because their complete MIME is required.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the FetchAttachment method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Obtains attachment attachmentIndex from the Email in email and stores its bytes in the BinData in binData.

Attachment indexes are zero-based. See FetchAttachment for details about fetching attachment data not already present in email.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the FetchAttachmentBd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Obtains attachment attachIndex from the Email in email and returns its bytes. Attachment indexes are zero-based.

If the attachment is not already present in email, Chilkat downloads it from the IMAP server using the message metadata stored in the email. See FetchAttachment for attachment-fetching details.

Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

Creates an asynchronous task to call the FetchAttachmentBytes method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Obtains text attachment attachmentIndex from the Email in email, decodes it using the charset in charset, and stores the text in the StringBuilder in sb.

Attachment indexes are zero-based. Use this only for text attachments. See FetchAttachment for details about fetching data not already present in email.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the FetchAttachmentSb method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Obtains text attachment attachmentIndex from the Email in emailObject and decodes its bytes using the character encoding named by charset.

Use this only when the attachment contains text. Attachment indexes are zero-based. See FetchAttachment for information about downloading attachment data that is not already present in emailObject.

Returns a zero-length WideString on failure

Creates an asynchronous task to call the FetchAttachmentString method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Downloads up to count full messages beginning with sequence number seqnum.

failedSet receives sequence numbers that failed, fetchedSet receives sequence numbers fetched successfully, and downloaded messages are appended to the EmailBundle in bundle.

IMAP sequence numbers begin at 1 and may change after an expunge.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the FetchChunk2 method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Downloads one message or its headers into the Email in email.

• headerOnly = 1: download headers only.
• headerOnly = 0: download the full message.
• bUid = 1: msgId is a UID.
• bUid = 0: msgId is a sequence number.

For a full download, ordinary attachment bodies are included according to AutoDownloadAttachments.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the FetchEmail method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Returns the space-separated IMAP flags for the message identified by msgId.

If bUid is 1, msgId is a UID; otherwise, it is a sequence number. A result might be \Flagged \Seen $label1.

An empty result may mean either that the message has no flags or that it does not exist. Examine LastResponse: a final OK indicates an existing message with no flags, while NO indicates that the message set was invalid.

Returns a zero-length WideString on failure

Creates an asynchronous task to call the FetchFlags method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Downloads the messages identified by the MessageSet in msgSet and appends them to the EmailBundle in bundle.

• headersOnly = 1: download headers only.
• headersOnly = 0: download full messages, with ordinary attachments controlled by AutoDownloadAttachments.

MessageSet.HasUids determines whether msgSet contains UIDs or sequence numbers. bundle is not cleared before results are added.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the FetchMsgSet method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Downloads count messages beginning with sequence number seqnum and appends them to the EmailBundle in bundle.

• headersOnly = 1: download headers only.
• headersOnly = 0: download full messages.

IMAP sequence numbers begin at 1; passing 0 for seqnum fails. Sequence numbers can change after messages are expunged.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the FetchRange method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Downloads one message and returns its MIME source as a string.

If bUid is 1, msgId is a UID; otherwise, msgId is a sequence number. Ordinary attachment bodies are included according to AutoDownloadAttachments.

Use FetchSingleBd when the MIME must be preserved as binary data.

Returns a zero-length WideString on failure

Creates an asynchronous task to call the FetchSingleAsMime method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Downloads one message's MIME into the StringBuilder in sbMime.

If bUid is 1, msgId is a UID; otherwise, it is a sequence number. Ordinary attachment bodies are included according to AutoDownloadAttachments.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the FetchSingleAsMimeSb method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Downloads one message's MIME bytes into the BinData in mimeData.

If bUid is 1, msgId is a UID; otherwise, it is a sequence number. Ordinary attachment bodies are included according to AutoDownloadAttachments.

Use this method when the exact MIME bytes must be preserved.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the FetchSingleBd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Downloads and returns the MIME header block for one message, without downloading the body.

If bUID is 1, msgId is a UID; otherwise, msgId is a sequence number.

Returns a zero-length WideString on failure

Creates an asynchronous task to call the FetchSingleHeaderAsMime method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Returns the filename of attachment attachIndex described by the Email in email.

Attachment indexes are zero-based. This method can read attachment metadata from a header-only email even when the attachment body was not downloaded.

Returns a zero-length WideString on failure

Returns the size, in bytes, of attachment attachIndex described by the Email in email.

Attachment indexes are zero-based. This method can read attachment metadata from a header-only email.

Sends the IMAP STATUS command for the mailbox in mailbox and returns the reported values as XML attributes.

• messages: total number of messages.
• recent: messages having the \Recent flag.
• uidnext: expected UID for the next appended message.
• uidvalidity: mailbox UID-validity value.
• unseen: messages without the \Seen flag.

<status messages="240" recent="0" uidnext="3674" uidvalidity="3" unseen="213" />

Returns a zero-length WideString on failure

Creates an asynchronous task to call the GetMailboxStatus method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Returns 1 when the flag named by flagName is set on the Email in email, and 0 when it is not set.

Standard flags include \Seen, \Answered, \Flagged, \Draft, and \Deleted. Custom keywords such as $label1 or NonJunk are also supported.

The value is read from IMAP metadata stored in the email's ckx-* headers.

Returns the number of ordinary attachments described by the Email in email.

The count can be obtained from a header-only email because Chilkat stores attachment metadata in internal IMAP header fields. Related MIME parts are not counted as ordinary attachments.

Returns the complete server-reported size of the Email in email, in bytes, including attachment data.

This value may be available even when only the message headers were downloaded.

Sends the IMAP GETQUOTA command for the quota root in quotaRoot and returns the server response as JSON.

The server must advertise the IMAP QUOTA capability.

Returns a zero-length WideString on failure

Creates an asynchronous task to call the GetQuota method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the IMAP GETQUOTAROOT command for the mailbox in mailboxName and returns the server response as JSON.

The server must advertise the IMAP QUOTA capability.

Returns a zero-length WideString on failure

Creates an asynchronous task to call the GetQuotaRoot method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Stores the certificate presented by the IMAP server for the current or most recent TLS connection in the Cert object supplied as cert.

This is useful for certificate inspection, diagnostics, or implementing application-specific trust checks.

Returns 1 for success, 0 for failure.

Tests whether the capability named by name appears in the raw capability response in capabilityResponse.

capabilityResponse is typically the string returned by Capability. Capability-name matching follows IMAP capability-token semantics.

Waits up to timeoutMs milliseconds for unsolicited mailbox updates after IdleStart has entered IMAP IDLE mode.

This method does not send a polling command. It reads notifications that the server has already sent over the existing connection and returns them as XML.

• flags: flags changed for a message.
• expunge: a sequence number was removed.
• exists: the mailbox message count changed.
• recent: the recent-message count changed.
• raw: an unrecognized response line retained for diagnostics.

<idle>
  <flags seqnum="59" uid="11876">
    <flag>\Deleted</flag>
    <flag>\Seen</flag>
  </flags>
  <expunge>58</expunge>
  <exists>115</exists>
  <recent>0</recent>
</idle>

When no update is available, the result is <idle></idle>. Call this method frequently while IDLE is active, and call IdleDone before issuing another IMAP command.

Returns a zero-length WideString on failure

Creates an asynchronous task to call the IdleCheck method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Ends IMAP IDLE mode by sending the protocol's DONE continuation.

Call this before sending another IMAP command on the same connection.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the IdleDone method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the IMAP IDLE command and begins listening for unsolicited mailbox updates.

The server must advertise the IDLE capability. After this succeeds, call IdleCheck to receive updates and IdleDone to leave IDLE mode.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the IdleStart method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Returns the last known connection state without sending data to the IMAP server.

A 1 result does not prove that an idle connection is still usable. Call Noop to send a command and verify that the server responds.

Indicates whether this object is in an authenticated IMAP session.

This reports the last known state and does not send a command to the server.

Associates this Imap object with the original Imap caller that created the asynchronous Task in task.

This works with a task returned by any Imap async method, and the task does not need to be complete. The operation does not copy the caller's state; this object becomes another reference to the same underlying Imap state. Any previously associated state in this object is replaced.

Use this when code has a Task—for example in a task-completed callback—but no longer has a reference to the object that started the async operation.

Returns 1 for success, 0 for failure.

Authenticates the connected IMAP session using the login name in loginName and the credential in password.

Call Connect first. The mechanism is selected by AuthMethod. For XOAUTH2, password is the OAuth 2.0 access token rather than a password.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the Login method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Authenticates the connected IMAP session using the SecureString login name in loginName and credential in password.

This is the secure-string counterpart of Login. The authentication mechanism is selected by AuthMethod.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the LoginSecure method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the IMAP LOGOUT command and ends the authenticated session.

The server normally closes the connection as part of a successful logout.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the Logout method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Lists mailboxes into the Mailboxes object in mboxes.

• subscribed = 1: list only subscribed mailboxes.
• subscribed = 0: list all matching mailboxes.

reference is the IMAP reference name, usually an empty string. mbxPattern is the mailbox pattern: * matches zero or more hierarchy levels, while % matches one hierarchy level.

Examples:

• reference = "", mbxPattern = *: all visible mailboxes.
• reference = "", mbxPattern = %: top-level mailboxes.
• reference = INBOX., mbxPattern = *: descendants under INBOX. on a server using . as its delimiter.

The method also updates SeparatorChar from the server's response.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the MbxList method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Moves the messages identified by the MessageSet in messageSet from the selected mailbox to destination mailbox destFolder.

The server must advertise the IMAP MOVE capability. MessageSet.HasUids determines whether messageSet contains UIDs or sequence numbers.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the MoveMessages method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the IMAP NOOP command and waits for the server response.

This is useful for verifying that an existing authenticated connection is still responsive and for receiving unsolicited mailbox-state updates.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the Noop method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Searches the selected mailbox using the IMAP criteria in criteria and stores matching identifiers in the MessageSet in msgSet.

If bUid is 1, msgSet contains UIDs; otherwise, it contains sequence numbers. SearchCharset applies when the criteria contain non-ASCII text.

The special criterion new-email finds messages received since the mailbox was selected or since the previous new-email query. It closes and reopens the mailbox and returns UIDs for recent messages or messages beyond the previously observed UIDNEXT.

When SortCriteria is nonempty, the method sends IMAP SORT instead of SEARCH. The server must advertise the corresponding capability.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the QueryMbx method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the IMAP THREAD command for the selected mailbox and stores the thread hierarchy in the JsonObject in json.

threadAlg is the threading algorithm, commonly ORDEREDSUBJECT or REFERENCES. searchCriteria contains ordinary IMAP search criteria. If bUid is 1, message identifiers in the result are UIDs; otherwise, they are sequence numbers.

The server must advertise the IMAP THREAD capability and support the selected algorithm. ORDEREDSUBJECT groups messages by normalized subject and date; REFERENCES builds parent-child relationships from message-reference headers and reply subjects.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the QueryThread method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the raw IMAP command bytes in the BinData in bdCmd and stores the raw response bytes in bdResp.

Use this for protocol extensions or binary command data that cannot be represented safely as text. The caller is responsible for valid IMAP syntax and session state.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the RawCommandBd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Fetches the current IMAP flags for the message represented by email and updates the email's internal ckx-* metadata headers.

Methods such as GetMailFlag read these stored headers. email must contain the IMAP identifiers added when the email was originally fetched.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the RefetchMailFlags method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Renames the mailbox in fromMailbox to the name in toMailbox.

Changing hierarchy components can also move a mailbox within the server's folder tree, for example from INBOX.old.project to INBOX.archive.project.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the RenameMailbox method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Opens the mailbox in mailbox for read-write access.

A mailbox must be selected before message fetch, search, flag, copy, move, or expunge operations that act on mailbox contents. Successful selection updates SelectedMailbox, NumMessages, UidValidity, and related mailbox-state properties.

Use ExamineMailbox when read-only access is required.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the SelectMailbox method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the raw IMAP command text in cmd and returns the raw server response.

Use this only for protocol extensions or commands not otherwise exposed by the API. The caller is responsible for correct IMAP syntax and for maintaining a valid connection, authentication, selected-mailbox, and IDLE state.

Returns a zero-length WideString on failure

Creates an asynchronous task to call the SendRawCommand method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the raw IMAP command text in cmd and returns the server response as bytes.

This is the byte-oriented counterpart of SendRawCommand.

Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

Creates an asynchronous task to call the SendRawCommandB method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the raw IMAP command bytes in cmd and returns the server response as bytes.

Use this when the command itself cannot be represented safely as an ordinary string.

Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

Creates an asynchronous task to call the SendRawCommandC method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Specifies the Cert in cert for decrypting S/MIME messages downloaded by this Imap object.

The certificate must have access to its associated private key. Use SetDecryptCert2 when the private key is supplied separately.

Returns 1 for success, 0 for failure.

Specifies the certificate in cert and its separately supplied PrivateKey in key for decrypting S/MIME messages.

Use this when the certificate object does not already provide access to the private key.

Returns 1 for success, 0 for failure.

Sets or clears one flag on the message identified by msgId in the selected mailbox.

If bUid is 1, msgId is a UID; otherwise, it is a sequence number. flagName is the flag name, and value is 1 to set the flag or 0 to clear it.

Standard flags include \Deleted, \Seen, \Answered, \Flagged, and \Draft. Server-supported custom keywords may also be used.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the SetFlag method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sets or clears one flag for every message in the MessageSet supplied in messageSet.

flagName is the flag name, and value is 1 to set the flag or 0 to clear it. MessageSet.HasUids determines whether the identifiers are UIDs or sequence numbers.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the SetFlags method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sets or clears a flag for the server message represented by the Email in email.

Chilkat obtains the UID from the email's ckx-imap-uid header. flagName is the flag name, and value is 1 to set it or 0 to clear it. The method fails if the required UID metadata is absent.

Setting \Deleted marks the message for deletion; call Expunge to remove it permanently.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the SetMailFlag method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sends the IMAP SETQUOTA command for quota root quotaRoot.

resource is STORAGE to set the combined message-storage limit or MESSAGE to set the message-count limit. For STORAGE, quota is measured in units of 1024 octets; for example, 500000 represents approximately 500,000,000 bytes.

The server must support the IMAP QUOTA extension and the requested resource type.

Creates an asynchronous task to call the SetQuota method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Specifies the client certificate in cert for TLS client-certificate authentication.

Most IMAP servers do not require a client certificate. When one is required, cert must provide access to the corresponding private key.

Returns 1 for success, 0 for failure.

Specifies a TLS client certificate and private key from PEM data or a PEM file.

pemDataOrFilename may contain the PEM text itself or a local filesystem path to the PEM file; Chilkat detects which form was supplied. pemPassword contains the password when the private key is encrypted.

Returns 1 for success, 0 for failure.

Specifies a TLS client certificate and private key from a PKCS #12/PFX file.

pfxFilename is the local filesystem path of the .pfx or .p12 file, and pfxPassword contains its password.

Returns 1 for success, 0 for failure.

Authenticates the SSH tunnel using the username in sshLogin and the SshKey private key in privateKey.

Call SshOpenTunnel first. The corresponding public key must already be authorized for sshLogin on the SSH server. After authentication, call Connect and Login for the IMAP server.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the SshAuthenticatePk method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Authenticates the SSH tunnel using the username in sshLogin and password in sshPassword.

Call SshOpenTunnel first. After SSH authentication succeeds, call Connect and Login; the IMAP traffic then flows through the tunnel automatically.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the SshAuthenticatePw method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Closes the SSH tunnel opened by SshOpenTunnel.

Any IMAP connection using that tunnel must no longer be used after the tunnel is closed.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the SshCloseTunnel method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Connects to the SSH server in sshHostname on port sshPort and prepares an SSH tunnel for the later IMAP connection.

Port 22 is the usual SSH port. After this succeeds, authenticate with SshAuthenticatePw or SshAuthenticatePk, then call Connect and Login for IMAP.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the SshOpenTunnel method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Sets or clears multiple flags on one message in the selected mailbox.

If bUid is 1, msgId is a UID; otherwise, it is a sequence number. flagNames is a space-separated list such as \Seen \Answered $label1. value is 1 to set all listed flags or 0 to clear them.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the StoreFlags method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Subscribes the authenticated IMAP account to the mailbox named by mailbox.

Subscription controls which mailboxes are returned by subscribed-mailbox listing operations; it does not create the mailbox.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the Subscribe method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Removes the subscription to the mailbox named by mailbox.

The mailbox itself and its messages are not deleted.

Returns 1 for success, 0 for failure.

Creates an asynchronous task to call the Unsubscribe method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Associates the XmlCertVault in vault with this Imap object as a source of certificates and private keys for S/MIME operations.

Only one vault can be associated at a time. Calling this method again replaces the previously associated vault.

Returns 1 for success, 0 for failure.

Uses an already connected and authenticated Ssh object as the transport for subsequent IMAP connections.

SSH supports multiple logical channels, so the same SSH connection may be shared by IMAP and other Chilkat objects. Call this method before Connect.

Returns 1 for success, 0 for failure.

Uses the existing SSH tunnel represented by the Socket in tunnel for subsequent IMAP connections.

This allows a tunnel to be shared with other objects. Call this method before Connect.

Returns 1 for success, 0 for failure.

Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.

Delphi ActiveX Event callback implementation:

procedure TForm1.imapAbortCheck(ASender: TObject;  out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  imap: TChilkatImap;

begin
  imap := TChilkatImap.Create(Self);
  imap.OnAbortCheck := imapAbortCheck;
  // ...

This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).

The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.

To abort the operation, set the abort output argument to 1. This will cause the method to terminate and return a failure status or corresponding failure value.

Delphi ActiveX Event callback implementation:

procedure TForm1.imapPercentDone(ASender: TObject;  pctDone: Integer; out abort: Integer);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  imap: TChilkatImap;

begin
  imap := TChilkatImap.Create(Self);
  imap.OnPercentDone := imapPercentDone;
  // ...

This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.

Note: Some Chilkat methods don't fire any ProgressInfo events.

Delphi ActiveX Event callback implementation:

procedure TForm1.imapProgressInfo(ASender: TObject;  const name: WideString; const value: WideString);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  imap: TChilkatImap;

begin
  imap := TChilkatImap.Create(Self);
  imap.OnProgressInfo := imapProgressInfo;
  // ...

Called from the background thread when an asynchronous task completes.

Delphi ActiveX Event callback implementation:

procedure TForm1.imapTaskCompleted(ASender: TObject;  const task: IChilkatTask);
begin
    // Application code goes here...
end;


procedure TForm1.Button1Click(Sender: TObject);
var
  imap: TChilkatImap;

begin
  imap := TChilkatImap.Create(Self);
  imap.OnTaskCompleted := imapTaskCompleted;
  // ...

Deprecated: Use QueryMbx instead.

Checks for messages that arrived since the mailbox was selected or since the previous call to this method, whichever is later.

The method closes and reopens the selected mailbox, then searches for messages marked recent or having a UID greater than the prior UIDNEXT. The returned MessageSet contains UIDs and may be passed to FetchMsgSet.

Returns nil on failure

Creates an asynchronous task to call the CheckForNewEmail method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use FetchMsgSet instead.

Downloads the messages identified by the MessageSet in messageSet and returns them in an EmailBundle.

Whether messageSet contains UIDs or sequence numbers is determined by its HasUids property.

Returns nil on failure

Creates an asynchronous task to call the FetchBundle method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use FetchSingleBd or methods that return Email objects.

Downloads the messages identified by messageSet and returns their MIME sources in a StringArray. MIME may contain binary data and mixed character encodings, so representing it as ordinary strings can require transformations and is not suitable for preserving exact bytes.

Returns nil on failure

Creates an asynchronous task to call the FetchBundleAsMime method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use FetchRange instead.

Downloads a sequence-number range beginning at startSeqNum and containing up to count messages.

failedSet receives sequence numbers that could not be fetched, fetchedSet receives sequence numbers fetched successfully, and the returned EmailBundle contains the downloaded messages.

Returns nil on failure

Creates an asynchronous task to call the FetchChunk method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use FetchMsgSet instead.

Downloads only the headers for the messages identified by messageSet and returns them in an EmailBundle.

Use GetMailNumAttach, GetMailAttachSize, GetMailAttachFilename, and GetMailFlag to inspect metadata stored with a header-only email.

Returns nil on failure

Creates an asynchronous task to call the FetchHeaders method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use FetchRange instead.

Downloads numMessages messages beginning with sequence number startSeqNum and returns them in an EmailBundle.

Sequence numbers begin at 1. If the requested count extends beyond the mailbox, messages through the end of the mailbox are returned. Sequence numbers can change whenever messages are expunged.

Returns nil on failure

Creates an asynchronous task to call the FetchSequence method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use FetchSingleBd or methods that return Email objects.

Downloads numMessages messages beginning at sequence number startSeqNum and returns each MIME source in a StringArray.

Sequence numbers begin at 1 and may change after an expunge. MIME can contain binary data and mixed encodings, so string-based MIME retrieval is not suitable when exact bytes must be preserved.

Returns nil on failure

Creates an asynchronous task to call the FetchSequenceAsMime method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use FetchRange instead.

Downloads only the headers for numMessages messages beginning with sequence number startSeqNum.

Sequence numbers begin at 1 and must be within the current range reported by NumMessages. They can change when messages are expunged.

Returns nil on failure

Creates an asynchronous task to call the FetchSequenceHeaders method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use FetchEmail instead.

Downloads one message and returns it as an Email. If bUid is 1, msgId is a UID; otherwise, msgId is a sequence number.

Ordinary attachment bodies are included according to AutoDownloadAttachments.

Returns nil on failure

Creates an asynchronous task to call the FetchSingle method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use FetchEmail instead.

Downloads only the headers for one message. If bUid is 1, msgId is a UID; otherwise, msgId is a sequence number.

Use the attachment- and flag-inspection methods to read metadata retained in the header-only Email.

Returns nil on failure

Creates an asynchronous task to call the FetchSingleHeader method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use QueryMbx instead.

Returns a MessageSet containing every UID in the currently selected mailbox.

The replacement call is equivalent to querying for ALL with UID results requested.

Returns nil on failure

Creates an asynchronous task to call the GetAllUids method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use GetServerCert instead.

Returns the certificate presented by the IMAP server for the current TLS connection.

Returns nil on failure

Deprecated: Use MbxList instead.

Sends the IMAP LIST command using reference as the reference name and wildcardedMailbox as the mailbox pattern.

The pattern supports IMAP wildcards: * matches zero or more hierarchy levels, while % matches within one hierarchy level. The returned Mailboxes object contains the matching names and attributes.

This method also updates SeparatorChar from the hierarchy delimiter reported by the server.

Returns nil on failure

Creates an asynchronous task to call the ListMailboxes method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use MbxList instead.

Sends the IMAP LSUB command and returns subscribed mailboxes matching wildcardedMailbox, interpreted relative to reference.

The mailbox-pattern rules are the same as for ListMailboxes.

Returns nil on failure

Creates an asynchronous task to call the ListSubscribed method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use QueryMbx instead.

Searches the selected mailbox using the IMAP search criteria in criteria. If bUid is 1, the returned MessageSet contains UIDs; otherwise, it contains sequence numbers.

criteria is passed to the server as IMAP SEARCH criteria. Multiple keys are combined with AND unless operators such as OR or NOT are used. Common examples include:

• ALL
• UNSEEN
• FROM "sender@example.com"
• SUBJECT "invoice"
• SINCE 1-Jul-2026
• UID 1000:*

String matching is performed by the server and is normally case-insensitive substring matching. SearchCharset controls the charset used for non-ASCII criteria, although some server implementations impose additional restrictions.

Returns nil on failure

Creates an asynchronous task to call the Search method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use QueryMbx instead.

Searches the selected mailbox using criteria searchCriteria and returns the matching message identifiers in the order requested by sortCriteria.

sortCriteria is a space-separated sort expression. REVERSE before a key makes that key descending. Supported keys include ARRIVAL, CC, DATE, FROM, SIZE, SUBJECT, and TO.

charset is the search charset. If bUid is 1, the returned set contains UIDs; otherwise, sequence numbers are returned. The server must support IMAP SORT.

Returns nil on failure

Creates an asynchronous task to call the Sort method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure

Deprecated: Use QueryThread instead.

Sends the IMAP THREAD command using threading algorithm threadAlg, charset charset, and search criteria searchCriteria.

Common algorithms are ORDEREDSUBJECT and REFERENCES. If bUid is 1, thread members are UIDs; otherwise, they are sequence numbers. The returned JsonObject represents the parent-child thread structure.

The server must advertise the IMAP THREAD capability and support the requested algorithm.

Returns nil on failure

Creates an asynchronous task to call the ThreadCmd method with the arguments provided.

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns nil on failure