Imap Rust Reference Documentation
Imap
Current Version: 11.6.1
Chilkat.Imap
Connect with SSL/TLS, STARTTLS, OAuth2, password authentication, proxy
settings, timeouts, and connection diagnostics.
List mailboxes, select folders, inspect mailbox state, and work with
server-side folders such as Inbox, Sent, Archive, or custom folders.
Search by IMAP criteria, work with UIDs or sequence numbers, download
full messages, headers, MIME, body text, or selected message parts.
Set and clear flags, mark messages read or unread, copy or move messages,
delete messages, expunge mailboxes, and append MIME to folders.
Retrieve email as Chilkat
Monitor mailbox changes with IMAP IDLE and use detailed logging,
response text, and
For an extended overview, see
Imap Class Overview.
Access, search, download, organize, and monitor email on IMAP servers.
Chilkat.Imap is a full-featured IMAP client class for
applications that need reliable server-side email access and mailbox
management. It supports secure connections, authentication, mailbox
selection, message searching, downloading email and attachments, flag
management, moving and copying messages, appending MIME, IDLE-based change
monitoring, and detailed diagnostics for troubleshooting server behavior.
Secure IMAP connections
Mailbox selection and listing
Search and fetch messages
Message management
Attachments and MIME
Email objects, process MIME
content, and save or inspect attachments as needed.
IDLE and diagnostics
LastErrorText to troubleshoot servers.
Object Creation
// Cargo.toml:
// [dependencies]
// chilkat = "11.6"
use chilkat::Imap;
// Once per process, before any other Chilkat call:
chilkat::unlock_bundle("Anything for 30-day trial")?; // shorthand for Global::new().unlock_bundle(..)
let imap = Imap::new();
// ... the native object is freed when `imap` goes out of scope.Creates the underlying native Chilkat object (Imap also implements Default). Every method takes &self, so the object never needs to be declared mut. A Imap is Send but not Sync: it may be moved to another thread, but a reference to it cannot be shared between threads at the same time.
The native object is freed when the Imap is dropped — when it goes out of scope, or explicitly with drop(imap). There is no Dispose method to call.
Errors
Methods that can fail return chilkat::Result<T>, which is Result<T, chilkat::Error>: a method whose only outcome is success or failure returns Result<()>, a method producing a string or an object returns Result<String> or Result<Imap>. The error carries the object's LastErrorText at the time of the failure (Error::last_error_text), the class and method names, and implements std::error::Error, so ? works in any function returning chilkat::Result or a Box<dyn Error>. Properties never fail, and methods that answer a question (has_..., is_..., ...) return a plain bool.
match imap.some_method(...) {
Ok(value) => println!("{value:?}"),
Err(e) => eprintln!("{}", e.last_error_text()),
}Properties
AbortCurrent
pub fn abort_current(&self) -> bool
pub fn set_abort_current(&self, value: bool)
Controls cancellation of the method currently running on this Imap object.
- Set this property to
trueto 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 false when the abort is processed. If no method is running, it is reset when the next method begins.
Canceling an operation can leave the connection in an uncertain state. Close the connection, reconnect, authenticate again, and reselect the mailbox before continuing. Output objects may contain partial results, and a server-side operation may already have been partially applied before cancellation.
topAppendSeen
pub fn append_seen(&self) -> bool
pub fn set_append_seen(&self, value: bool)
Controls the initial \Seen flag for these methods:
true(the default): the appended message is marked as seen.false: the appended message is initially unseen.
The flag-specific append methods use their explicit arguments and do not use this property.
topAppendUid
pub fn append_uid(&self) -> i32
Contains the UID assigned by the server to the message most recently appended successfully.
The default is 0. After any successful append, this property is set to the UID reported by the server, or to 0 if the server succeeds but does not report an appended UID. A failed append leaves the previous value unchanged.
AuthMethod
Selects the IMAP authentication mechanism. Matching is case-insensitive, but spelling matters.
| Value | Purpose |
|---|---|
LOGIN | Username and password authentication. |
PLAIN | SASL PLAIN authentication. AuthzId may also be used. |
CRAM-MD5 | Challenge-response authentication when supported by the server. |
NTLM | Windows Integrated Authentication. |
XOAUTH2 | OAuth 2.0 access-token authentication. |
The default is LOGIN, and an empty or unrecognized value also uses the LOGIN method. If the selected mechanism fails or is not supported by the server, Chilkat does not fall back to another authentication method.
If NTLM authentication fails because of an NTLM-version compatibility issue, set Global.DefaultNtlmVersion to 1 and retry.
AuthzId
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.
AutoDownloadAttachments
pub fn auto_download_attachments(&self) -> bool
pub fn set_auto_download_attachments(&self, value: bool)
Controls whether methods that download a complete email also download ordinary attachment bodies. The default is true.
true: complete-email fetches include attachment bodies.false: complete-email fetches omit ordinary attachment bodies, whether the result is returned as anEmailobject or as MIME.
Header-only methods never download attachment bodies. They add ckx-imap-* metadata describing the attachments, which can be read with GetMailNumAttach, GetMailAttachFilename, and GetMailAttachSize. In this state, the Email object's ordinary attachment count can still be 0.
Related MIME parts used by an HTML body are not treated as ordinary attachments. Signed or encrypted messages are always downloaded in full because their complete MIME is required for verification or decryption.
AutoFix
pub fn auto_fix(&self) -> bool
pub fn set_auto_fix(&self, value: bool)
When true (the default), changes the public Ssl and StartTls property values when Connect is called for a standard IMAP port:
- Port
993: setsSsltotrueandStartTlstofalsefor implicit TLS. - Port
143: setsSsltofalse. The existingStartTlsvalue determines whether the connection is upgraded explicitly.
For a nonstandard port, this property makes no changes. Set it to false when the application must preserve an unusual port and TLS combination exactly as configured.
ClientIpAddress
pub fn client_ip_address(&self) -> String
pub fn set_client_ip_address(&self, value: &str)
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.
ConnectedToHost
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.
topConnectTimeout
pub fn connect_timeout(&self) -> i32
pub fn set_connect_timeout(&self, value: i32)
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.
DebugLogFilePath
pub fn debug_log_file_path(&self) -> String
pub fn set_debug_log_file_path(&self, value: &str)
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.
Domain
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.
topEnableSecrets
pub fn enable_secrets(&self) -> bool
pub fn set_enable_secrets(&self, value: bool)
Enables automatic resolution of credential values from secure operating-system storage. The default is false.
When true, 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.
HeartbeatMs
pub fn heartbeat_ms(&self) -> i32
pub fn set_heartbeat_ms(&self, value: i32)
Sets the interval, in milliseconds, between AbortCheck event callbacks during operations that support cancellation.
The default is 0, which disables periodic AbortCheck callbacks.
HighestModSeq
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.
HttpProxyAuthMethod
pub fn http_proxy_auth_method(&self) -> String
pub fn set_http_proxy_auth_method(&self, value: &str)
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.
HttpProxyDomain
pub fn http_proxy_domain(&self) -> String
pub fn set_http_proxy_domain(&self, value: &str)
Specifies the optional Windows domain for HTTP-proxy NTLM authentication.
It is ignored when the proxy does not use NTLM authentication.
topHttpProxyHostname
pub fn http_proxy_hostname(&self) -> String
pub fn set_http_proxy_hostname(&self, value: &str)
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.
topHttpProxyPassword
pub fn http_proxy_password(&self) -> String
pub fn set_http_proxy_password(&self, value: &str)
Specifies the password used to authenticate with the configured HTTP proxy.
It is used only when the proxy requires authentication.
topHttpProxyPort
pub fn http_proxy_port(&self) -> i32
pub fn set_http_proxy_port(&self, value: i32)
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.
HttpProxyUsername
pub fn http_proxy_username(&self) -> String
pub fn set_http_proxy_username(&self, value: &str)
Specifies the username used to authenticate with the configured HTTP proxy.
It is used only when the proxy requires authentication.
topKeepSessionLog
pub fn keep_session_log(&self) -> bool
pub fn set_keep_session_log(&self, value: bool)
Enables or disables the in-memory IMAP protocol log. The default is false.
When enabled, SessionLog contains the raw commands sent to the server and the raw responses received. Use ClearSessionLog to reset it.
LastAppendedMime
Contains the MIME source sent by the most recent successful call to one of the following methods:
A failed append leaves the previous value unchanged. Therefore, read this property only after confirming that the append method succeeded.
topLastCommand
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.
topLastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastIntermediateResponse
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.
topLastMethodSuccess
pub fn last_method_success(&self) -> bool
pub fn set_last_method_success(&self, value: bool)
Indicates the success or failure of the most recent method call: true means success, false 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.
LastResponse
Contains the raw response most recently received from the IMAP server.
This property is cleared when Chilkat sends a new command. If a method fails during local argument validation or before a command is sent, the previous response can remain here. Also, a method can return failure even when the last tagged server response is OK, such as when a syntactically successful FETCH returns no matching message. Use the method return value or LastMethodSuccess as the authoritative success indicator.
LastResponseCode
Contains the optional IMAP response code from the most recent server response, such as NONEXISTENT or AUTHENTICATIONFAILED. Response-code strings vary by server.
If a method fails before sending an IMAP command, this property can still contain the response code from an earlier command. Use the method return value or LastMethodSuccess to determine whether the current operation succeeded.
LoggedInUser
Contains the username of the authenticated IMAP session.
Returns an empty string when the object is not logged in.
topNumMessages
pub fn num_messages(&self) -> i32
Contains the number of messages reported when the current mailbox was selected.
The value is updated by SelectMailbox and ExamineMailbox. Unsolicited EXISTS notifications returned by IdleCheck do not automatically update this property; use the notification value or reselect/query the mailbox when a refreshed count is needed.
PeekMode
pub fn peek_mode(&self) -> bool
pub fn set_peek_mode(&self, value: bool)
Controls whether fetching full message content marks the message as seen.
false(the default): fetching a full message or its raw MIME may set the\Seenflag.true: full message data and raw MIME are fetched without setting\Seen, using IMAP peek semantics.
Fetching headers only does not set \Seen, regardless of this property.
PercentDoneScale
pub fn percent_done_scale(&self) -> i32
pub fn set_percent_done_scale(&self, value: i32)
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.
topPort
pub fn port(&self) -> i32
pub fn set_port(&self, value: i32)
Specifies the IMAP server port. The default is 143.
993is the standard port for implicit TLS and is normally used withSslset totrue.143is the standard port for ordinary IMAP and for explicit TLS requested withStartTls.
When AutoFix is enabled, standard port values are used to adjust the effective TLS configuration when connecting.
PreferIpv6
pub fn prefer_ipv6(&self) -> bool
pub fn set_prefer_ipv6(&self, value: bool)
Controls address-family preference when a hostname resolves to both IPv4 and IPv6 addresses.
false(the default): prefer IPv4.true: prefer IPv6.
The other address family may still be used when the preferred one is unavailable.
topReadTimeout
pub fn read_timeout(&self) -> i32
pub fn set_read_timeout(&self, value: i32)
The maximum number of seconds that an incoming IMAP response may stall with no additional bytes received.
The default is 60 seconds. This is an inactivity timeout, not a limit on the total time allowed for a large response.
RequireSslCertVerify
pub fn require_ssl_cert_verify(&self) -> bool
pub fn set_require_ssl_cert_verify(&self, value: bool)
Controls verification of the IMAP server's TLS certificate chain.
false(the default): a connection is not rejected solely because normal certificate-chain verification fails.true: the connection fails when the certificate is expired, is not yet valid, its signature is invalid, or its chain cannot be verified to a trusted root.
Certificate-chain verification is separate from hostname matching and public-key pinning. Hostname matching, when required, is enforced independently even when this property is false. TlsPinSet supplements rather than replaces normal certificate verification.
The hostname used for the TLS connection is also used for Server Name Indication (SNI) and certificate hostname comparison.
topSearchCharset
Specifies the IMAP CHARSET used by Search, QueryMbx, and QueryThread 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.
topSelectedMailbox
Contains the name of the currently selected or examined mailbox.
Returns an empty string when no mailbox is selected.
topSendBufferSize
pub fn send_buffer_size(&self) -> i32
pub fn set_send_buffer_size(&self, value: i32)
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.
SeparatorChar
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.
SessionLog
Contains the in-memory log of raw IMAP commands and server responses.
KeepSessionLog must be true for logging to occur. Call ClearSessionLog to remove previously collected entries.
Chilkat redacts sensitive credentials, including passwords and OAuth access tokens, from session logs, diagnostic logs, and LastErrorText.
SocksHostname
Specifies the hostname or numeric IP address of the SOCKS proxy.
This property is used only when SocksVersion is 4 or 5.
SocksPassword
Specifies the SOCKS5 proxy password.
It is ignored for SOCKS4 because SOCKS4 does not define password authentication.
topSocksPort
pub fn socks_port(&self) -> i32
pub fn set_socks_port(&self, value: i32)
Specifies the SOCKS proxy port. The default is 1080.
This property is used only when SocksVersion is 4 or 5.
SocksUsername
Specifies the username sent to a SOCKS4 or SOCKS5 proxy.
This property is used only when SocksVersion is 4 or 5.
SocksVersion
pub fn socks_version(&self) -> i32
pub fn set_socks_version(&self, value: i32)
Selects whether the IMAP connection uses a SOCKS proxy.
| Value | Behavior |
|---|---|
0 | Do not use a SOCKS proxy. This is the default. |
4 | Connect through a SOCKS4 proxy. |
5 | Connect through a SOCKS5 proxy. |
SoRcvBuf
pub fn so_rcv_buf(&self) -> i32
pub fn set_so_rcv_buf(&self, value: i32)
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.
SortCriteria
Specifies the sort order used by QueryMbx. The default is the empty string, which uses an ordinary IMAP SEARCH.
Set this property to a space-separated list of sort keys. Sorting is ascending unless REVERSE precedes a key. Supported keys are ARRIVAL, CC, DATE, FROM, SIZE, SUBJECT, and TO.
Examples:
SUBJECT REVERSE DATEREVERSE SIZEARRIVAL
If the server does not support the IMAP SORT extension, Chilkat automatically falls back to an ordinary SEARCH.
SoSndBuf
pub fn so_snd_buf(&self) -> i32
pub fn set_so_snd_buf(&self, value: i32)
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.
Ssl
pub fn ssl(&self) -> bool
pub fn set_ssl(&self, value: bool)
Controls implicit TLS for the IMAP connection. The default is false.
true: begin the connection with a TLS handshake, typically on port993.false: begin with ordinary IMAP. UseStartTlswhen the server requires an explicit STARTTLS upgrade.
If both this property and StartTls are true, implicit TLS takes precedence and STARTTLS is not used.
SslAllowedCiphers
pub fn ssl_allowed_ciphers(&self) -> String
pub fn set_ssl_allowed_ciphers(&self, value: &str)
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:
rsa1024orrsa2048to require a minimum RSA server-key size.secure-renegotiationto require secure TLS renegotiation.best-practicesto 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.
SslProtocol
Selects the TLS protocol version or minimum version allowed for secure IMAP connections.
The complete list of accepted values is:
defaultTLS 1.3TLS 1.2TLS 1.1TLS 1.0SSL 3.0TLS 1.3 or higherTLS 1.2 or higherTLS 1.1 or higherTLS 1.0 or higher
The default is default, which allows Chilkat to negotiate a protocol supported by both client and server. A minimum-version setting is generally more interoperable than requiring one exact version.
SslServerCertVerified
pub fn ssl_server_cert_verified(&self) -> bool
Indicates whether the IMAP server certificate chain was successfully verified for the current or most recent TLS connection.
This property reports certificate-chain verification only. It does not report hostname matching or public-key pinning. If hostname matching or pinning is required and the check fails, the connection itself fails.
topStartTls
pub fn start_tls(&self) -> bool
pub fn set_start_tls(&self, value: bool)
Controls explicit TLS using the IMAP STARTTLS command. The default is false.
true: connect in clear text, issueSTARTTLS, and then continue through an encrypted channel.false: do not request an explicit TLS upgrade.
Explicit TLS is commonly used on port 143. For implicit TLS, set Ssl to true and normally use port 993. If both properties are true, Ssl takes precedence.
TlsCipherSuite
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.
topTlsPinSet
Specifies one or more expected SPKI fingerprints for TLS public-key pinning. If none of the configured pins matches the server certificate, the TLS handshake fails.
Pinning supplements normal certificate-chain verification; it does not replace it. A matching pin does not make an expired or otherwise invalid certificate acceptable. When a pin set is configured, pin matching is enforced even if RequireSslCertVerify is false.
The format is:
hashAlgorithm, encoding, fingerprint1, fingerprint2, ...
Example:
sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE=
Supported hash algorithms include sha1, sha256, sha384, sha512, md2, md5, haval, ripemd128, ripemd160, ripemd256, and ripemd320. Supported encodings include base64, hex, and other Chilkat-supported binary encodings.
TlsVersion
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.
topUidNext
pub fn uid_next(&self) -> u32
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.
UidValidity
pub fn uid_validity(&self) -> u32
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.
UncommonOptions
pub fn uncommon_options(&self) -> String
pub fn set_uncommon_options(&self, value: &str)
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.
VerboseLogging
pub fn verbose_logging(&self) -> bool
pub fn set_verbose_logging(&self, value: bool)
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
AddPfxSourceBd
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 Ok(()) for success, Err(chilkat::Error) for failure.
AddPfxSourceFile
Adds a PKCS #12/PFX file that may be searched for certificates and private keys needed for S/MIME decryption or signature processing.
pfx_file_path is the local filesystem path of the PFX file, and pfx_password 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 Ok(()) for success, Err(chilkat::Error) for failure.
AppendMail
Appends the Email in email to the mailbox named by mailbox.
AppendSeen controls the initial \Seen flag. After success, AppendUid contains the UID reported by the server, or 0 if no UID was reported, and LastAppendedMime contains the MIME sent.
Rendering for the append does not generate or replace email's Date, Message-ID, or MIME boundary values. If email uses an 8bit or binary transfer encoding that would produce non-text binary bytes, Chilkat changes the rendered transfer encoding to a text-safe encoding such as Base64.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendMime
Appends the complete RFC 822/MIME message in mime_text to the mailbox named by mailbox.
AppendSeen controls the initial \Seen flag. After success, AppendUid contains the UID reported by the server, or 0 if no UID was reported, and LastAppendedMime contains the MIME sent.
The MIME text is sent exactly as supplied. Chilkat does not normalize line endings, add a final CRLF, or re-encode headers or body content. The supplied text must not contain non-text binary bytes.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendMimeWithDateStr
Appends the MIME message in mime_text to the mailbox named by mailbox while explicitly setting the server-side internal date from internal_date_str.
internal_date_str 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. AppendSeen controls the initial \Seen flag.
The MIME text is sent exactly as supplied. Chilkat does not normalize line endings, add a final CRLF, or re-encode headers or body content. The supplied text must not contain non-text binary bytes.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendMimeWithFlags
Appends the MIME message in mime_text to the mailbox named by mailbox and sets its initial system flags.
seencontrols\Seen.flaggedcontrols\Flagged.answeredcontrols\Answered.draftcontrols\Draft.
Use true to set a flag and false to leave it unset. The explicit flag arguments are used instead of AppendSeen.
The MIME text is sent exactly as supplied. Chilkat does not normalize line endings, add a final CRLF, or re-encode headers or body content. The supplied text must not contain non-text binary bytes.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
AppendMimeWithFlagsSb
Appends the MIME contained in the StringBuilder in sb_mime to mailbox mailbox and sets its initial system flags.
seencontrols\Seen.flaggedcontrols\Flagged.answeredcontrols\Answered.draftcontrols\Draft.
The explicit flag arguments are used instead of AppendSeen.
The MIME text is sent exactly as supplied. Chilkat does not normalize line endings, add a final CRLF, or re-encode headers or body content. The supplied text must not contain non-text binary bytes.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
Capability
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 Err(chilkat::Error) on failure.
CheckConnection
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.
ClearSessionLog
Clears the in-memory text returned by SessionLog.
Session logging remains enabled or disabled according to KeepSessionLog.
CloseMailbox
Closes the currently selected mailbox while keeping the authenticated IMAP connection open.
mailbox is retained for backward compatibility but is ignored. It may be the empty string. Messages marked with \Deleted are permanently removed as part of the close operation. After success, SelectedMailbox is empty, but another mailbox can be selected on the same connection.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
Connect
Establishes a TCP connection to the IMAP server identified by domain_name but does not authenticate.
domain_name may be a hostname, IPv4 address, or IPv6 address. Configure Port, Ssl, StartTls, proxy settings, and timeouts before calling this method. The TLS hostname is used for Server Name Indication (SNI) and certificate hostname comparison. Call Login after the connection succeeds.
If this method is called while already connected, Chilkat tears down the existing connection and establishes a new connection to domain_name. This applies even when domain_name names the same server.
Imap does not automatically reconnect after a connection is dropped. The application must call this method again, authenticate again, reselect a mailbox when needed, and retry the interrupted operation.
Connection failures can also be caused by DNS, local or remote firewalls, antivirus software, routing, or other network infrastructure outside Chilkat.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
Copy
Copies one message from the currently selected mailbox to the destination mailbox in copy_to_mailbox.
msg_id identifies the source message. If b_uid is true, msg_id is a UID; otherwise, msg_id is a sequence number. The original message remains in the selected mailbox.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
CopyMultiple
Copies the messages identified by the MessageSet in message_set from the selected mailbox to destination mailbox copy_to_mailbox using one IMAP command.
MessageSet.HasUids determines whether message_set contains UIDs or sequence numbers. For sequence numbers, one invalid value causes the entire command to fail and no messages are copied. For UIDs, nonexistent values are silently ignored and valid messages are copied. The original messages remain in the selected mailbox.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
CopySequence
Copies a contiguous range of messages, identified by sequence number, from the selected mailbox to the destination mailbox in copy_to_mailbox.
start_seq_num 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.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
CreateMailbox
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.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
DeleteMailbox
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.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
Disconnect
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 Ok(()) for success, Err(chilkat::Error) for failure.
ExamineMailbox
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.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
Expunge
Permanently removes all messages marked with the \Deleted flag from the currently selected mailbox.
The mailbox remains selected and the authenticated connection remains open. Expunging can change sequence numbers for the remaining messages.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
ExpungeAndClose
Permanently removes all messages marked with \Deleted from the selected mailbox and then closes the mailbox.
After success, SelectedMailbox is empty. The authenticated IMAP connection remains open and can be used to select another mailbox.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
FetchAttachment
Obtains attachment attachment_index from the Email in email_object and writes it to the filesystem path in save_to_path. Attachment indexes are zero-based.
save_to_path may be a filename, a relative path ending in a filename, or an absolute path ending in a filename. Missing parent directories are not created. An existing file is overwritten. A failed operation should not leave a partial output file.
If email_object already contains the attachment bytes, the data is saved without contacting the IMAP server. If email_object was fetched without attachment bodies, Chilkat uses its ckx-imap-* metadata to locate and download the requested MIME part. The same IMAP session is not required, and a copied Email can be used if the metadata is preserved.
The corresponding mailbox must be selected when a server fetch is required. If ckx-imap-isUid is YES, the permanent UID is used and the operation can work after reconnecting. If it is NO, the stored value is a sequence number, which can identify a different message after an expunge. UID-based metadata is therefore preferred for deferred attachment operations. The method fails if the referenced message or MIME part no longer exists, such as after the message is moved or expunged.
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 Ok(()) for success, Err(chilkat::Error) for failure.
FetchAttachmentBd
Obtains attachment attachment_index from the Email in email and stores its bytes in the BinData in bin_data.
Attachment indexes are zero-based. bin_data is always cleared first. On success it contains the complete attachment bytes; on failure it remains empty.
See FetchAttachment for details about downloading attachment data not already present in email.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
FetchAttachmentSb
Obtains text attachment attachment_index 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. sb is always cleared first. On success it contains the complete decoded attachment text; on failure it remains empty. Use this method only for text attachments.
See FetchAttachment for details about downloading data not already present in email.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
FetchAttachmentString
Obtains text attachment attachment_index from the Email in email_object 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 email_object.
Returns Err(chilkat::Error) on failure.
FetchChunk2
Attempts to download count full messages beginning with sequence number seqnum.
failed_set and fetched_set are cleared before use. failed_set receives sequence numbers that failed or were not yet fetched, fetched_set receives sequence numbers fetched successfully, and both sets have MessageSet.HasUids set to false. Downloaded messages are appended to the EmailBundle in bundle, which is not cleared.
Sequence numbers beyond the end of the mailbox are added to failed_set. The method can return success even when failed_set is nonempty; success indicates that the requested range was processed, not that every sequence number existed.
If a network failure occurs, messages already fetched remain in bundle, fetched_set retains the successfully fetched sequence numbers, and failed_set contains the failed and not-yet-fetched sequence numbers. Processing stops and the connection must be considered unusable.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
FetchEmail
Downloads one message or its headers into the Email in email.
header_only=true: download headers only.header_only=false: download the full message.b_uid=true:msg_idis a UID.b_uid=false:msg_idis a sequence number.
On success, email is replaced with the fetched email. On failure, email remains unchanged.
A header-only result contains no body or attachment bodies, but includes ckx-imap-* metadata for the message identifier, flags, total size, and attachment information. For a full download, ordinary attachment bodies are included according to AutoDownloadAttachments. PeekMode controls whether a full fetch sets \Seen; a header-only fetch does not set it.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
FetchFlags
Returns the space-separated IMAP flags for the message identified by msg_id.
If b_uid is true, msg_id is a UID; otherwise, it is a sequence number. A result might be \Flagged \Seen $label1.
An existing message with no flags returns the empty string. A nonexistent message is an error.
Returns Err(chilkat::Error) on failure.
FetchMsgSet
Downloads the existing messages identified by the MessageSet in msg_set and appends them to the EmailBundle in bundle. bundle is not cleared.
headers_only=true: download headers only.headers_only=false: download full messages, with ordinary attachments controlled byAutoDownloadAttachments.
MessageSet.HasUids determines whether msg_set contains UIDs or sequence numbers. A MessageSet is a true set, so duplicate identifiers are collapsed before any command is sent. Identifiers that do not exist are omitted without causing the method to fail. Do not rely on insertion order; fetched messages are returned in the order supplied by the IMAP server, normally mailbox order.
If a network failure occurs after some messages have been downloaded, those messages remain appended to bundle, fetching stops immediately, and the connection must be considered unusable. Reconnect, authenticate, and reselect the mailbox before retrying.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
FetchRange
Downloads count messages beginning with sequence number seqnum and appends them to the EmailBundle in bundle. bundle is not cleared.
headers_only=true: download headers only.headers_only=false: download full messages, with ordinary attachments controlled byAutoDownloadAttachments.
seqnum and count must both be greater than 0. IMAP sequence numbers begin at 1; passing 0 for seqnum, 0 for count, or a negative count fails without changing bundle. Only messages that exist in the requested sequence-number range are appended. Sequence numbers can change after messages are expunged.
If a network failure occurs after some messages have been downloaded, those messages remain appended to bundle, fetching stops immediately, and the connection must be considered unusable.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
FetchSingleAsMime
Downloads one message and returns its MIME source as a string.
If b_uid is true, msg_id is a UID; otherwise, msg_id is a sequence number. Ordinary attachment bodies are included according to AutoDownloadAttachments.
Chilkat interprets the received MIME bytes as UTF-8. MIME using Base64 or quoted-printable transfer encoding is safe because the encoded bytes are ASCII. Raw 8bit or binary content, or unencoded text in another charset such as ISO-8859-1 or Shift_JIS, can be misinterpreted or cause an error. Use FetchSingleBd whenever byte-exact MIME is required.
Returns Err(chilkat::Error) on failure.
FetchSingleAsMimeSb
Downloads one message's MIME into the StringBuilder in sb_mime.
If b_uid is true, msg_id is a UID; otherwise, msg_id is a sequence number. Ordinary attachment bodies are included according to AutoDownloadAttachments. sb_mime is cleared before the operation; on failure it remains empty.
Chilkat interprets the received MIME bytes as UTF-8. MIME using Base64 or quoted-printable transfer encoding is safe because the encoded bytes are ASCII. Raw 8bit or binary content, or unencoded text in another charset such as ISO-8859-1 or Shift_JIS, can be misinterpreted or cause an error. Use FetchSingleBd whenever byte-exact MIME is required.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
FetchSingleBd
Downloads one message's MIME bytes into the BinData in mime_data.
If b_uid is true, msg_id is a UID; otherwise, it is a sequence number. Ordinary attachment bodies are included according to AutoDownloadAttachments, and PeekMode controls whether the fetch sets \Seen.
mime_data is cleared before the operation. On success it contains the downloaded MIME bytes; on failure it remains empty.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
FetchSingleHeaderAsMime
Downloads and returns the MIME header block for one message, without downloading the body.
If b_uid is true, msg_id is a UID; otherwise, msg_id is a sequence number.
Returns Err(chilkat::Error) on failure.
GetMailAttachFilename
Returns the filename for attachment attach_index represented by email. Attachment indexes are zero-based.
This method can obtain the filename from ckx-imap-* metadata in a header-only email even when the attachment body has not been downloaded.
Returns Err(chilkat::Error) on failure.
GetMailAttachSize
Returns the size in bytes of attachment attach_index represented by email. Attachment indexes are zero-based.
This method can obtain the size from ckx-imap-* metadata in a header-only email even when the attachment body has not been downloaded.
GetMailboxStatus
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\Recentflag.uidnext: expected UID for the next appended message.uidvalidity: mailbox UID-validity value.unseen: messages without the\Seenflag.
<status messages="240" recent="0" uidnext="3674" uidvalidity="3" unseen="213" />
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Err(chilkat::Error) on failure.
GetMailFlag
Returns the state of the flag named by flag_name from the IMAP metadata stored in the Email in email.
1: the flag is set.0: the flag is not set.-1: the requiredckx-imap-*metadata is missing.
Standard flags include \Seen, \Answered, \Flagged, \Draft, and \Deleted. Custom keywords such as $label1 or NonJunk are also supported.
Integer-returning methods do not use LastMethodSuccess to report this condition; test the return value directly.
GetMailNumAttach
Returns the number of ordinary attachments represented by email.
This method also works with a header-only email or an email fetched while AutoDownloadAttachments was false. In those cases it reads the ckx-imap-numAttach metadata, even though the Email object's downloaded attachment count can be 0.
GetMailSize
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.
GetQuota
Sends the IMAP GETQUOTA command for the quota root in quota_root and returns the server response as JSON.
The server must advertise the IMAP QUOTA capability.
Returns Err(chilkat::Error) on failure.
GetQuotaRoot
Sends the IMAP GETQUOTAROOT command for the mailbox in mailbox_name and returns the server response as JSON. The server must advertise the IMAP QUOTA capability.
A response can contain both the mailbox-to-root mapping and the quota values:
{
"QUOTAROOT": {"mailbox":"Inbox","root":"Mailbox"},
"QUOTA": {"root":"Mailbox","resource":"STORAGE","used":9,"max":256000}
}
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Err(chilkat::Error) on failure.
GetServerCert
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 Ok(()) for success, Err(chilkat::Error) for failure.
HasCapability
Tests whether the capability named by name appears in the raw capability response in capability_response.
capability_response is typically the string returned by Capability. Capability-name matching follows IMAP capability-token semantics.
IdleCheck
Waits up to timeout_ms milliseconds for unsolicited mailbox updates after IdleStart has entered IMAP IDLE mode.
timeout_ms = 0 performs a strict poll: it checks for already available data and returns immediately. Positive values wait for up to the requested time, including very large values. If the connection is lost while waiting, the method fails.
This method does not send a polling command. It consumes the notifications currently waiting on the existing connection and returns them as XML. A second call returns only notifications that arrived after the previous call.
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><exists>115</exists><recent>1</recent></idle>
When no update is available, the result is <idle></idle>. An exists notification does not automatically change NumMessages.
Chilkat does not automatically refresh IDLE. The application should periodically call IdleDone and IdleStart, typically before 29 minutes have elapsed, to prevent servers with a 30-minute limit from dropping the connection.
Returns Err(chilkat::Error) on failure.
IdleDone
Ends IMAP IDLE mode by sending the protocol's DONE continuation.
The authenticated connection remains open and usable. Calling this method when IDLE is not active fails.
Applications maintaining a long-lived IDLE connection should call this method shortly before the server's IDLE limit, commonly at about 29 minutes, and then immediately call IdleStart again.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
IdleStart
Sends the IMAP IDLE command and begins listening for unsolicited mailbox updates.
The session must be connected, authenticated, and have a mailbox selected with SelectMailbox or ExamineMailbox. The server must advertise the IDLE capability.
Calling this method while IDLE is already active fails. While IDLE is active, any other method that sends an IMAP command also fails; call IdleDone first.
Chilkat does not automatically renew IDLE. To avoid common server time limits, the application should end and restart IDLE before the server timeout, typically about every 29 minutes.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
IsConnected
Returns the last known connection state without sending data to the IMAP server.
A true result does not prove that an idle connection is still usable. Call Noop to send a command and verify that the server responds.
IsLoggedIn
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.
Login
Authenticates the connected IMAP session using the login name in login_name and the credential in password.
Call Connect first. The mechanism is selected by AuthMethod.
For XOAUTH2, login_name is the normal IMAP login name or email address and password is the raw OAuth 2.0 access token without a Bearer prefix. A failed XOAUTH2 login leaves the connection open so the application may correct the credentials and try again.
Do not call this method again after the session is already authenticated. A repeated login attempt fails, although the existing authenticated session remains logged in.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
LoginSecure
Authenticates the connected IMAP session using the SecureString login name in login_name and credential in password.
This is the secure-string counterpart of Login. The authentication mechanism is selected by AuthMethod.
For XOAUTH2, login_name contains the normal login name or email address and password contains the raw access token without a Bearer prefix.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
Logout
Sends the IMAP LOGOUT command and ends the authenticated session.
The server normally closes the connection as part of a successful logout.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
MbxList
Lists matching mailboxes and appends them to the Mailboxes object in mboxes. mboxes is not cleared on success, so repeated calls on the same object can add duplicate entries. If the method fails, mboxes is unchanged.
subscribed=true: list only subscribed mailboxes.subscribed=false: list all matching mailboxes.
reference is the IMAP reference name, usually an empty string. mbx_pattern is the mailbox pattern: * matches zero or more hierarchy levels, while % matches one hierarchy level.
Applications may use normal Unicode mailbox names and patterns. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
The method also updates SeparatorChar from the server's response.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
MoveMessages
Moves the messages identified by the MessageSet in message_set from the selected mailbox to destination mailbox dest_folder using one IMAP MOVE command.
The server must advertise the MOVE capability. If it does not, this method fails and does not emulate the operation with copy, delete, and expunge commands.
MessageSet.HasUids determines whether message_set contains UIDs or sequence numbers. For sequence numbers, one invalid value causes complete failure and nothing is moved. For UIDs, nonexistent values are silently ignored and valid messages are moved.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
Noop
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 Ok(()) for success, Err(chilkat::Error) for failure.
QueryMbx
Searches the selected mailbox using the IMAP criteria in criteria and stores matching identifiers in the MessageSet in msg_set.
On success, msg_set is replaced with the result. If b_uid is true, msg_set contains UIDs and MessageSet.HasUids is true; otherwise, msg_set contains sequence numbers and MessageSet.HasUids is false. If the method fails, msg_set is unchanged. SearchCharset applies when the criteria contain non-ASCII text.
For the special criterion new-email, Chilkat records each UIDNEXT received from SELECT, EXAMINE, or another IMAP response and uses it as the baseline for detecting later UIDs. If no UIDNEXT is available, Chilkat searches for messages having the \Recent flag. Results are always UIDs regardless of b_uid, and an empty result clears msg_set.
When SortCriteria is nonempty, Chilkat uses IMAP SORT if the server supports it. Otherwise, it automatically falls back to an ordinary SEARCH.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
QueryThread
Sends the IMAP THREAD command for the selected mailbox.
thread_alg is the threading algorithm, commonly ORDEREDSUBJECT or REFERENCES. search_criteria contains ordinary IMAP search criteria and is interpreted using SearchCharset. If b_uid is true, message identifiers in the result are UIDs; otherwise, they are sequence numbers.
On success, json is completely replaced with the thread hierarchy. On failure, json is unchanged; there is no partial-success JSON result.
The returned JSON has a top-level threads array. Each element represents one thread, and nested arrays encode parent/child relationships. For example:
{"threads":[[1],[2],[3]]}
The server must advertise the IMAP THREAD capability and support the selected algorithm.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
RawCommandBd
Sends the raw IMAP command bytes in the BinData in bd_cmd and stores the raw response bytes in bd_resp.
bd_cmd contains the command without an IMAP command tag or trailing CRLF; Chilkat supplies both. bd_resp is cleared and replaced with the response.
Use raw commands only for rare server extensions that are not otherwise exposed by the API, have an expected one-line response, and do not change Imap object state such as the selected mailbox, message count, UidNext, or UidValidity. State-changing raw commands can leave cached properties inconsistent with the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
RefetchMailFlags
Fetches the current IMAP flags for the server message represented by email and updates its ckx-imap-* metadata headers.
Chilkat reads the identifier from ckx-imap-uid and checks ckx-imap-isUid to determine whether it is a UID or sequence number. A copied Email can be used as long as this metadata is preserved.
When ckx-imap-isUid is NO, the stored sequence number may identify a different message after an expunge. UID-based emails are preferred for later operations. Methods such as GetMailFlag read the refreshed flag metadata.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
RenameMailbox
Renames the mailbox in from_mailbox to the name in to_mailbox.
Changing hierarchy components can also move a mailbox within the server's folder tree, for example from INBOX.old.project to INBOX.archive.project.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SelectMailbox
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.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SendRawCommand
Sends the raw IMAP command text in cmd and returns the raw server response.
Pass the command itself, such as NOOP, without an IMAP command tag or trailing CRLF. Chilkat generates the tag and command line termination.
Use raw commands only for rare server extensions that are not otherwise exposed by the API, have an expected one-line response, and do not change Imap object state such as the selected mailbox, message count, UidNext, or UidValidity. State-changing raw commands can leave cached properties inconsistent with the server.
Returns Err(chilkat::Error) on failure.
SetDecryptCert
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 Ok(()) for success, Err(chilkat::Error) for failure.
SetDecryptCert2
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 Ok(()) for success, Err(chilkat::Error) for failure.
SetFlag
Sets or clears one flag on the message identified by msg_id in the selected mailbox.
If b_uid is true, msg_id is a UID; otherwise, it is a sequence number. flag_name 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 Ok(()) for success, Err(chilkat::Error) for failure.
SetFlags
Sets or clears one flag for every identifier in the MessageSet supplied in message_set.
flag_name is the flag name, and value is 1 to set it or 0 to clear it. MessageSet.HasUids determines whether the identifiers are UIDs or sequence numbers. Chilkat sends one IMAP STORE or UID STORE command containing the complete identifier set.
IMAP bulk flag changes are not atomic and have no all-or-nothing rollback. Changes applied before a failure remain applied. For UID-based operations, nonexistent UIDs are silently ignored as required by IMAP. For sequence-number operations, an out-of-range sequence number causes the server to return an error; whether valid sequence numbers in the same command were changed before that error is server-dependent.
This method changes server state only. It does not update metadata in any previously fetched Email objects.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SetMailFlag
Sets or clears a flag for the server message represented by the Email in email.
Chilkat reads the message identifier from ckx-imap-uid and uses ckx-imap-isUid to determine whether the value is a UID or sequence number. flag_name is the flag name, and value is 1 to set it or 0 to clear it. The method fails if the required metadata is absent.
A copied Email can be used as long as the metadata is preserved. When ckx-imap-isUid is NO, the stored value is a sequence number and may no longer identify the same message after an expunge. UID-based emails are preferred for operations performed later or after reconnecting.
Setting \Deleted marks the message for deletion; call Expunge to remove it permanently.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SetQuota
Sends the IMAP SETQUOTA command for quota root quota_root.
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.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SetSslClientCert
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 Ok(()) for success, Err(chilkat::Error) for failure.
SetSslClientCertPem
Specifies a TLS client certificate and private key from PEM data or a PEM file.
pem_data_or_filename may contain the PEM text itself or a local filesystem path to the PEM file; Chilkat detects which form was supplied. pem_password contains the password when the private key is encrypted.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SetSslClientCertPfx
Specifies a TLS client certificate and private key from a PKCS #12/PFX file.
pfx_filename is the local filesystem path of the .pfx or .p12 file, and pfx_password contains its password.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SshAuthenticatePk
Authenticates the SSH tunnel using the username in ssh_login and the SshKey private key in private_key.
Call SshOpenTunnel first. The corresponding public key must already be authorized for ssh_login on the SSH server. After authentication, call Connect and Login for the IMAP server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SshAuthenticatePw
Authenticates the SSH tunnel using the username in ssh_login and password in ssh_password.
Call SshOpenTunnel first. After SSH authentication succeeds, call Connect and Login; the IMAP traffic then flows through the tunnel automatically.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SshCloseTunnel
Closes the SSH tunnel opened by SshOpenTunnel.
Any IMAP connection using that tunnel must no longer be used after the tunnel is closed.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
SshOpenTunnel
Connects to the SSH server in ssh_hostname on port ssh_port 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 Ok(()) for success, Err(chilkat::Error) for failure.
StoreFlags
Sets or clears multiple flags on one message in the selected mailbox.
If b_uid is true, msg_id is a UID; otherwise, it is a sequence number. flag_names is a space-separated list such as \Seen \Answered $label1. value is 1 to set all listed flags or 0 to clear them.
The operation uses IMAP STORE or UID STORE and is not transactional. A nonexistent UID can be silently ignored and the command can still succeed. An invalid sequence number causes failure. This method changes server state only and does not update metadata in previously fetched Email objects.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
Subscribe
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.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
Unsubscribe
Removes the subscription to the mailbox named by mailbox.
The mailbox itself and its messages are not deleted.
Mailbox names may be supplied as normal Unicode strings. Chilkat automatically handles IMAP modified UTF-7 or UTF-8 mailbox-name encoding as required by the server.
Returns Ok(()) for success, Err(chilkat::Error) for failure.
UseCertVault
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 Ok(()) for success, Err(chilkat::Error) for failure.
UseSsh
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 Ok(()) for success, Err(chilkat::Error) for failure.
UseSshTunnel
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 Ok(()) for success, Err(chilkat::Error) for failure.
Events
All Chilkat methods are synchronous: the call returns when the work is done. During a call, Imap raises three events so your application can show progress and offer a way out. Implement the chilkat::EventHandler trait (every method has a do-nothing default, so implement only the events you need) and install it with set_event_handler:
use chilkat::{Imap, EventHandler};
struct Progress;
impl EventHandler for Progress {
fn percent_done(&mut self, pct: i32) -> bool {
println!("{pct}%");
false // return true to abort the method in progress
}
fn progress_info(&mut self, name: &str, value: &str) {
println!("{name}: {value}");
}
}
let imap = Imap::new();
imap.set_event_handler(Progress);
imap.set_heartbeat_ms(250); // raise abort_check 4 times per second during Chilkat callsFor a one-off handler the closure methods avoid writing a type; they may be combined, and each replaces the previously set closure for that one event (installing a closure removes a trait handler set earlier, and vice versa):
imap.on_percent_done(|pct| { println!("{pct}%"); false });
imap.on_progress_info(|name, value| println!("{name}: {value}"));Installs handler as the receiver of this object's events, replacing any handler or closures set earlier. The object owns the handler, which must be Send + 'static.
Removes the handler and any closures; events are no longer delivered.
AbortCheck fires at regular intervals controlled by the HeartbeatMs property (0, the default, disables it); PercentDone fires when an operation's completion percentage is known; ProgressInfo delivers named progress values. Returning true from abort_check or percent_done aborts the running method, which then returns Err.
Events fire on the thread that called the method, before that method returns. A panic inside a handler aborts the running method and is re-raised to the caller once the native library has returned, so it never unwinds through C frames. To abort a long operation from another thread, share an Arc<AtomicBool> with an abort_check handler, or set the object's AbortCurrent property to true.
AbortCheck
fn abort_check(&mut self) -> bool
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.
Example (closure form; the EventHandler trait method is equivalent):
imap.set_heartbeat_ms(250); // call abort_check 4 times per second
let stop = std::sync::Arc::new(std::sync::atomic::AtomicBool::new(false));
let flag = stop.clone();
imap.on_abort_check(move || flag.load(std::sync::atomic::Ordering::Relaxed));
// ... another thread may now abort the method in progress with stop.store(true, Ordering::Relaxed)PercentDone
fn percent_done(&mut self, pct: i32) -> bool
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 pct_done 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 pct_done 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 true. This will cause the method to terminate and return a failure status or corresponding failure value.
Example (closure form; the EventHandler trait method is equivalent):
imap.on_percent_done(|pct| {
// pct ranges from 1 to 100.
println!("Percent done: {pct}");
false // return true to abort the method in progress
});ProgressInfo
fn progress_info(&mut self, name: &str, value: &str)
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.
Example (closure form; the EventHandler trait method is equivalent):
imap.on_progress_info(|name, value| println!("{name}: {value}"));