Imap PHP ActiveX Reference Documentation
Imap
Current Version: 10.0.0
An IMAP client class for interacting with an IMAP server to read and manage email and IMAP mailboxes.
Object Creation
Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.Imap");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.Imap");
Properties
AbortCurrent
When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)
topAppendSeen
When true (the default) the Append method will mark the email appended to a mailbox as already seen. Otherwise an appended email will be initialized to have a status of unseen.
topAppendUid
The UID of the last email appended to a mailbox via an Append* method. (Not all IMAP servers report back the UID of the email appended.)
AuthMethod
Can be set to "XOAUTH2", "CRAM-MD5", "NTLM", "PLAIN", or "LOGIN" to select the authentication method. NTLM is the most secure, and is a synonym for "Windows Integrated Authentication". The default is "LOGIN" (or the empty string) which is simple plain-text username/password authentication. Not all IMAP servers support all authentication methods.
The XOAUTH2 method was added in version 9.5.0.44.
Note: If SPA (i.e. NTLM) authentication does not succeed, set the Global.DefaultNtlmVersion property equal to 1 and then retry.
AuthzId
Applies to the PLAIN authentication method. May be set to an authorization ID that is to be sent along with the Login and Password for authentication.
topAutoDownloadAttachments
If set to true, then all Fetch* methods will also automatically download attachments. If set to false, then the Fetch* methods download the email without attachments. The default value is true.
Note: Methods that download headers-only, such as FetchSingleHeader, ignore this property and never download attachments. Also, signed and/or encrypted emails will always be downloaded in full (with attachments) regardless of this property setting.
AutoFix
If true, then the following will occur when a connection is made to an IMAP server:
1) If the Port property = 993, then sets StartTls = false and Ssl = true
2) If the Port property = 143, sets Ssl = false
The default value of this property is true.
topClientIpAddress
The IP address to use for computers with multiple network interfaces or IP addresses. For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.
The IP address is a string such as in dotted notation using numbers, not domain names, such as "165.164.55.124".
ConnectedToHost
Contains the IMAP server's domain name (or IP address) if currently connected. Otherwise returns an empty string.
topConnectTimeout
Maximum number of seconds to wait when connecting to an IMAP server. The default value is 30 (units are in seconds).
topDebugLogFilePath
If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.
This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
Domain
The Windows Domain to use for Windows Integrated Authentication (also known as NTLM). This may be empty.
topHighestModSeq
A string containing an integer value that is the HIGHESTMODSEQ of the currently selected mailbox, or 0 if no mailbox is selected. (Chilkat decided to make this a string property for the chance that HIGHESTMODSEQ is an extremely large integer.)
Not all IMAP servers support HIGHESTMODSEQ. See RFC 4551 Section 3.1.1 HIGHESTMODSEQ Response Code for more information.
topHttpProxyAuthMethod
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy authentication method name. Valid choices are "Basic" or "NTLM".
topHttpProxyDomain
The NTLM authentication domain (optional) if NTLM authentication is used.
topHttpProxyHostname
If an HTTP proxy is to be used, set this property to the HTTP proxy hostname or IPv4 address (in dotted decimal notation).
topHttpProxyPassword
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy password.
topHttpProxyPort
If an HTTP proxy is to be used, set this property to the HTTP proxy port number. (Two commonly used HTTP proxy ports are 8080 and 3128.)
topHttpProxyUsername
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy login name.
topKeepSessionLog
Turns the in-memory session logging on or off. If on, the session log can be obtained via the SessionLog property. The default value is false.
The SessionLog contains the raw commands sent to the IMAP server, and the raw responses received from the IMAP server.
LastAppendedMime
The MIME source of the email last appended during a call to AppendMail, or AppendMime.
topLastBinaryResult
The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to true. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).
topLastCommand
The last raw command sent to the IMAP server. (This information can be used for debugging if problems occur.)
topLastErrorHtml
Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastErrorText
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
LastErrorXml
Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastIntermediateResponse
The last intermediate response received from the IMAP server. (This information can be used for debugging if problems occur.)
topLastMethodSuccess
Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:
- Any method that returns a string.
- Any method returning a Chilkat object, binary bytes, or a date/time.
- Any method returning a standard boolean status value where success = true and failure = false.
- Any method returning an integer where failure is defined by a return value less than zero.
Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topLastResponse
The raw data of the last response from the IMAP server. (Useful for debugging if problems occur.) This property is cleared whenever a command is sent to the IMAP server. If no response is received, then this property will remain empty. Otherwise, it will contain the last response received from the IMAP server.
LastResponseCode
The response code part of the last command response, if it exists. IMAP status responses MAY include an OPTIONAL "response code". A response code consists of data inside square brackets in the form of an atom, possibly followed by a space and arguments. The response code contains additional information or status codes for client software beyond the OK/NO/BAD condition, and are defined when there is a specific action that a client can take based upon the additional information. Examples of response codes are "NONEXISTENT" and "AUTHENTICATIONFAILED". The response code strings for a given failure condition may vary depending on the IMAP server implementation.
LastStringResult
The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to true. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topLoggedInUser
If logged into an IMAP server, the logged-in username.
topNumMessages
After selecting a mailbox (by calling SelectMailbox), this property will be updated to reflect the total number of emails in the mailbox.
topPeekMode
Set to true to prevent the mail flags (such as the "Seen" flag) from being set when email is retrieved. The default value of this property is false.
topPort
The IMAP port number. If using SSL, be sure to set this to the IMAP SSL port number, which is typically port 993. (If this is the case, make sure you also set the Ssl property = true.
topPreferIpv6
If true, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is false, which will choose IPv4 over IPv6.
topReadTimeout
The maximum amount of time (in seconds) that incoming data is allowed to stall while reading any kind of response from an IMAP server. This is the amount of time that needs to elapse while no additional response bytes are forthcoming. For the case of long responses, if the data stream halts for more than this amount, it will timeout. This property is not a maximum for the total response time, but only a maximum for the amount of time while no response arrives.
The default value is 30 seconds.
topRequireSslCertVerify
If true, then the IMAP client will verify the server's SSL certificate. The certificate is expired, or if the cert's signature is invalid, the connection is not allowed. The default value of this property is false.
topSearchCharset
The "CHARSET" to be used in searches issued by the Search method. The default value is "UTF-8". (If no 8bit chars are found in the search criteria passed to the Search method, then no CHARSET is needed and this property doesn't apply.) The SearchCharset property can be set to "AUTO" to get the pre-v9.4.0 behavior, which is to examine the 8bit chars found in the search criteria and select an appropriate multibyte charset.
In summary, it is unlikely that this property needs to be changed. It should only be modified if trouble arises with some IMAP servers when non-English chars are used in the search criteria.
topSelectedMailbox
The currently selected mailbox, or an empty string if none.
topSendBufferSize
The buffer size to be used with the underlying TCP/IP socket for sending. The default value is 32767.
topSeparatorChar
The separator character used by the IMAP server for the mailbox hierarchy. It is typically "/" or ".", but may vary depending on the IMAP server. The ListMailboxes method has the side-effect of setting this property to the correct value because the IMAP server's response when listing mailboxes includes information about the separator char.
Note: Starting in version 9.5.0.47, this property changed from a "char" type to a "string" type. The separator char property will always be a string of length 1 character.
topSessionLog
Contains an in-memory log of the raw commands sent to the IMAP server, and the raw responses received from the IMAP server. The KeepSessionLog property must be set to true to enable session logging. Call ClearSessionLog to reset the log.
SocksHostname
The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).
topSocksPassword
The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.
topSocksPort
The SOCKS4/SOCKS5 proxy port. The default value is 1080. This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).
topSocksUsername
The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).
topSocksVersion
SocksVersion May be set to one of the following integer values:
0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.
SoRcvBuf
Sets the receive buffer size socket option. Normally, this property should be left unchanged. The default value is 4194304.
This property can be increased if download performance seems slow. It is recommended to be a multiple of 4096.
SoSndBuf
Sets the send buffer size socket option. Normally, this property should be left unchanged. The default value is 262144.
This property can be increased if upload performance seems slow. It is recommended to be a multiple of 4096. Testing with sizes such as 512K and 1MB is reasonable.
Ssl
true if the IMAP connection should be TLS/SSL.
Note: The typical IMAP TLS/SSL port number is 993. If you set this property = true, it is likely that you should also set the Port property = 993.
topSslAllowedCiphers
Provides a means for setting a list of ciphers that are allowed for SSL/TLS connections. The default (empty string) indicates that all implemented ciphers are possible. The TLS ciphers supported in Chilkat v9.5.0.55 and later are:
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256 TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 TLS_DHE_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_RSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_256_CBC_SHA TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 TLS_DHE_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_128_CBC_SHA256 TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA TLS_RSA_WITH_3DES_EDE_CBC_SHA TLS_ECDHE_RSA_WITH_RC4_128_SHA TLS_RSA_WITH_RC4_128_SHA TLS_RSA_WITH_RC4_128_MD5 TLS_DHE_RSA_WITH_DES_CBC_SHA TLS_RSA_WITH_DES_CBC_SHATo restrict SSL/TLS connections to one or more specific ciphers, set this property to a comma-separated list of ciphers such as "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384". The order should be in terms of preference, with the preferred algorithms listed first. (Note that the client cannot specifically choose the algorithm is picked because it is the server that chooses. The client simply provides the server with a list from which to choose.)
The property can also disallow connections with servers having certificates with RSA keys less than a certain size. By default, server certificates having RSA keys of 512 bits or greater are allowed. Add the keyword "rsa1024" to disallow connections with servers having keys smaller than 1024 bits. Add the keyword "rsa2048" to disallow connections with servers having keys smaller than 2048 bits.
Note: Prior to Chilkat v9.5.0.55, it was not possible to explicitly list allowed cipher suites. The deprecated means for indicating allowed ciphers was both incomplete and unprecise. For example, the following keywords could be listed to allow matching ciphers: "aes256-cbc", "aes128-cbc", "3des-cbc", and "rc4". These keywords will still be recognized, but programs should be updated to explicitly list the allowed ciphers.
secure-renegotiation: Starting in Chilkat v9.5.0.55, the keyword "secure-renegotiation" may be added to require that all renegotions be done securely (as per RFC 5746).
best-practices: Starting in Chilkat v9.5.0.55, this property may be set to the single keyword "best-practices". This will allow ciphers based on the current best practices. As new versions of Chilkat are released, the best practices may change. Changes will be noted here. The current best practices are:
- If the server uses an RSA key, it must be 1024 bits or greater.
- All renegotations must be secure renegotiations.
- All ciphers using RC4, DES, or 3DES are disallowed.
Example: The following string would restrict to 2 specific cipher suites, require RSA keys to be 1024 bits or greater, and require secure renegotiations: "TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, rsa1024, secure-renegotiation"
topSslProtocol
Selects the secure protocol to be used for secure (SSL/TLS) connections. Possible values are:
defaultThe default value is "default" which will choose the, which allows for the protocol to be selected dynamically at runtime based on the requirements of the server. Choosing an exact protocol will cause the connection to fail unless that exact protocol is negotiated. It is better to choose "X or higher" than an exact protocol. The "default" is effectively "SSL 3.0 or higher". top
TLS 1.3
TLS 1.2
TLS 1.1
TLS 1.0
SSL 3.0
TLS 1.3 or higher
TLS 1.2 or higher
TLS 1.1 or higher
TLS 1.0 or higher
SslServerCertVerified
Read-only property that returns true if the IMAP server's digital certificate was verified when connecting via SSL / TLS.
topStartTls
If true, then the Connect method will (internallly) convert the connection to TLS/SSL via the STARTTLS IMAP command. This is called "explict SSL/TLS" because the client explicitly requests the connection be transformed into a TLS/SSL secure channel. The alternative is "implicit SSL/TLS" where the "Ssl" property is set to true and the IMAP client connects to the well-known TLS/SSL IMAP port of 993.
topTlsCipherSuite
Contains the current or last negotiated TLS cipher suite. If no TLS connection has yet to be established, or if a connection as attempted and failed, then this will be empty. A sample cipher suite string looks like this: TLS_DHE_RSA_WITH_AES_256_CBC_SHA256.
topTlsPinSet
Specifies a set of pins for Public Key Pinning for TLS connections. This property lists the expected SPKI fingerprints for the server certificates. If the server's certificate (sent during the TLS handshake) does not match any of the SPKI fingerprints, then the TLS handshake is aborted and the connection fails. The format of this string property is as follows:
hash_algorithm, encoding, SPKI_fingerprint_1, SPKI_fingerprint_2, ...For example, the following string specifies a single sha256 base64-encoded SPKI fingerprint:
"sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE="This example specifies two SPKI fingerprints:
"sha256, base64, 4t37LpnGmrMEAG8HEz9yIrnvJV2euVRwCLb9EH5WZyI=, 68b0G5iqMvWVWvUCjMuhLEyekM5729PadtnU5tdXZKs="Any of the following hash algorithms are allowed:.sha1, sha256, sha384, sha512, md2, md5, haval, ripemd128, ripemd160,ripemd256, or ripemd320.
The following encodings are allowed: base64, hex, and any of the encodings indicated in the link below.
TlsVersion
Contains the current or last negotiated TLS protocol version. If no TLS connection has yet to be established, or if a connection as attempted and failed, then this will be empty. Possible values are "SSL 3.0", "TLS 1.0", "TLS 1.1", "TLS 1.2", and "TLS 1.3".
topUidNext
A positive integer value containing the UIDNEXT of the currently selected folder, or 0 if it's not available or no folder is selected.
UidValidity
An integer value containing the UIDVALIDITY of the currently selected mailbox, or 0 if no mailbox is selected.
A client can save the UidValidity value for a mailbox and then compare it with the UidValidity on a subsequent session. If the new value is larger, the IMAP server is not keeping UID's unchanged between sessions. Most IMAP servers maintain UID's between sessions.
topUncommonOptions
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty. Can be set to a list of the following comma separated keywords:
- "ProtectFromVpn" - Introduced in v9.5.0.80. On Android systems, will bypass any VPN that may be installed or active.
- "EnableTls13" - Introduced in v9.5.0.82. Causes TLS 1.3 to be offered in the ClientHello of the TLS protocol, allowing the server to select TLS 1.3 for the session. Future versions of Chilkat will enable TLS 1.3 by default. This option is only necessary in v9.5.0.82 if TLS 1.3 is desired.
VerboseLogging
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.
topVersion
Methods
AddPfxSourceData
Returns true if the underlying TCP socket is connected to the IMAP server.
Returns true for success, false for failure.
topAddPfxSourceFile
Adds a PFX file to the object's internal list of sources to be searched for certificates and private keys when decrypting. Multiple PFX files can be added by calling this method once for each. (On the Windows operating system, the registry-based certificate stores are also automatically searched, so it is commonly not required to explicitly add PFX sources.)
The pfxFilePath contains the bytes of a PFX file (also known as PKCS12 or .p12).
Returns true for success, false for failure.
topAppendMail
Appends an email to an IMAP mailbox.
Returns true for success, false for failure.
AppendMailAsync (1)
Creates an asynchronous task to call the AppendMail method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
AppendMime
Appends an email (represented as MIME text) to an IMAP mailbox.
Returns true for success, false for failure.
AppendMimeAsync (1)
Creates an asynchronous task to call the AppendMime method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topAppendMimeWithDateStr
The same as AppendMimeWithDate, except the date/time is provided in RFC822 string format, such as "Wed, 18 Oct 2017 09:08:21 GMT".
Returns true for success, false for failure.
topAppendMimeWithDateStrAsync (1)
Creates an asynchronous task to call the AppendMimeWithDateStr method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topAppendMimeWithFlags
Same as AppendMime, but allows the flags associated with the email to be set at the same time. A flag is on if true, and off if false.
Returns true for success, false for failure.
topAppendMimeWithFlagsAsync (1)
Creates an asynchronous task to call the AppendMimeWithFlags method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topAppendMimeWithFlagsSb
Same as AppendMimeWithFlags, but the MIME to be uploaded to the IMAP server is passed in a StringBuilder object.
Returns true for success, false for failure.
topAppendMimeWithFlagsSbAsync (1)
Creates an asynchronous task to call the AppendMimeWithFlagsSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topCapability
Sends a CAPABILITY command to the IMAP server and returns the raw response.
Returns null on failure
CapabilityAsync (1)
Creates an asynchronous task to call the Capability method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topCheckConnection
Returns true if the underlying TCP socket is connected to the IMAP server.
Internally, this method makes a lower-level socket system call to check if the TCP socket is still connected.
topCheckForNewEmail
Checks for new email that has arrived since the mailbox was selected (via the SelectMailbox or ExamineMailbox methods), or since the last call to CheckForNewEmail (whichever was most recent). This method works by closing and re-opening the currently selected mailbox, and then sending a "SEARCH" command for either RECENT emails, or emails having a UID greater than the UIDNEXT value. A message set object containing the UID's of the new emails is returned, and this may be passed to methods such as FetchBundle to download the new emails.
Returns null on failure
CheckForNewEmailAsync (1) (2)
Creates an asynchronous task to call the CheckForNewEmail method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topClearSessionLog
Clears the contents of the SessionLog property.
topCloseMailbox
Closes the currently selected mailbox.
Note: The term "mailbox" and "folder" are synonymous. Whenever the word "mailbox" is used, it has the same meaning as "folder".
Returns true for success, false for failure.
topCloseMailboxAsync (1)
Creates an asynchronous task to call the CloseMailbox method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topConnect
Connects to an IMAP server, but does not login. The domainName is the domain name of the IMAP server. (May also use the IPv4 or IPv6 address in string format.)
Important: All TCP-based Internet communications, regardless of the protocol (such as HTTP, FTP, SSH, IMAP, POP3, SMTP, etc.), and regardless of SSL/TLS, begin with establishing a TCP connection to a remote host:port. External security-related infrastructure such as software firewalls (Windows Firewall), hardware firewalls, anti-virus, at either source or destination (or both) can block the connection. If the connection fails, make sure to check all potential external causes of blockage.
Returns true for success, false for failure.
ConnectAsync (1)
Creates an asynchronous task to call the Connect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topCopy
Copies a message from the selected mailbox to copyToMailbox. If bUid is true, then msgId represents a UID. If bUid is false, then msgId represents a sequence number.
Returns true for success, false for failure.
CopyAsync (1)
Creates an asynchronous task to call the Copy method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topCopyMultiple
Same as the Copy method, except an entire set of emails is copied at once. The set of emails is specified in messageSet.
Returns true for success, false for failure.
topCopyMultipleAsync (1)
Creates an asynchronous task to call the CopyMultiple method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topCopySequence
Copies one or more emails from one mailbox to another. The emails are specified as a range of sequence numbers. The 1st email in a mailbox is always at sequence number 1.
Returns true for success, false for failure.
topCopySequenceAsync (1)
Creates an asynchronous task to call the CopySequence method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topCreateMailbox
Creates a new mailbox.
Note: The term "mailbox" and "folder" are synonymous. Whenever the word "mailbox" is used, it has the same meaning as "folder".
Returns true for success, false for failure.
topCreateMailboxAsync (1)
Creates an asynchronous task to call the CreateMailbox method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topDeleteMailbox
Deletes an existing mailbox.
Note: The term "mailbox" and "folder" are synonymous. Whenever the word "mailbox" is used, it has the same meaning as "folder".
Returns true for success, false for failure.
topDeleteMailboxAsync (1)
Creates an asynchronous task to call the DeleteMailbox method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topDisconnect
Disconnects cleanly from the IMAP server. A non-success return from this method only indicates that the disconnect was not clean -- and this can typically be ignored.
Returns true for success, false for failure.
topDisconnectAsync (1)
Creates an asynchronous task to call the Disconnect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topExamineMailbox
Selects a mailbox such that only read-only transactions are allowed. This method would be called instead of SelectMailbox if the logged-on user has read-only permission.
Note: The term "mailbox" and "folder" are synonymous. Whenever the word "mailbox" is used, it has the same meaning as "folder".
Returns true for success, false for failure.
topExamineMailboxAsync (1)
Creates an asynchronous task to call the ExamineMailbox method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topExpunge
Permanently removes from the currently selected mailbox all messages that have the Deleted flag set.
Returns true for success, false for failure.
topExpungeAsync (1)
Creates an asynchronous task to call the Expunge method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topExpungeAndClose
Permanently removes from the currently selected mailbox all messages that have the Deleted flag set, and closes the mailbox.
Returns true for success, false for failure.
topExpungeAndCloseAsync (1)
Creates an asynchronous task to call the ExpungeAndClose method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchAttachment
Downloads one of an email's attachments and saves it to a file. If the emailObject already contains the full email (including the attachments), then no communication with the IMAP server is necessary because the attachment data is already contained within the emailObject. In this case, the attachment is simply extracted and saved to saveToPath. (As with all Chilkat methods, indexing begins at 0. The 1st attachment is at attachmentIndex 0.)
Additional Notes:
If the AutoDownloadAttachments property is set to false, then emails downloaded via any of the Fetch* methods will not include attachments.
Note: "related" items are not considered attachments and are downloaded. These are images, style sheets, etc. that are embedded within the HTML body of an email.
Also: All signed and/or encrypted emails must be downloaded in full.
When an email is downloaded without attachments, the attachment information is included in header fields. The header fields have names beginning with "ckx-imap-". The attachment information can be obtained via the following methods:
imap.GetMailNumAttach
imap.GetMailAttachFilename
imap.GetMailAttachSize
Returns true for success, false for failure.
topFetchAttachmentAsync (1)
Creates an asynchronous task to call the FetchAttachment method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchAttachmentBd
Downloads one of an email's attachments and returns the attachment data in a BinData object. ***See the FetchAttachment method description for more information about fetching attachments.
Returns true for success, false for failure.
topFetchAttachmentBdAsync (1)
Creates an asynchronous task to call the FetchAttachmentBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchAttachmentBytes
Downloads one of an email's attachments and returns the attachment data as in-memory bytes that may be accessed by an application. ***See the FetchAttachment method description for more information about fetching attachments.
Returns null on failure
topFetchAttachmentBytesAsync (1)
Creates an asynchronous task to call the FetchAttachmentBytes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchAttachmentSb
Downloads one of an email's attachments and returns the attachment data in a StringBuilder. It only makes sense to call this method for attachments that contain text data. The charset indicates the character encoding of the text, such as "utf-8" or "windows-1252". ***See the FetchAttachment method description for more information about fetching attachments.
Returns true for success, false for failure.
topFetchAttachmentSbAsync (1)
Creates an asynchronous task to call the FetchAttachmentSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchAttachmentString
Downloads one of an email's attachments and returns the attachment data as a string. It only makes sense to call this method for attachments that contain text data. The charset indicates the character encoding of the text, such as "utf-8" or "windows-1252". ***See the FetchAttachment method description for more information about fetching attachments.
Returns null on failure
topFetchAttachmentStringAsync (1)
Creates an asynchronous task to call the FetchAttachmentString method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchBundle
Retrieves a set of messages from the IMAP server and returns them in an email bundle object. If the method fails, it may return a NULL reference.
Returns null on failure
FetchBundleAsync (1) (2)
Creates an asynchronous task to call the FetchBundle method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchBundleAsMime
Retrieves a set of messages from the IMAP server and returns them in a string array object (NOTE: it does not return a string array, but an object that represents a string array.) Each string within the returned object is the complete MIME source of an email. On failure, a NULL object reference is returned.
Returns null on failure
topFetchBundleAsMimeAsync (1) (2)
Creates an asynchronous task to call the FetchBundleAsMime method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchChunk
Fetches a chunk of emails starting at a specific sequence number. A bundle of fetched emails is returned. The last two arguments are message sets that are updated with the ids of messages successfully/unsuccessfully fetched.
Returns null on failure
topFetchChunkAsync (1) (2)
Creates an asynchronous task to call the FetchChunk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchFlags
Fetches the flags for an email. The bUid argument determines whether the msgId is a UID or sequence number.
Returns the SPACE separated list of flags set for the email, such as "\Flagged \Seen $label1".
If an empty string is returned, then it could be that the email referenced by msgId does not exist in the currently selected mailbox, or it simply has no flags that are set. To determine the difference, examine the contents of the LastResponse property. For the case where the message does not exist, the LastResponse will contain a "NO" and will look something like this:
aaah NO The specified message set is invalid.For the case where the message exists, but no flags are set, the LastResponse will contain an "OK" in the last response line. For example:
... aaah OK FETCH completed.
Returns null on failure
topFetchFlagsAsync (1)
Creates an asynchronous task to call the FetchFlags method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchHeaders
Retrieves a set of message headers from the IMAP server and returns them in an email bundle object. If the method fails, it may return a NULL reference. The following methods are useful for retrieving information about attachments and flags after email headers are retrieved: GetMailNumAttach, GetMailAttachSize, GetMailAttachFilename, GetMailFlag.
Returns null on failure
FetchHeadersAsync (1) (2)
Creates an asynchronous task to call the FetchHeaders method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchSequence
Downloads email for a range of sequence numbers. The 1st email in a mailbox is always at sequence number 1. The total number of emails in the currently selected mailbox is available in the NumMessages property. If the numMessages is too large, the method will still succeed, but will return a bundle of emails from startSeqNum to the last email in the mailbox.
Important: The startSeqNum is a number between 1 and the number of messages in the currently selected folder. Sequence numbers can change during your IMAP session when a message is removed from a folder, either by your session or another one.
Returns null on failure
topFetchSequenceAsync (1) (2)
Creates an asynchronous task to call the FetchSequence method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchSequenceAsMime
Same as FetchSequence, but instead of returning email objects in a bundle, the raw MIME of each email is returned.
Important: The startSeqNum is a number between 1 and the number of messages in the currently selected folder. Sequence numbers can change during your IMAP session when a message is removed from a folder, either by your session or another one.
Returns null on failure
topFetchSequenceAsMimeAsync (1) (2)
Creates an asynchronous task to call the FetchSequenceAsMime method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchSequenceHeaders
Same as FetchSequence, but only the email headers are returned. The email objects within the bundle will be lacking bodies and attachments.
Note: For any method call using sequence numbers, an application must make sure the sequence numbers are within the valid range. When a mailbox is selected, the NumMessages property will have been set, and the valid range of sequence numbers is from 1 to NumMessages. An attempt to fetch sequence numbers outside this range will result in an error.
Important: The startSeqNum is a number between 1 and the number of messages in the currently selected folder. Sequence numbers can change during your IMAP session when a message is removed from a folder, either by your session or another one.
Returns null on failure
FetchSequenceHeadersAsync (1) (2)
Creates an asynchronous task to call the FetchSequenceHeaders method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchSingle
Retrieves a single message from the IMAP server, including attachments if the AutoDownloadAttachments property is true. If bUid is true, then msgId represents a UID. If bUid is false, then msgId represents a sequence number.
Returns null on failure
FetchSingleAsync (1) (2)
Creates an asynchronous task to call the FetchSingle method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchSingleAsMime
Retrieves a single message from the IMAP server and returns a string containing the complete MIME source of the email, including attachments if the AutoDownloadAttachments property is true. If bUid is true, then msgId represents a UID. If bUid is false, then msgId represents a sequence number.
Returns null on failure
FetchSingleAsMimeAsync (1)
Creates an asynchronous task to call the FetchSingleAsMime method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchSingleAsMimeSb
Retrieves a single message from the IMAP server into the sbMime object. If bUid is true, then msgId represents a UID. If bUid is false, then msgId represents a sequence number. If successful, the sbMime will contain the complete MIME of the email, including attachments if the AutoDownloadAttachments property is true.
Returns true for success, false for failure.
topFetchSingleAsMimeSbAsync (1)
Creates an asynchronous task to call the FetchSingleAsMimeSb method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchSingleBd
Retrieves a single message from the IMAP server into the mimeData object.. If bUid is true, then msgId represents a UID. If bUid is false, then msgId represents a sequence number. If successful, the mimeData will contain the complete MIME of the email, including attachments if the AutoDownloadAttachments property is true.
Returns true for success, false for failure.
FetchSingleBdAsync (1)
Creates an asynchronous task to call the FetchSingleBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchSingleHeader
Retrieves a single message header from the IMAP server. If the method fails, it may return a NULL reference. The following methods are useful for retrieving information about attachments and flags after an email header is retrieved: GetMailNumAttach, GetMailAttachSize, GetMailAttachFilename, GetMailFlag. If bUid is true, then msgID represents a UID. If bUid is false, then msgID represents a sequence number.
Returns null on failure
FetchSingleHeaderAsync (1) (2)
Creates an asynchronous task to call the FetchSingleHeader method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topFetchSingleHeaderAsMime
FetchSingleHeaderAsMimeAsync (1)
Creates an asynchronous task to call the FetchSingleHeaderAsMime method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topGetAllUids
Returns a message set object containing all the UIDs in the currently selected mailbox. A NULL object reference is returned on failure.
Returns null on failure
topGetAllUidsAsync (1) (2)
Creates an asynchronous task to call the GetAllUids method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topGetMailAttachFilename
Returns the Nth attachment filename. Indexing begins at 0.
Returns null on failure
GetMailAttachSize
GetMailboxStatus
Sends a "Status" command to get the status of a mailbox. Returns an XML string containing the status values as named attributes. Possible status values are:
- messages: The number of messages in the mailbox.
- recent: The number of messages with the \Recent flag set.
- uidnext: The next unique identifier value of the mailbox.
- uidvalidity: The unique identifier validity value of the mailbox.
- unseen: The number of messages which do not have the \Seen flag set.
An example of the string returned by this method is: <status messages="240" recent="0" uidnext="3674" uidvalidity="3" unseen="213" />
Returns null on failure
topGetMailboxStatusAsync (1)
Creates an asynchronous task to call the GetMailboxStatus method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topGetMailFlag
Returns the value of a flag (1 = yes, 0 = no) for an email. Both standard system flags as well as custom flags may be set. Standard system flags typically begin with a backslash character, such as "\Seen", "\Answered", "\Flagged", "\Draft", "\Deleted", and "\Answered". Custom flags can be anything, such as "NonJunk", "$label1", "$MailFlagBit1", etc. .
GetMailNumAttach
GetMailSize
Returns the size (in bytes) of the entire email including attachments.
GetQuota
Sends the GETQUOTA command and returns the response in JSON format. This feature is only possible with IMAP servers that support the QUOTA extension/capability.
Returns null on failure
GetQuotaAsync (1)
Creates an asynchronous task to call the GetQuota method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topGetQuotaRoot
Sends the GETQUOTAROOT command and returns the response in JSON format. This feature is only possible with IMAP servers that support the QUOTA extension/capability.
Returns null on failure
GetQuotaRootAsync (1)
Creates an asynchronous task to call the GetQuotaRoot method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topGetSslServerCert
Returns the IMAP server's digital certificate (for SSL / TLS connections).
Returns null on failure
topHasCapability
Returns true if the capability indicated by name is found in the capabilityResponse. Otherwise returns false.
IdleCheck
Polls the connection to see if any real-time updates are available. The timeoutMs indicates how long to wait for incoming updates. This method does not send a command to the IMAP server, it simply checks the connection for already-arrived messages that the IMAP server sent. This method would only be called after IDLE has already been started via the IdleStart method.
If updates are available, they are returned in an XML string having the format as shown below. There is one child node for each notification. The possible notifcations are:
- flags -- lists flags that have been set or unset for an email.
- expunge -- provides the sequence number for an email that has been deleted.
- exists -- reports the new number of messages in the currently selected mailbox.
- recent -- reports the new number of messages with the /RECENT flag set.
- raw -- reports an unanticipated response line that was not parsed by Chilkat. This should be reported to support@chilkatoft.com
A sample showing all possible notifications (except for "raw") is shown below.
<idle>
<flags seqnum="59" uid="11876">
<flag>\Deleted</flag>
<flag>\Seen</flag>
</flags>
<flags seqnum="69" uid="11889">
<flag>\Seen</flag>
</flags>
<expunge>58</expunge>
<expunge>58</expunge>
<expunge>67</expunge>
<exists>115</exists>
<recent>0</recent>
</idle>
If no updates have been received, the returned XML string has the following format, as shown below. The
<idle></idle>
NOTE:Once IdleStart has been called, this method can and should be called frequently to see if any updates have arrived. This is NOT the same as polling the IMAP server because it does not send any requests to the IMAP server. It simply checks to see if any messages (i.e. updates) from the IMAP server are available and waiting to be read.
Returns null on failure
IdleCheckAsync (1)
Creates an asynchronous task to call the IdleCheck method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topIdleDone
Sends a command to the IMAP server to stop receiving real-time updates.
Returns true for success, false for failure.
IdleDoneAsync (1)
Creates an asynchronous task to call the IdleDone method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topIdleStart
Sends an IDLE command to the IMAP server to begin receiving real-time updates.
Returns true for success, false for failure.
IdleStartAsync (1)
Creates an asynchronous task to call the IdleStart method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topIsConnected
Returns the last known "connected" state with the IMAP server. IsConnected does not send a message to the IMAP server to determine if it is still connected. The Noop method may be called to specifically send a no-operation message to determine actual connectivity.
The IsConnected method is useful for checking to see if the component is already in a known disconnected state.
topIsLoggedIn
Returns true if already logged into an IMAP server, otherwise returns false.
topListMailboxes
Returns a subset of the complete list of mailboxes available on the IMAP server. This method has the side-effect of setting the SeparatorChar property to the correct character used by the IMAP server, which is typically "/" or ".".
Note: The term "mailbox" and "folder" are synonymous. Whenever the word "mailbox" is used, it has the same meaning as "folder".
The reference and wildcardedMailbox parameters are passed unaltered to the IMAP LIST command:
<font size="2" face="MS Sans Serif">
<b>FROM RFC 3501 (IMAP Protocol)</b>
The LIST command returns a subset of names from the complete set
of all names available to the client. Zero or more untagged LIST
replies are returned, containing the name attributes, hierarchy
delimiter, and name; see the description of the LIST reply for
more detail.
An empty ("" string) reference name argument indicates that the
mailbox name is interpreted as by SELECT. The returned mailbox
names MUST match the supplied mailbox name pattern. A non-empty
reference name argument is the name of a mailbox or a level of
mailbox hierarchy, and indicates the context in which the mailbox
name is interpreted.
An empty ("" string) mailbox name argument is a special request to
return the hierarchy delimiter and the root name of the name given
in the reference. The value returned as the root MAY be the empty
string if the reference is non-rooted or is an empty string. In
all cases, a hierarchy delimiter (or NIL if there is no hierarchy)
is returned. This permits a client to get the hierarchy delimiter
(or find out that the mailbox names are flat) even when no
mailboxes by that name currently exist.
The reference and mailbox name arguments are interpreted into a
canonical form that represents an unambiguous left-to-right
hierarchy. The returned mailbox names will be in the interpreted
form.
Note: The interpretation of the reference argument is
implementation-defined. It depends upon whether the
server implementation has a concept of the "current
working directory" and leading "break out characters",
which override the current working directory.
For example, on a server which exports a UNIX or NT
filesystem, the reference argument contains the current
working directory, and the mailbox name argument would
contain the name as interpreted in the current working
directory.
If a server implementation has no concept of break out
characters, the canonical form is normally the reference
name appended with the mailbox name. Note that if the
server implements the namespace convention (section
5.1.2), "#" is a break out character and must be treated
as such.
If the reference argument is not a level of mailbox
hierarchy (that is, it is a \NoInferiors name), and/or
the reference argument does not end with the hierarchy
delimiter, it is implementation-dependent how this is
interpreted. For example, a reference of "foo/bar" and
mailbox name of "rag/baz" could be interpreted as
"foo/bar/rag/baz", "foo/barrag/baz", or "foo/rag/baz".
A client SHOULD NOT use such a reference argument except
at the explicit request of the user. A hierarchical
browser MUST NOT make any assumptions about server
interpretation of the reference unless the reference is
a level of mailbox hierarchy AND ends with the hierarchy
delimiter.
Any part of the reference argument that is included in the
interpreted form SHOULD prefix the interpreted form. It SHOULD
also be in the same form as the reference name argument. This
rule permits the client to determine if the returned mailbox name
is in the context of the reference argument, or if something about
the mailbox argument overrode the reference argument. Without
this rule, the client would have to have knowledge of the server's
naming semantics including what characters are "breakouts" that
override a naming context.
For example, here are some examples of how references
and mailbox names might be interpreted on a UNIX-based
server:
Reference Mailbox Name Interpretation
------------ ------------ --------------
~smith/Mail/ foo.* ~smith/Mail/foo.*
archive/ % archive/%
#news. comp.mail.* #news.comp.mail.*
~smith/Mail/ /usr/doc/foo /usr/doc/foo
archive/ ~fred/Mail/* ~fred/Mail/*
The first three examples demonstrate interpretations in
the context of the reference argument. Note that
"~smith/Mail" SHOULD NOT be transformed into something
like "/u2/users/smith/Mail", or it would be impossible
for the client to determine that the interpretation was
in the context of the reference.
The character "*" is a wildcard, and matches zero or more
characters at this position. The character "%" is similar to "*",
but it does not match a hierarchy delimiter. If the "%" wildcard
is the last character of a mailbox name argument, matching levels
of hierarchy are also returned. If these levels of hierarchy are
not also selectable mailboxes, they are returned with the
\Noselect mailbox name attribute (see the description of the LIST
response for more details).
Server implementations are permitted to "hide" otherwise
accessible mailboxes from the wildcard characters, by preventing
certain characters or names from matching a wildcard in certain
situations. For example, a UNIX-based server might restrict the
interpretation of "*" so that an initial "/" character does not
match.
The special name INBOX is included in the output from LIST, if
INBOX is supported by this server for this user and if the
uppercase string "INBOX" matches the interpreted reference and
mailbox name arguments with wildcards as described above. The
criteria for omitting INBOX is whether SELECT INBOX will return
failure; it is not relevant whether the user's real INBOX resides
on this or some other server.
</font>Returns null on failure
ListMailboxesAsync (1) (2)
Creates an asynchronous task to call the ListMailboxes method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topListSubscribed
The same as ListMailboxes, but returns only the subscribed mailboxes. (See ListMailboxes for more information.)
Returns null on failure
ListSubscribedAsync (1) (2)
Creates an asynchronous task to call the ListSubscribed method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topLoadTaskCaller
Login
Logs into the IMAP server. The component must first be connected to an IMAP server by calling Connect. If XOAUTH2 authentication is required, pass the XOAUTH2 access token in place of the password. (For GMail, the Chilkat HTTP class/object's G_SvcOauthAccessToken method can be called to obtain an XOAUTH2 access token.)
To authenticate using XOAUTH2, make sure the AuthMethod property is set to "XOAUTH2". The XOAUTH2 authentication functionality was added in version 9.5.0.44.
Returns true for success, false for failure.
LoginAsync (1)
Creates an asynchronous task to call the Login method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topLoginSecure
The same as Login, except the login name and password are passed as secure strings.
Returns true for success, false for failure.
LoginSecureAsync (1)
Creates an asynchronous task to call the LoginSecure method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topLogout
LogoutAsync (1)
Creates an asynchronous task to call the Logout method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topMoveMessages
Moves a set of messages from one mailbox to another. Note: This is only possible if the IMAP server supports the "MOVE" extension. The messageSet contains message UIDs or sequence numbers for messages in the currently selected mailbox. The destFolder is the destination mailbox/folder.
Returns true for success, false for failure.
MoveMessagesAsync (1)
Creates an asynchronous task to call the MoveMessages method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topNoop
Sends a NOOP command to the IMAP server and receives the response. The component must be connected and authenticated for this to succeed. Sending a NOOP is a good way of determining whether the connection to the IMAP server is up and active.
Returns true for success, false for failure.
topNoopAsync (1)
Creates an asynchronous task to call the Noop method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topRefetchMailFlags
Fetches the flags for an email and updates the flags in the email's header. When an email is retrieved from the IMAP server, it embeds the flags into the header in fields beginning with "ckx-". Methods such as GetMailFlag read these header fields.
Returns true for success, false for failure.
topRefetchMailFlagsAsync (1)
Creates an asynchronous task to call the RefetchMailFlags method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topRenameMailbox
Renames a mailbox. Can also be used to move a mailbox from one location to another. For example, from "Inbox.parent.test" to "Inbox.newParent.test", or from "abc.xyz" to "def.qrs".
Returns true for success, false for failure.
topRenameMailboxAsync (1)
Creates an asynchronous task to call the RenameMailbox method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSearch
Searches the already selected mailbox for messages that match criteria and returns a message set of all matching messages. If bUid is true, then UIDs are returned in the message set, otherwise sequence numbers are returned.
Note: It seems that Microsoft IMAP servers, such as outlook.office365.com and imap-mail.outlook.com do not support anything other than 7bit us-ascii chars in the search criteria string, regardless of the SEARCH charset that might be specified.
The criteria is passed through to the low-level IMAP protocol unmodified, so the rules for the IMAP SEARCH command (RFC 3501) apply and are reproduced here:
<font size="2" face="MS Sans Serif">
<b>FROM RFC 3501 (IMAP Protocol)</b>
The SEARCH command searches the mailbox for messages that match
the given searching criteria. Searching criteria consist of one
or more search keys. The untagged SEARCH response from the server
contains a listing of message sequence numbers corresponding to
those messages that match the searching criteria.
When multiple keys are specified, the result is the intersection
(AND function) of all the messages that match those keys. For
example, the criteria DELETED FROM "SMITH" SINCE 1-Feb-1994 refers
to all deleted messages from Smith that were placed in the mailbox
since February 1, 1994. A search key can also be a parenthesized
list of one or more search keys (e.g., for use with the OR and NOT
keys).
Server implementations MAY exclude [MIME-IMB] body parts with
terminal content media types other than TEXT and MESSAGE from
consideration in SEARCH matching.
The OPTIONAL [CHARSET] specification consists of the word
"CHARSET" followed by a registered [CHARSET]. It indicates the
[CHARSET] of the strings that appear in the search criteria.
[MIME-IMB] content transfer encodings, and [MIME-HDRS] strings in
[RFC-2822]/[MIME-IMB] headers, MUST be decoded before comparing
text in a [CHARSET] other than US-ASCII. US-ASCII MUST be
supported; other [CHARSET]s MAY be supported.
If the server does not support the specified [CHARSET], it MUST
return a tagged NO response (not a BAD). This response SHOULD
contain the BADCHARSET response code, which MAY list the
[CHARSET]s supported by the server.
In all search keys that use strings, a message matches the key if
the string is a substring of the field. The matching is
case-insensitive.
The defined search keys are as follows. Refer to the Formal
Syntax section for the precise syntactic definitions of the
arguments.
Messages with message sequence numbers corresponding to the
specified message sequence number set.
ALL
All messages in the mailbox; the default initial key for
ANDing.
ANSWERED
Messages with the \Answered flag set.
BCC
Messages that contain the specified string in the envelope
structure's BCC field.
BEFORE
Messages whose internal date (disregarding time and timezone)
is earlier than the specified date.
BODY
Messages that contain the specified string in the body of the
message.
CC
Messages that contain the specified string in the envelope
structure's CC field.
DELETED
Messages with the \Deleted flag set.
DRAFT
Messages with the \Draft flag set.
FLAGGED
Messages with the \Flagged flag set.
FROM
Messages that contain the specified string in the envelope
structure's FROM field.
HEADER
Messages that have a header with the specified field-name (as
defined in [RFC-2822]) and that contains the specified string
in the text of the header (what comes after the colon). If the
string to search is zero-length, this matches all messages that
have a header line with the specified field-name regardless of
the contents.
KEYWORD
Messages with the specified keyword flag set.
LARGER
Messages with an [RFC-2822] size larger than the specified
number of octets.
NEW
Messages that have the \Recent flag set but not the \Seen flag.
This is functionally equivalent to "(RECENT UNSEEN)".
NOT
Messages that do not match the specified search key.
OLD
Messages that do not have the \Recent flag set. This is
functionally equivalent to "NOT RECENT" (as opposed to "NOT
NEW").
ON
Messages whose internal date (disregarding time and timezone)
is within the specified date.
OR
Messages that match either search key.
RECENT
Messages that have the \Recent flag set.
SEEN
Messages that have the \Seen flag set.
SENTBEFORE
Messages whose [RFC-2822] Date: header (disregarding time and
timezone) is earlier than the specified date.
SENTON
Messages whose [RFC-2822] Date: header (disregarding time and
timezone) is within the specified date.
SENTSINCE
Messages whose [RFC-2822] Date: header (disregarding time and
timezone) is within or later than the specified date.
SINCE
Messages whose internal date (disregarding time and timezone)
is within or later than the specified date.
SMALLER
Messages with an [RFC-2822] size smaller than the specified
number of octets.
SUBJECT
Messages that contain the specified string in the envelope
structure's SUBJECT field.
TEXT
Messages that contain the specified string in the header or
body of the message.
TO
Messages that contain the specified string in the envelope
structure's TO field.
UID
Messages with unique identifiers corresponding to the specified
unique identifier set. Sequence set ranges are permitted.
UNANSWERED
Messages that do not have the \Answered flag set.
UNDELETED
Messages that do not have the \Deleted flag set.
UNDRAFT
Messages that do not have the \Draft flag set.
UNFLAGGED
Messages that do not have the \Flagged flag set.
UNKEYWORD
Messages that do not have the specified keyword flag set.
UNSEEN
Messages that do not have the \Seen flag set.
</font>Returns null on failure
SearchAsync (1) (2)
Creates an asynchronous task to call the Search method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSelectMailbox
Selects a mailbox. A mailbox must be selected before some methods, such as Search or FetchSingle, can be called. If the logged-on user does not have write-access to the mailbox, call ExamineMailbox instead.
Calling this method updates the NumMessages property.
Note: The term "mailbox" and "folder" are synonymous. Whenever the word "mailbox" is used, it has the same meaning as "folder".
Returns true for success, false for failure.
SelectMailboxAsync (1)
Creates an asynchronous task to call the SelectMailbox method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSendRawCommand
Allows for the sending of arbitrary commands to the IMAP server.
Returns null on failure
SendRawCommandAsync (1)
Creates an asynchronous task to call the SendRawCommand method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSendRawCommandB
The same as SendRawCommand, but instead of returning the response as a string, the binary bytes of the response are returned.
Returns null on failure
topSendRawCommandBAsync (1)
Creates an asynchronous task to call the SendRawCommandB method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSendRawCommandC
The same as SendRawCommandB, except that the command is provided as binary bytes rather than a string.
Returns null on failure
topSendRawCommandCAsync (1)
Creates an asynchronous task to call the SendRawCommandC method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSetDecryptCert
Explicitly specifies the certificate to be used for decrypting encrypted email.
Returns true for success, false for failure.
topSetDecryptCert2
Used to explicitly specify the certificate and associated private key to be used for decrypting S/MIME (PKCS7) email.
Returns true for success, false for failure.
topSetFlag
Sets a flag for a single message on the IMAP server. If value = 1, the flag is turned on, if value = 0, the flag is turned off. Standard system flags such as "\Deleted", "\Seen", "\Answered", "\Flagged", "\Draft", and "\Answered" may be set. Custom flags such as "NonJunk", "$label1", "$MailFlagBit1", etc. may also be set.
If bUid is true, then msgId represents a UID. If bUid is false, then msgId represents a sequence number.
Returns true for success, false for failure.
SetFlagAsync (1)
Creates an asynchronous task to call the SetFlag method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSetFlags
Sets a flag for each message in the message set on the IMAP server. If value = 1, the flag is turned on, if value = 0, the flag is turned off. Standard system flags such as "\Deleted", "\Seen", "\Answered", "\Flagged", "\Draft", and "\Answered" may be set. Custom flags such as "NonJunk", "$label1", "$MailFlagBit1", etc. may also be set.
Returns true for success, false for failure.
topSetFlagsAsync (1)
Creates an asynchronous task to call the SetFlags method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSetMailFlag
Sets a flag for a single message on the IMAP server. The UID of the email object is used to find the message on the IMAP server that is to be affected. If value = 1, the flag is turned on, if value = 0, the flag is turned off.
Both standard system flags as well as custom flags may be set. Standard system flags typically begin with a backslash character, such as "\Deleted", "\Seen", "\Answered", "\Flagged", "\Draft", and "\Answered". Custom flags can be anything, such as "NonJunk", "$label1", "$MailFlagBit1", etc. .
Note: When the Chilkat IMAP component downloads an email from an IMAP server, it inserts a "ckx-imap-uid" header field in the email object. This is subsequently used by this method to get the UID associated with the email. The "ckx-imap-uid" header must be present for this method to be successful.
Note: Calling this method is identical to calling the SetFlag method, except the UID is automatically obtained from the email object.
Important: Setting the "Deleted" flag does not remove the email from the mailbox. Emails marked "Deleted" are removed when the Expunge method is called.
Returns true for success, false for failure.
topSetMailFlagAsync (1)
Creates an asynchronous task to call the SetMailFlag method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSetQuota
Sets the quota for a quotaRoot. The resource should be one of two keywords:"STORAGE" or "MESSAGE". Use "STORAGE" to set the maximum capacity of the combined messages in quotaRoot. Use "MESSAGE" to set the maximum number of messages allowed.
If setting a STORAGE quota, the quota is in units of 1024 octets. For example, to specify a limit of 500,000,000 bytes, set quota equal to 500,000.
This feature is only possible with IMAP servers that support the QUOTA extension/capability. If an IMAP server supports the QUOTA extension, it likely supports the STORAGE resource. The MESSAGE resource is less commonly supported.
topSetQuotaAsync (1)
Creates an asynchronous task to call the SetQuota method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSetSslClientCert
Specifies a client-side certificate to be used for the SSL / TLS connection. In most cases, servers do not require client-side certificates for SSL/TLS. A client-side certificate is typically used in high-security situations where the certificate is an additional means to indentify the client to the server.
Returns true for success, false for failure.
topSetSslClientCertPem
(Same as SetSslClientCert, but allows a .pfx/.p12 file to be used directly) Specifies a client-side certificate to be used for the SSL / TLS connection. In most cases, servers do not require client-side certificates for SSL/TLS. A client-side certificate is typically used in high-security situations where the certificate is an additional means to indentify the client to the server.
The pemDataOrFilename may contain the actual PEM data, or it may contain the path of the PEM file. This method will automatically recognize whether it is a path or the PEM data itself.
Returns true for success, false for failure.
SetSslClientCertPfx
(Same as SetSslClientCert, but allows a .pfx/.p12 file to be used directly) Specifies a client-side certificate to be used for the SSL / TLS connection. In most cases, servers do not require client-side certificates for SSL/TLS. A client-side certificate is typically used in high-security situations where the certificate is an additional means to indentify the client to the server.
Returns true for success, false for failure.
topSort
Searches the already selected mailbox for messages that match searchCriteria and returns a message set of all matching messages in the order specified by sortCriteria. If bUid is true, then UIDs are returned in the message set, otherwise sequence numbers are returned.
The sortCriteria is a string of SPACE separated keywords to indicate sort order (default is ascending). The keyword "REVERSE" can precede a keyword to reverse the sort order (i.e. make it descending). Possible sort keywords are:
- ARRIVAL
- CC
- DATE
- FROM
- SIZE
- SUBJECT
- TO
Some examples of sortCriteria are:
- "SUBJECT REVERSE DATE"
- "REVERSE SIZE"
- "ARRIVAL"
The searchCriteria is passed through to the low-level IMAP protocol unmodified, and therefore the rules for the IMAP SEARCH command (RFC 3501) apply. See the documentation for the Search method for more details (and also see RFC 3501).
Returns null on failure
topSortAsync (1) (2)
Creates an asynchronous task to call the Sort method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSshAuthenticatePk
Authenticates with the SSH server using public-key authentication. The corresponding public key must have been installed on the SSH server for the sshLogin. Authentication will succeed if the matching privateKey is provided.
Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.
Returns true for success, false for failure.
topSshAuthenticatePkAsync (1)
Creates an asynchronous task to call the SshAuthenticatePk method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSshAuthenticatePw
Authenticates with the SSH server using a sshLogin and sshPassword.
An SSH tunneling (port forwarding) session always begins by first calling SshTunnel to connect to the SSH server, then calling either AuthenticatePw or AuthenticatePk to authenticate. Following this, your program should call Connect to connect with the IMAP server (via the SSH tunnel) and then Login to authenticate with the IMAP server.
Note: Once the SSH tunnel is setup by calling SshTunnel and SshAuthenticatePw (or SshAuthenticatePk), all underlying communcations with the IMAP server use the SSH tunnel. No changes in programming are required other than making two initial calls to setup the tunnel.
Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.
Returns true for success, false for failure.
SshAuthenticatePwAsync (1)
Creates an asynchronous task to call the SshAuthenticatePw method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSshCloseTunnel
Closes the SSH tunnel previously opened by SshOpenTunnel.
Returns true for success, false for failure.
topSshCloseTunnelAsync (1)
Creates an asynchronous task to call the SshCloseTunnel method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSshOpenTunnel
Connects to an SSH server and creates a tunnel for IMAP. The sshHostname is the hostname (or IP address) of the SSH server. The sshPort is typically 22, which is the standard SSH port number.
An SSH tunneling (port forwarding) session always begins by first calling SshOpenTunnel to connect to the SSH server, followed by calling either SshAuthenticatePw or SshAuthenticatePk to authenticate. Your program would then call Connect to connect with the IMAP server (via the SSH tunnel) and then Login to authenticate with the IMAP server.
Note: Once the SSH tunnel is setup by calling SshOpenTunnel and SshAuthenticatePw (or SshAuthenticatePk), all underlying communcations with the IMAP server use the SSH tunnel. No changes in programming are required other than making two initial calls to setup the tunnel.
Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.
Returns true for success, false for failure.
SshOpenTunnelAsync (1)
Creates an asynchronous task to call the SshOpenTunnel method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topStoreFlags
Sets one or more flags to a specific value for an email. The email is indicated by either a UID or sequence number, depending on whether bUid is true (UID) or false (sequence number).
flagNames should be a space separated string of flag names. Both standard and customer flags may be set. Standard flag names typically begin with a backslash character. For example: "\Seen \Answered". Custom flag names may also be included. Custom flags often begin with a $ character, such as "$label1", or "$MailFlagBit0". Other customer flags may begin with any character, such as "NonJunk".
value should be 1 to turn the flags on, or 0 to turn the flags off.
Returns true for success, false for failure.
topStoreFlagsAsync (1)
Creates an asynchronous task to call the StoreFlags method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topSubscribe
Subscribe to an IMAP mailbox.
Note: The term "mailbox" and "folder" are synonymous. Whenever the word "mailbox" is used, it has the same meaning as "folder".
Returns true for success, false for failure.
SubscribeAsync (1)
Creates an asynchronous task to call the Subscribe method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topThreadCmd
Sends the THREAD command to search the already selected mailbox for messages that match searchCriteria.
The following explanation is from RFC 5256 :
The THREAD command is a variant of SEARCH with threading semantics
for the results. Thread has two arguments before the searching
criteria argument: a threading algorithm and the searching
charset.
The THREAD command first searches the mailbox for messages that
match the given searching criteria using the charset argument for
the interpretation of strings in the searching criteria. It then
returns the matching messages in an untagged THREAD response,
threaded according to the specified threading algorithm.
All collation is in ascending order. Earlier dates collate before
later dates and strings are collated according to ascending values.
The defined threading algorithms are as follows:
ORDEREDSUBJECT
The ORDEREDSUBJECT threading algorithm is also referred to as
"poor man's threading". The searched messages are sorted by
base subject and then by the sent date. The messages are then
split into separate threads, with each thread containing
messages with the same base subject text. Finally, the threads
are sorted by the sent date of the first message in the thread.
The top level or "root" in ORDEREDSUBJECT threading contains
the first message of every thread. All messages in the root
are siblings of each other. The second message of a thread is
the child of the first message, and subsequent messages of the
thread are siblings of the second message and hence children of
the message at the root. Hence, there are no grandchildren in
ORDEREDSUBJECT threading.
Children in ORDEREDSUBJECT threading do not have descendents.
Client implementations SHOULD treat descendents of a child in a
server response as being siblings of that child.
REFERENCES
The REFERENCES threading algorithm threads the searched
messages by grouping them together in parent/child
relationships based on which messages are replies to others.
The parent/child relationships are built using two methods:
reconstructing a message's ancestry using the references
contained within it; and checking the original (not base)
subject of a message to see if it is a reply to (or forward of)
another message.
See RFC 5256 for more details:
The searchCriteria is passed through to the low-level IMAP protocol unmodified, and therefore the rules for the IMAP SEARCH command (RFC 3501) apply. See the documentation for the Search method for more details (and also see RFC 3501).
The results are returned in a JSON object to make it easy to parse the parent/child relationships. See the example below for details.
Returns null on failure
ThreadCmdAsync (1) (2)
Creates an asynchronous task to call the ThreadCmd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topUnsubscribe
Unsubscribe from an IMAP mailbox.
Returns true for success, false for failure.
UnsubscribeAsync (1)
Creates an asynchronous task to call the Unsubscribe method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)
Returns null on failure
topUseCertVault
Adds an XML certificate vault to the object's internal list of sources to be searched for certificates and private keys when encrypting/decrypting or signing/verifying. Unlike the AddPfxSourceData and AddPfxSourceFile methods, only a single XML certificate vault can be used. If UseCertVault is called multiple times, only the last certificate vault will be used, as each call to UseCertVault will replace the certificate vault provided in previous calls.
Returns true for success, false for failure.
topUseSsh
Uses an existing SSH tunnel for the connection to the IMAP server. This method is identical to the UseSshTunnel method, except the SSH connection is obtained from an SSH object instead of a Socket object.
This is useful for sharing an existing SSH tunnel connection wth other objects. (SSH is a protocol where the tunnel contains many logical channels. IMAP connections can exist simultaneously with other connection within a single SSH tunnel as SSH channels.)
Returns true for success, false for failure.
UseSshTunnel
Uses an existing SSH tunnel. This is useful for sharing an existing SSH tunnel connection wth other objects. (SSH is a protocol where the tunnel contains many logical channels. IMAP connections can exist simultaneously with other connection within a single SSH tunnel as SSH channels.)
Returns true for success, false for failure.