MailMan

Set this property to TRUE to request that the currently running operation be aborted.

This applies to methods that may take time to complete, such as methods that perform network communication or lengthy file operations. Methods that always complete quickly are generally not affected.

If no method is currently running, the property is automatically reset to FALSE when the next method call begins. When an abort actually occurs, Chilkat resets this property to FALSE.

Both synchronous and asynchronous method calls can be aborted. A synchronous method can be aborted by setting this property from another thread.

Controls whether an email should be sent when one or more recipients are rejected by the SMTP server.

The default value is FALSE, which means Chilkat continues sending even if some recipients are rejected.

When set to TRUE, the email is not sent to any recipients if the SMTP server rejects any recipient address.

Important: This property only works when SMTP pipelining is disabled. Because SmtpPipelining is TRUE by default, set SmtpPipelining = FALSE when all-or-none behavior is required.

Note: SMTP servers do not always verify recipient addresses. Even when they do, the server can usually verify only addresses within domains it controls.

When TRUE, Chilkat automatically adjusts common SMTP and POP3 SSL/TLS settings based on the configured port numbers.

• If SmtpPort = 465, Chilkat sets StartTLS = FALSE and SmtpSsl = TRUE.
• If SmtpPort = 25, Chilkat sets SmtpSsl = FALSE.
• If MailPort = 995, Chilkat sets PopSsl = TRUE.
• If MailPort = 110, Chilkat sets PopSsl = FALSE.

The default value is TRUE.

Controls whether Chilkat automatically generates a unique Message-ID header when an email is sent.

The default behavior is to generate a new unique Message-ID at send time. This allows the same Email object to be reused without accidentally sending duplicate message IDs.

If duplicate message IDs are used, some SMTP servers may treat the message as a duplicate and discard it.

When automatic generation is enabled, calling GetHeaderField("Message-ID") before sending will not necessarily show the actual message ID that Chilkat sends.

Set this property to FALSE to prevent Chilkat from automatically generating the Message-ID header.

When TRUE, Chilkat automatically sends the SMTP RSET command before sending a new email over an already-open SMTP connection.

This helps ensure the SMTP session is in a clean state before the next email is sent.

The default value is FALSE.

Note: This property only applies when reusing an existing SMTP connection.

Controls whether Chilkat automatically unwraps digitally signed or encrypted email when the message is downloaded or loaded from MIME.

The default value is TRUE. When enabled, Chilkat verifies signatures and decrypts encrypted content when possible. The results are made available through the email object's security-related properties and methods.

Set this property to FALSE if you want signed or encrypted attachments, such as .p7m or .p7s files, to remain as ordinary attachments.

Important: Signature verification and decryption must occur when the original MIME is first loaded. After MIME is parsed into Chilkat's internal email object format, the exact original MIME bytes are no longer available, and the signature can no longer be verified.

Specifies the local IP address to use when connecting from a computer that has multiple network interfaces or multiple IP addresses.

For most computers, this property should be left unset. Chilkat will automatically use the default local IP address.

The value should be a numeric IP address, such as 165.164.55.124, not a hostname.

Contains a numeric code describing the result of the last connection attempt. This applies to the last connection made, or attempted, by any method.

The maximum number of seconds to wait while attempting to connect to an SMTP or POP3 server.

The default value is 30 seconds.

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.

The DsnEnvid property specifies the SMTP DSN ENVID value, which is an arbitrary identifier attached to the SMTP envelope. The same value is typically returned in DSN responses so the sending application can correlate delivery notifications with the original outbound email.

Common choices for DsnEnvid include:

• An internal message ID:

  MSG-10004521

• A GUID or UUID:

  550e8400-e29b-41d4-a716-446655440000

• An order or transaction number:

  ORDER-847291

• A timestamp-based identifier:

  MAIL-20260515-153045-001

• A composite identifier combining application, customer, and message IDs:

  billing|cust-9182|invoice-44381

The value should uniquely identify the outbound email within your application. It does not need to match the MIME Message-ID header, although some applications choose to use the same identifier for both.

About SMTP DSN

SMTP DSN means Delivery Status Notification. It is an optional SMTP service extension defined by RFC 3461 that allows the sender to request delivery-status reports from the SMTP server.

DSN allows an application to request notifications such as:

• Successful delivery
• Delivery failure
• Delayed delivery

It also allows the sender to specify whether the returned notification should include the full original message or only the message headers.

In Chilkat.MailMan, DSN behavior is controlled using:

• DsnEnvid — sets the SMTP ENVID envelope identifier.
• DsnNotify — controls when notifications are requested, such as SUCCESS, FAILURE, DELAY, or NEVER.
• DsnRet — controls whether DSN responses include the full message or only headers.

DSN is an optional SMTP extension and is not supported by all SMTP servers. A server supports DSN only if it advertises the DSN capability in response to the SMTP EHLO command.

The IsSmtpDsnCapable method can be used to determine whether the SMTP server supports DSN.

Even when DSN is supported, some SMTP servers or downstream mail systems may ignore or partially honor DSN requests.

Specifies the SMTP DSN NOTIFY parameter used when sending email.

The value may be left empty, set to NEVER, or set to a comma-separated combination of SUCCESS, FAILURE, and DELAY.

Specifies the SMTP DSN RET parameter used when sending email.

The value may be left empty, set to FULL to request the full message in DSN notifications, or set to HDRS to request only the message headers.

When TRUE, Chilkat embeds the signing certificate chain in signed email.

Certificates are included up to, but not including, the root certificate. If IncludeRootCert is also TRUE, the root CA certificate is included as well.

The default value is FALSE

Enables automatic resolution of passwords and credentials from secure local storage.

When set to TRUE, supported properties and methods can accept a Chilkat secret specification string instead of a literal password. Secret specification strings begin with !!.

Chilkat resolves secrets from:

• Windows Credential Manager on Windows.
• Apple Keychain on macOS.

The secret specification format is: !![appName|]service[|domain]|username

This applies to PopPassword, SmtpPassword, HttpProxyPassword, SocksPassword, PopPasswordBase64, and SshAuthenticatePw.

The default value is FALSE.

Specifies a filter expression applied by methods such as LoadXmlFile, LoadXmlString, LoadMbx, CopyMail, and TransferMail.

When a filter is present, only emails matching the expression are returned. For TransferMail, only matching emails are removed from the mail server.

Example expressions:

Body like "mortgage rates*"
Subject contains "update" and From contains "chilkat"
To = "info@chilkatsoft.com"

Rules for filter expressions:

• Any MIME header field name may be used. Header names are case-insensitive.
• Literal strings are enclosed in double quotes.
• String matching is case-insensitive.
• The * wildcard matches zero or more characters.
• Parentheses may be used to control precedence.
• Logical operators are AND, OR, and NOT.
• String comparison operators include CONTAINS and LIKE.

Note: Filtering works on text strings only, not dates or numbers.

Specifies the interval, in milliseconds, between AbortCheck event callbacks.

This allows an application to periodically decide whether a long-running operation should be aborted.

The default value is 0, which means no AbortCheck callbacks are generated.

Specifies the hostname sent in the SMTP EHLO or HELO command.

The default value is an empty string, which causes Chilkat to use the local computer's hostname.

HttpProxyAuthMethod

Specifies the authentication method used when connecting through an HTTP proxy that requires authentication.

Valid values are Basic and NTLM.

Specifies the optional NTLM domain when using NTLM authentication with an HTTP proxy.

Specifies the hostname or IPv4 address of the HTTP proxy to use.

Specifies the password used when authenticating to an HTTP proxy.

Specifies the port number of the HTTP proxy.

Common HTTP proxy ports include 8080 and 3128.

Specifies the username used when authenticating to an HTTP proxy.

Controls whether POP3 deletions are finalized immediately.

The default value is TRUE. When enabled, any method that deletes email from the POP3 server also sends a QUIT command and closes the POP3 session so the deletion is committed immediately.

In POP3, the DELE command only marks a message for deletion. The message is not actually deleted until the session ends with QUIT.

If ImmediateDelete is set to FALSE, your application must call Pop3EndSession to finalize the deletions.

Controls whether the root CA certificate is included in the S/MIME signature of a signed email.

This property only applies when EmbedCertChain is TRUE.

Returns TRUE if Chilkat believes the POP3 connection is still open.

Accessing this property does not send any command to the POP3 server. If the server has disconnected but Chilkat has not yet attempted further communication, this property may still return TRUE.

To verify that the POP3 connection is actually alive, call Pop3Noop.

Returns TRUE if Chilkat believes the SMTP connection is still open.

Accessing this property does not communicate with the SMTP server. A lost connection may not be detected until the next SMTP command is sent.

To verify that the SMTP connection is actually alive, call SmtpNoop.

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

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

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

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.

Contains the last SMTP status code returned by the SMTP server during the most recent SMTP operation.

SMTP status codes are numeric reply codes defined by the SMTP protocol. They indicate the result of SMTP protocol commands such as EHLO, AUTH, MAIL FROM, RCPT TO, and DATA.

In general:

• 2xx — Success. The requested action completed successfully.
• 3xx — Intermediate success. Additional information or authentication data is required.
• 4xx — Temporary failure. The operation failed, but retrying later may succeed.
• 5xx — Permanent failure. The request was rejected and retrying will usually not help unless something changes.

Contains the text message associated with the last SMTP status code received from the server.

Specifies a local file path where Chilkat writes each message exactly as it was received from the POP3 server.

This is useful for debugging problems involving MIME structure, encodings, attachments, or server behavior.

Specifies a local file path where Chilkat writes the exact MIME message sent to the SMTP server.

This is useful for inspecting the final MIME produced by Chilkat.

Specifies the POP3 server hostname or IP address.

Do not include http:// or https://. The value should be a hostname such as pop.example.com or an IPv4/IPv6 address.

Specifies the POP3 server port number.

The default value is 110.

The standard POP3 ports and their associated Chilkat.MailMan property settings are described below.

mailman.MailPort = 995;
mailman.PopSsl = true;

mailman.MailPort = 110;
mailman.PopSsl = false;
mailman.Pop3Stls = false;
mailman.Pop3StlsIfPossible = false;

mailman.MailPort = 110;
mailman.PopSsl = false;
mailman.Pop3Stls = true;

mailman.MailPort = 110;
mailman.PopSsl = false;
mailman.Pop3StlsIfPossible = true;

Important: PopSsl and Pop3Stls represent two different approaches to TLS security:

• PopSsl = true means the connection begins as SSL/TLS from the very start (implicit TLS).
• Pop3Stls = true means the connection begins unencrypted and is later upgraded to TLS using the POP3 STLS command (explicit TLS).

These two approaches are mutually exclusive and should not both be enabled at the same time.

Modern POP3 servers most commonly use either:

• 995 with PopSsl = true, or
• 110 with Pop3Stls = true.

Limits the number of messages Chilkat attempts to retrieve from the POP3 server in a single method call.

This is useful for large mailboxes. For example, setting MaxCount = 100 allows an application to download messages in batches of 100.

Specifies the OAuth2 access token to be used for POP3 or SMTP XOAUTH2 authentication.

When this property is set, Chilkat will use the SMTP or POP3 AUTH XOAUTH2 authentication mechanism if supported by the server.

For POP3 XOAUTH2 authentication:

• PopPassword should be left empty, or explicitly set to the empty string.
• SmtpPassword should be left unset, or set to the empty string.

The OAuth2 access token is sent as a bearer token during the AUTH XOAUTH2 authentication exchange.

Controls the MIME format used for digitally signed email.

When set to FALSE, Chilkat creates a multipart/signed email. In this format, the original email content remains visible as a normal MIME body part, and the digital signature is included as a separate MIME part.

The top-level MIME Content-Type header will look similar to:

Content-Type: multipart/signed;
    protocol="application/pkcs7-signature";
    micalg=sha-256;
    boundary="------------040808030405050402070604"

This is commonly referred to as a detached signature because the signed content exists separately from the signature itself.

When set to TRUE, Chilkat creates an opaque signed email using PKCS#7 signed-data format. In this case, the original MIME content is encapsulated inside the PKCS#7 signature structure.

The top-level MIME Content-Type header will look similar to:

Content-Type: application/pkcs7-mime;
    smime-type="signed-data";
    name="smime.p7m"; micalg=sha-256

This format is historically known as opaque signing because the original message content is wrapped inside the PKCS#7 signed object and is not directly visible as ordinary MIME body parts.

The default value is TRUE.

Specifies the filename used in the Content-Disposition header when sending a PKCS#7 encrypted email.

The default value is smime.p7m.

Specifies the filename used in the Content-Disposition header when sending an opaque signed PKCS#7 email.

The default value is smime.p7m.

Specifies the filename used in the Content-Disposition header when sending a signed email with a detached PKCS#7 signature.

The default value is smime.p7s.

This property is only valid in programming environments and languages that allow for event callbacks.

Sets the value that represents 100% completion for PercentDone event callbacks.

The default value is 100, meaning progress values range from 0 to 100. Setting this property to a larger value provides finer granularity. For example, setting PercentDoneScale = 1000 allows progress to be reported in tenths of a percent.

For example, if PercentDoneScale = 1000, then a callback value of 453 represents 45.3% complete.

The value is clamped to a minimum of 10 and a maximum of 100000.

Returns 0 when no POP3 session is active.

Otherwise, returns a positive integer that increments each time a new POP3 session is established. This can be used to detect whether a new session has started.

Contains the accumulated raw POP3 commands sent to the server and the raw responses received from the server.

This property is read-only. To clear it, call ClearPop3SessionLog.

Controls whether SPA, also known as NTLM authentication, is used for POP3.

Set this property to TRUE to use SPA authentication. No other programming changes are required.

The default value is FALSE.

Note: If SPA/NTLM authentication fails, set Global.DefaultNtlmVersion = 1 and retry.

Indicates whether the POP3 server's SSL/TLS certificate was successfully verified during the connection.

This property is meaningful only when connecting via SSL/TLS.

Controls whether Chilkat requires the POP3 connection to be upgraded to TLS using the STLS command.

When set to TRUE, Chilkat initially connects without encryption, typically on port 110, and then sends STLS to convert the connection to TLS.

Use this only with POP3 servers known to support STLS. When this property is TRUE, PopSsl should be FALSE.

The default value is FALSE.

Controls whether Chilkat uses POP3 STLS automatically when the server supports it.

If the server supports STLS, the connection is upgraded to TLS. If the server does not support STLS, the connection remains unencrypted.

The default value is FALSE.

Specifies the POP3 password.

On Windows, if Pop3SPA is enabled, both PopUsername and PopPassword may be set to "default" to use the credentials of the current logged-on Windows user.

Provides a way to specify the POP3 password as a Base64-encoded string.

Controls whether implicit SSL/TLS is used when connecting to the POP3 server.

When set to TRUE, the TLS connection is established immediately when connecting. The POP3 SSL/TLS port is typically 995.

The default value is FALSE.

Specifies the POP3 login name.

On Windows, if Pop3SPA is enabled, both PopUsername and PopPassword may be set to "default" to use the credentials of the current logged-on Windows user.

Controls whether IPv6 is preferred over IPv4 when both are available for a hostname.

The default value is FALSE, which means IPv4 is preferred.

Specifies the maximum number of seconds to wait when the SMTP or POP3 server stops responding.

The default value is 30 seconds.

Controls whether Chilkat requires SMTP and POP3 SSL/TLS server certificates to be successfully verified.

When set to TRUE, Chilkat rejects the connection if the server certificate is expired or if the certificate signature cannot be verified.

The default value is FALSE.

This property applies only to SSL/TLS connections.

Controls whether the email's Date header is reset to the current date and time when an email is loaded.

This applies to methods such as LoadMbx, LoadEml, LoadMime, LoadXml, and LoadXmlString.

The default value is FALSE.

Specifies the buffer size used by the underlying TCP/IP socket when sending data.

The default value is 32767.

Controls how email is sent to distribution lists.

When TRUE, Chilkat sends one email per recipient. Each message has the recipient's address in the To header.

When FALSE, Chilkat sends messages in batches of up to 100 BCC recipients at a time.

For example, a distribution list with 350 recipients would result in four messages: three with 100 BCC recipients, and one with 50 BCC recipients.

The default value is TRUE.

Specifies the maximum size, in bytes, of messages Chilkat will retrieve from a POP3 server.

Messages larger than this limit are not downloaded.

The default value is 0, which means no size limit.

Specifies the SMTP authentication method to use.

This property should usually be left empty so Chilkat can automatically choose the most secure method advertised by the SMTP server.

If the server does not advertise authentication methods, or if a specific method must be forced, set this property to one of: NONE, LOGIN, PLAIN, CRAM-MD5, or NTLM.

Note: If NTLM authentication fails, set Global.DefaultNtlmVersion = 1 and retry.

A keyword that indicates the cause of failure (or success) for the last SMTP related method called. Possible values are:

1. Success The method call was successful.
2. Failed A general failure not covered by any of the other possible keywords.
3. NoValidRecipients The SMTP server rejected all receipients.
4. NoRecipients The app failed to provide any recipients (TO, CC, or BCC).
5. SomeBadRecipients The AllOrNone property is TRUE, and some recipients were rejected by the SMTP server.
6. Aborted The application aborted the method.
7. NoFrom The failed to provide a FROM address.
8. FromFailure The SMTP replied with an error in response to the MAIL FROM command.
9. NoCredentials The application did not provide the required credentials, such as username or password.
10. AuthFailure The login (authentication) failed.
11. DataFailure The SMTP replied with an error in response to the DATA command.
12. NoSmtpHostname The application failed to provide an SMTP hostname or IP address.
13. StartTlsFailed Failed to convert the TCP connection to TLS via STARTTLS.
14. ConnectFailed Unable to establish a TCP or TLS connection to the SMTP server.
15. GreetingError The SMTP server immediately responded with an error status in the intial greeting.
16. ConnectionLost The connection to the SMTP server was lost at some point during the method call.
17. Timeout A timeout occurred when reading or writing the socket connection.
18. RenderFailed A failure occurred when rendering the email. (Rendering the email for sending includes tasks such as signing or encrypting.)
19. NotUnlocked The UnlockBundle method was not previously called on at least one instance of the mailman object.
20. InternalFailure An internal failure that should be reported to Chilkat support.

The domain name of the SMTP server. Do not include http:// in the domain name. This property may also be set to an IP address string, such as 168.144.70.227. Both IPv4 and IPv6 address formats are supported.

The Windows domain for logging into the SMTP server. Use this only if your SMTP server requires NTLM authentication, which means your SMTP server uses Integrated Windows Authentication. If there is no domain, this can be left empty.

This is the email address passed in the MAIL FROM command in the SMTP protocol. It specifies the envelope sender address — the address that will receive bounces (delivery failure messages), and is the originator of the SMTP transaction.

• SMTP servers may reject MAIL FROM addresses based on DNS or policy (SPF records)
• Bounce messages (delivery failure notifications) are sent to the address in MAIL FROM

This property is empty by default. If this property is left empty, which is typical, the email address in the From MIME header of the email is used as the MAIL FROM address.

The password for logging into the SMTP server. Use this only if your SMTP server requires authentication. Chilkat Email.NET supports the LOGIN, PLAIN, CRAM-MD5, and NTLM login methods, and it will automatically choose the most secure method available. Additional login methods will be available in the future.

If NTLM (Windows-Integrated) authentication is used, the SmtpUsername and SmtpPassword properties may be set to the string default to cause the component to use the current logged-on credentials (of the calling process) for authentication.

Controls whether SMTP pipelining is automatically used when the SMTP server indicates support for it. The default is TRUE. Setting this property equal to FALSE will prevent the SMTP pipelining feature from being used.

The port number of the SMTP server used to send email. Only needs to be set if the SMTP server is running on a non-standard port. The default value is 25. If SmtpSsl is set to TRUE, this property should be set to 465. (TCP port 465 is reserved by common industry practice for secure SMTP communication using the SSL protocol.)

This string property accumulates the raw commands sent to the SMTP server, and the raw responses received from the SMTP server. This property is read-only, but it may be cleared by calling ClearSmtpSessionLog.

When set to TRUE, causes the mailman to connect to the SMTP server with implicit SSL/TLS.

If using SSL, this property will be set to TRUE if the SMTP server's SSL certificate was verified when establishing the connection. Otherwise it is set to FALSE.

The login for logging into the SMTP server. Use this only if your SMTP server requires authentication.

Note: In many cases, an SMTP server will not require authentication when sending to an email address local to it's domain. However, when sending email to an external domain, authentication is required (i.e. the SMTP server is being used as a relay).

If the SmtpAuthMethod property is set to NTLM, the SmtpUsername and SmtpPassword properties may be set to the string default to use the current Windows logged-on user credentials.

smtp.office365.com: If SMTP authentication fails for your smtp.office365.com account, it may be that your account is configured to require MFA (multi-factor authentication). You may need to change settings to allow for legacy authentication (single-factor auth). See https://docs.microsoft.com/en-us/azure/active-directory/conditional-access/block-legacy-authentication Also, an app password may be required. See https://docs.microsoft.com/en-us/azure/active-directory/user-help/multi-factor-authentication-end-user-app-passwords

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).

The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.

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).

The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).

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.

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.

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.

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_SHA

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

Selects the secure protocol to be used for secure (SSL/TLS) connections (for both SMTP and POP3). Possible values are:

default
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

When set to TRUE, causes the mailman to issue a STARTTLS command to switch over to a secure SSL/TLS connection prior to authenticating and sending email. The default value is FALSE.

Note: This property applies to SMTP, not to POP3.

When set to TRUE, causes the mailman to do STARTTLS (if possible and supported by the server) to convert to a secure SMTP SSL/TLS connection prior to authenticating and sending email. The default value is TRUE.

Note: Setting the StartTLS property = TRUE causes STARTTLS to always be used, even if the SMTP server does not support it. This property allows for a non-encrypted connection, whereas the StartTLS property disallows non-encrypted connections.

Note: This property applies to SMTP, not to POP3.

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.

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, ...

"sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE="

"sha256, base64, 4t37LpnGmrMEAG8HEz9yIrnvJV2euVRwCLb9EH5WZyI=, 68b0G5iqMvWVWvUCjMuhLEyekM5729PadtnU5tdXZKs="

The following encodings are allowed: base64, hex, and any of the encodings indicated in the link below.

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.

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.
• SmtpLoginAnsi - Introduced in v9.5.0.97. If the SMTP login and/or password contains non-us-ascii chars, some SMTP servers expect the utf-8 encoding, whereas others expect ANSI. Historically, Chilkat passed the login/password using the ANSI encoding. Starting in v9.5.0.97, Chilkat switched to using the utf-8 encoding. This uncommon option can be used to revert back to the old behavior of sending the ANSI byte representation.

If TRUE, will automatically use APOP authentication if the POP3 server supports it. The default value of this property is FALSE.

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 of the component/library, such as "10.1.0"

Adds a PFX file to the object's list of sources for locating certificates and private keys during decryption or signing. To add multiple PFX sources, call this method for each file. bd should contain the bytes of a PFX file (also known as PKCS12 or .p12). The password is the password to the PFX.

Returns TRUE for success, FALSE for failure.

Adds a PFX file to the object's internal list of sources to be searched for certificates and private keys when decrypting or when sending signed email. 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.

Returns the number of emails available on the POP3 server. Returns -1 on error.

The VerifyPopConnection method can be called to verify basic TCP/IP connectivity with the POP3 server. The VerifyPopLogin method can be called to verify the POP3 login. The Verify* methods are intended to be called as a way of diagnosing the failure when a POP3 method returns an error status.

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

Returns NULL on failure

Clears the list of bad email addresses stored within the Mailman object. When an email-sending method is called, any email addresses rejected by the SMTP server will be cached within the Mailman object. These can be accessed by calling the GetBadEmailAddresses method. This method clears the Mailman's in-memory cache of bad addresses.

Clears the contents of the Pop3SessionLog property.

Clears the contents of the SmtpSessionLog property.

The mailman object automatically opens an SMTP connection (if necessary) whenever an email-sending method is called. The connection is kept open until explicitly closed by this method. Calling this method is entirely optional. The SMTP connection is also automatically closed when the mailman object is destructed. Thus, if an application calls SendEmail 10 times to send 10 emails, the 1st call will open the SMTP connection, while the subsequent 9 will send over the existing connection (unless a property such as username, login, hostname, etc. is changed, which would force the connection to become closed and re-established with the next mail-sending method call).

Note: This method sends a QUIT command to the SMTP server prior to closing the connection.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Marks multiple emails on the POP3 server for deletion. (Each email in emailBundle that is also present on the server is marked for deletion.) To complete the deletion of the emails, a QUIT message must be sent and the POP3 session ended. This will happen automatically when the ImmediateDelete property equals TRUE, which is the default. If ImmediateDelete equals FALSE, then the Pop3EndSession method can be called to send the QUIT and end the session (i.e. disconnect.)

Note: When making multiple calls to a Delete* method, it's best to turn off ImmediateDelete, and then manually call Pop3EndSession to finalize the deletions.

Also, any method call requiring communication with the POP3 server will automatically re-establish a session based on the current property settings.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Marks an email for deletion by message number. WARNING: Be very careful if calling this method. Message numbers are specific to a POP3 session. If a maildrop has (for example) 10 messages, the message numbers will be 1, 2, 3, ... 10. If message number 1 is deleted and a new POP3 session is established, there will be 9 messages numbered 1, 2, 3, ... 9.

IMPORTANT: A POP3 must first be established by either calling Pop3BeginSession explicitly, or implicitly by calling some other method that automatically establishes the session. This method will not automatically establish a new POP3 session (because if it did, the message numbers would potentially be different than what the application expects).

This method only marks an email for deletion. It is not actually removed from the maildrop until the POP3 session is explicitly ended by calling Pop3EndSession.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Marks an email on the POP3 server for deletion. To complete the deletion of an email, a QUIT message must be sent and the POP3 session ended. This will happen automatically when the ImmediateDelete property equals TRUE, which is the default. If ImmediateDelete equals FALSE, then the Pop3EndSession method can be called to send the QUIT and end the session (i.e. disconnect.)

Note: When making multiple calls to a Delete* method, it's best to turn off ImmediateDelete, and then manually call Pop3EndSession to finalize the deletions.

Also, any method call requiring communication with the POP3 server will automatically re-establish a session based on the current property settings.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Marks an email on the POP3 server for deletion. To complete the deletion of an email, a QUIT message must be sent and the POP3 session ended. This will happen automatically when the ImmediateDelete property equals TRUE, which is the default. If ImmediateDelete equals FALSE, then the Pop3EndSession method can be called to send the QUIT and end the session (i.e. disconnect.)

Note: When making multiple calls to a Delete* method, it's best to turn off ImmediateDelete, and then manually call Pop3EndSession to finalize the deletions.

Also, any method call requiring communication with the POP3 server will automatically re-establish a session based on the current property settings.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Marks multiple emails for deletion on the POP3 server when their UIDL matches any in stUidls. To finalize deletions, a QUIT message must be sent and the POP3 session closed. This occurs automatically when the ImmediateDelete property is set to TRUE (default setting). If ImmediateDelete is FALSE, use the Pop3EndSession method to manually send the QUIT message and disconnect.

Note: When making multiple Delete* method calls, it's advisable to set ImmediateDelete to FALSE and manually execute Pop3EndSession to complete deletions. Any method that requires server communication will automatically re-establish a session according to the current property settings.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Retrieves all emails from the POP3 server. If keepOnServer is TRUE, emails remain on the server. If headersOnly is TRUE, only the headers and the first numBodyLines lines of each email are downloaded, excluding attachments. Otherwise, the entire emails with attachments are downloaded. The emails are stored in bundle.

Note: keepOnServer only applies when downloading full emails (not headers-only). Downloading headers-only will not cause the email to be deleted from the server, regardless of keepOnServer.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Retrieves either the complete email or just the header along with the first N lines of the message body from the POP3 server specified by uidl, without deleting the email from the server.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

If a partial email (header-only) was retrieved, this method will download and return the full email from the server using the partial email as an argument.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Fetches an email by UIDL and returns the MIME source of the email in uidl.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Retrieves an email by its message number and provides the MIME source in bd. Note: Message numbers are unique to each POP3 session. For instance, if there are 10 messages in the maildrop, they will be numbered 1 through 10. If message 1 is deleted and a new POP3 session is started, the remaining messages will be renumbered from 1 to 9. Please note that a POP3 connection must be established beforehand. This can be done by explicitly calling Pop3BeginSession or through other methods that implicitly start the session. This method does not initiate a POP3 session automatically.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Retrieves a complete message or header by its message number and stores it in msgNum. The first email has a message number of 1. Messages fetched by this method remain on the server.

Note: Message numbers are unique to each POP3 session.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Retrieves a specified range of emails from the POP3 server. If keepOnServer is TRUE, the emails remain on the server. If headersOnly is TRUE, only the headers and the first numBodyLines lines of each email are downloaded, without attachments. Otherwise, the entire emails, including attachments, are downloaded. The range of emails to download is determined by startIndex and endIndex. The GetMailboxCount method returns the total number of emails in the POP3 mailbox, with the first email at index 0. The downloaded emails are stored in bundle.

Note: keepOnServer only applies when downloading full emails (not headers-only). Downloading headers-only will not cause the email to be deleted from the server, regardless of keepOnServer.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Returns the UIDLs of the emails currently stored on the POP3 server.

POP3 UIDLs (Unique ID Listings) are persistent, unique identifiers assigned by a mail server to each email message in a mailbox. Unlike message numbers, which can change between sessions, UIDLs remain consistent as long as the message exists, allowing email clients to track which messages have already been downloaded—even across multiple sessions—without re-fetching the same emails.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Fetches the email headers or full emails from the POP3 server whose UIDL is present in the uidls. If headersOnly is TRUE, only the headers and the first numBodyLines lines of each email are downloaded, excluding attachments. Otherwise, the entire emails with attachments are downloaded. The emails are stored in bundle. The downloaded emails are not deleted from the server.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Provides information about what transpired in the last method called on this object instance. For many methods, there is no information. However, for some methods, details about what occurred can be obtained by getting the LastJsonData right after the method call returns.

Returns the number of emails on the POP3 server, or -1 for failure.

This method is identical to CheckEmail. It was added for clarity.

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

Returns NULL on failure

Returns an XML document with information about the emails in a POP3 mailbox. The XML contains the UIDL and size (in bytes) of each email in the mailbox.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Returns the total combined size in bytes of all the emails in the POP3 mailbox. This is also known as the mail drop size. Returns -1 on failure.

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

Returns NULL on failure

If the current connection is SSL/TLS, this method returns the digital certificate of the SMTP or POP3 server specified by useSmtp. The certificate is returned in cert.

Returns TRUE for success, FALSE for failure.

Returns the size of an email (including attachments) given the UIDL of the email on the POP3 server. Returns -1 for failure.

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

Returns NULL on failure

Contacts the SMTP server and determines if it supports the DSN (Delivery Status Notification) features specified by RFC 3461 and supported by the DsnEnvid, DsnNotify, and DsnRet properties. Returns TRUE if the SMTP server supports DSN, otherwise returns FALSE.

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

Returns NULL on failure

Loads a .mbx file containing emails and returns in bundle. If a Filter is present, only emails that match the filter are returned.

Returns TRUE for success, FALSE for failure.

Loads the caller of the task's async method.

Returns TRUE for success, FALSE for failure.

Explicitly opens a connection to the SMTP server and authenticates (if a username/password was specified). Calling this method is optional because the SendEmail method and other mail-sending methods will automatically open the connection to the SMTP server if one is not already established.

Note: This method is the equivalent of calling SmtpConnect followed by SmtpAuthenticate.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Authenticates with the POP3 server using the property settings such as PopUsername, PopPassword, etc. This method should only be called after a successful call to Pop3Connect.

Note 1: The Pop3BeginSession method both connects and authenticates. It is the equivalent of calling Pop3Connect followed by Pop3Authenticate.

Note 2: All methods that communicate with the POP3 server, such as FetchEmail, will automatically connect and authenticate if not already connected and authenticated.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Call to explicitly begin a POP3 session. It is not necessary to call this method because any method requiring an established POP3 session will automatically connect and login if a session is not already open.

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.

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

Returns NULL on failure

Explicitly establishes a connection to the POP3 server, which includes establishing a secure TLS channel if required, and receives the initial greeting. This method stops short of authenticating. The Pop3Authenticate method should be called after a successful call to this method.

When finished transacting with a POP3 mail server you can disconnect by calling Pop3EndSession or Pop3EndSessionNoQuit.

Note 1: The Pop3BeginSession method both connects and authenticates. It is the equivalent of calling Pop3Connect followed by Pop3Authenticate.

Note 2: All methods that communicate with the POP3 server, such as FetchEmail, will automatically connect and authenticate if not already connected and authenticated.

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.

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

Returns NULL on failure

Call to explicitly end a POP3 session (sends the QUIT command and then closes the connection with the POP3 server). If the ImmediateDelete property is set to FALSE, and emails marked for deletion will be deleted at this time.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

This method is identical to Pop3EndSession, but no QUIT command is sent. The client simply disconnects from the POP3 server.

This method should always return TRUE.

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

Returns NULL on failure

Sends a NOOP command to the POP3 server. This may be a useful method to call periodically to keep a connection open, or to verify that the POP3 connection (session) is open and functioning.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Sends a RSET command to the POP3 server. If any messages have been marked as deleted by the POP3 server, they are unmarked. Calling Pop3Reset resets the POP3 session to a valid, known starting point.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Sends a raw command to the POP3 server and returns the POP3 server's response. If non-us-ascii characters are included in command, then charset indicates the charset to be used in sending the command (such as utf-8, ansi, iso-8859-1, Shift_JIS, etc.)

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

A quick way to send an email to a single recipient without having to explicitly create an email object.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

When you call SendEmail , the email is first processed by rendering it with the specified properties and contents. This may include digital signing, encryption, substituting values for placeholders, and encoding header fields if necessary. The RenderToMime method handles this rendering process without sending the email. The resulting MIME text is what would be sent to the SMTP server if SendEmail were called. Essentially, SendEmail is equivalent to executing RenderToMime followed by SendMime. If successful, the rendered MIME string is returned.

Returns TRUE for success, FALSE for failure.

The same as RenderToMimeBytes, except the MIME is rendered into renderedMime. The rendered MIME is appended to renderedMime.

Returns TRUE for success, FALSE for failure.

The same as RenderToMime, except the MIME is rendered into renderedMime. The rendered MIME is appended to renderedMime.

Returns TRUE for success, FALSE for failure.

Sends a bundle of emails. This is identical to calling SendEmail for each email in the bundle.

If an error occurs when sending one of the emails in the bundle, it will continue with each subsequent email until each email in the bundle has been attempted (unless a fatal error occurs, in which case the send is aborted).

Because it is difficult or impossible to programmatically identify which emails in the bundle failed and which succeeded, it is best to write a loop that sends each email separately (via the SendEmail method).

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Sends a single email. The connection to the SMTP server will remain open so that a subsequent call to SendEmail (or other email-sending methods) can re-use the same connection. If any properties relating to the SMTP server are changed, such as SmtpHost, SmtpUsername, etc., then the next call to an email-sending method will automatically close the connection and re-establish a connection using the updated property settings.

Important: Some SMTP servers do not actually send the email until the connection is closed. In these cases, it is necessary to call CloseSmtpConnection for the mail to be sent. Most SMTP servers send the email immediately, and it is not required to close the connection.

GMail: If sending via smtp.gmail.com, then send with OAuth2 authentication if possible. Otherwise you will need to change your GMail account settings to allow for sending by less secure apps. See the links below.

Note: After sending email, information about what transpired is available via the LastJsonData method.

Note: Returns TRUE if the final SMTP status code in the SMTP session is in the 200's or 300's. See SMTP Server Return Codes

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Provides complete control over the email that is sent. The MIME text passed in mimeSource (the MIME source of an email) is passed exactly as-is to the SMTP server. The recipients is a comma separated list of recipient email addresses. The fromAddr is the reverse-path email address. This is where bounced email (non-delivery reports) will be delivered. It may be different than the From header field in the mimeSource.

To understand how the fromAddr and recipients relate to the email addresses found in the MIME headers (FROM, TO, CC), see the link below entitled SMTP Protocol in a Nutshell. The fromAddr is what is passed to the SMTP server in the MAIL FROM command. The recipients are the email addresses passed in RCPT TO commands. These are usually the same email addresses found in the MIME headers, but need not be (unless the SMTP server enforces policies that require them to be the same).

Note: Returns TRUE if the final SMTP status code in the SMTP session is in the 200's or 300's. See SMTP Server Return Codes

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

This method is the same as SendMimeBytes, except the MIME is passed in an object (mimeData) rather than explicitly passing the bytes.

Note: Returns TRUE if the final SMTP status code in the SMTP session is in the 200's or 300's. See SMTP Server Return Codes

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Same as SendMime, but the recipient list is read from a text file (distListFilename) containing one email address per line.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Explicitly specifies the certificate to be used for decrypting encrypted email.

Returns TRUE for success, FALSE for failure.

Explicitly specifies the certificate and associated private key to be used for decrypting S/MIME encrypted email.

Note: In most cases, it is easier to call AddPfxSourceFile or AddPfxSourceData to provide the required cert and private key. On Windows systems where the certificate + private key has already been installed in the default certificate store, nothing needs to be done -- the mailman will automatically locate and use the required cert + private key.

Returns TRUE for success, FALSE for failure.

Provides a more secure way of setting either the POP3 or SMTP password. The protocol can be pop3 or smtp. When the protocol is pop3, this is equivalent to setting the PopPassword property. When protocol is smtp, this is equivalent to setting the SmtpPassword property.

Returns TRUE for success, FALSE for failure.

Sets the client-side certificate to be used with SSL connections. This is typically not required, as most SSL connections are such that only the server is authenticated while the client remains unauthenticated.

Returns TRUE for success, FALSE for failure.

Allows for a client-side certificate to be used for the SSL / TLS connection.

Returns TRUE for success, FALSE for failure.

Allows for a client-side certificate to be used for the SSL / TLS connection.

Returns TRUE for success, FALSE for failure.

Authenticates with the SMTP server using the property settings such as SmtpUsername, SmtpPassword, etc. This method should only be called after a successful call to SmtpConnect.

Note 1: The OpenSmtpConnection method both connects and authenticates. It is the equivalent of calling SmtpConnect followed by SmtpAuthenticate.

Note 2: All methods that communicate with the SMTP server, such as SendEmail, will automatically connect and authenticate if not already connected and authenticated.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Explicitly establishes a connection to the SMTP server, which includes establishing a secure TLS channel if required, and receives the initial greeting. This method stops short of authenticating. The SmtpAuthenticate method should be called after a successful call to this method.

Note 1: The OpenSmtpConnection method both connects and authenticates. It is the equivalent of calling SmtpConnect followed by SmtpAuthenticate.

Note 2: All methods that communicate with the SMTP server, such as SendEmail, will automatically connect and authenticate if not already connected and authenticated.

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.

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

Returns NULL on failure

Sends a no-op to the SMTP server. Calling this method is good for testing to see if the connection to the SMTP server is working and valid. The SmtpNoop method will automatically establish the SMTP connection if it does not already exist.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Sends an RSET command to the SMTP server. This method is rarely needed. The RSET command resets the state of the connection to the SMTP server to the initial state (so that the component can proceed with sending a new email). The SmtpReset method would only be needed if a mail-sending method failed and left the connection with the SMTP server open and in a non-initial state. (A situation that is probably not even possible with the Chilkat mail component.)

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Sends a raw command to the SMTP server and returns the SMTP server's response. If non-us-ascii characters are included in command, then charset indicates the charset to be used in sending the command (such as utf-8, ansi, iso-8859-1, Shift_JIS, etc.)

If bEncodeBase64 is TRUE, then the response is returned in Base64-encoded format. Otherwise the raw response is returned.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

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 sshUsername 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.

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

Returns NULL on failure

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.

Note: Once the SSH tunnel is setup by calling SshTunnel and SshAuthenticatePw (or SshAuthenticatePk), all underlying communcations with the POP3 or SMTP 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.

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

Returns NULL on failure

Closes the SSH tunnel for SMTP or POP3.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Connects to an SSH server and creates a tunnel for SMTP or POP3. 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 SshTunnel to connect to the SSH server, followed by calling either SshAuthenticatePw or SshAuthenticatePk to authenticate.

Note: Once the SSH tunnel is setup by calling SshOpenTunnel and SshAuthenticatePw (or SshAuthenticatePk), all underlying communcations with the SMTP or POP3 server use the SSH tunnel. No changes in programming are required other than making two initial calls to setup the tunnel.

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.

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

Returns NULL on failure

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.

Uses an existing SSH tunnel for the connections to the POP3 andSMTP servers. This method is identical to the UseSshTunnel method, except the SSH connection is obtained from an SSH object instead of a Socket object.

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. SMTP and POP3 connections can exist simultaneously within a single SSH tunnel as SSH channels.)

Returns TRUE for success, FALSE for failure.

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. SMTP and POP3 connections can exist simultaneously within a single SSH tunnel as SSH channels.)

Returns TRUE for success, FALSE for failure.

Return TRUE if a TCP/IP connection can be established with the POP3 server, otherwise returns FALSE.

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

Returns NULL on failure

Return TRUE if a TCP/IP connection and login is successful with the POP3 server. Otherwise return FALSE.

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

Returns NULL on failure

Initiates sending an email, but aborts just after passing all recipients (TO, CC, BCC) to the SMTP server. This allows your program to collect email addresses flagged as invalid by the SMTP server.

Important: Please read this blog post before using this method: http://www.cknotes.com/?p=249>http://www.cknotes.com/?p=249

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Return TRUE if a TCP/IP connection can be established with the SMTP server, otherwise returns FALSE.

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

Returns NULL on failure

Return TRUE if a TCP/IP connection and login is successful with the SMTP server. Otherwise returns FALSE.

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

Returns NULL on failure

Adds a PFX to the object's internal list of sources to be searched for certificates and private keys when decrypting or when creating signed email for sending. Multiple PFX sources 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 pfxData contains the bytes of a PFX file (also known as PKCS12 or .p12).

Returns TRUE for success, FALSE for failure.

This method is deprecated. Applications should instead call FetchAll.

Copy the email from a POP3 server into a EmailBundle. This does not remove the email from the POP3 server.

Returns NULL on failure

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

Returns NULL on failure

Marks multiple emails on the POP3 server for deletion. (Any email on the server having a UIDL equal to a UIDL found in uidlArray is marked for deletion.) To complete the deletion of the emails, a QUIT message must be sent and the POP3 session ended. This will happen automatically when the ImmediateDelete property equals TRUE, which is the default. If ImmediateDelete equals FALSE, then the Pop3EndSession method can be called to send the QUIT and end the session (i.e. disconnect.)

Note: When making multiple calls to a Delete* method, it's best to turn off ImmediateDelete, and then manually call Pop3EndSession to finalize the deletions.

Also, any method call requiring communication with the POP3 server will automatically re-establish a session based on the current property settings.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

This method is deprecated. Applications should instead call FetchOne.

Fetches an email by message number. WARNING: Be very careful if calling this method. Message numbers are specific to a POP3 session. If a maildrop has (for example) 10 messages, the message numbers will be 1, 2, 3, ... 10. If message number 1 is deleted and a new POP3 session is established, there will be 9 messages numbered 1, 2, 3, ... 9.

IMPORTANT: A POP3 connection must first be established by either calling Pop3BeginSession explicitly, or implicitly by calling some other method that automatically establishes the session. This method will not automatically establish a new POP3 session (because if it did, the message numbers would potentially be different than what the application expects).

Returns NULL on failure

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

Returns NULL on failure

This method is deprecated. Applications should instead call FetchByUidl.

Fetches an email from the POP3 mail server given its UIDL. Calling this method does not remove the email from the server. A typical program might get the email headers from the POP3 server by calling GetAllHeaders or GetHeaders, and then fetch individual emails by UIDL.

Returns a null reference on failure.

Returns NULL on failure

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

Returns NULL on failure

Fetches an email by UIDL and returns the MIME source of the email in a byte array.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

Retrieves an email by its message number and returns the MIME bytes. Note: Message numbers are unique to each POP3 session. For instance, if there are 10 messages in the maildrop, they will be numbered 1 through 10. If message 1 is deleted and a new POP3 session is started, the remaining messages will be renumbered from 1 to 9. Please note that a POP3 connection must be established beforehand. This can be done by explicitly calling Pop3BeginSession or through other methods that implicitly start the session. This method does not initiate a POP3 session automatically.

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

This method is deprecated. Applications should instead call FetchUidlSet.

Given an array of UIDL strings, fetchs all the emails from the POP3 server whose UIDL is present in the array, and returns the emails in a bundle.

Returns NULL on failure

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

Returns NULL on failure

This method is deprecated. Applications should instead call FetchUidlSet.

Given an array of UIDL strings, fetchs all the email headers from the POP3 server whose UIDL is present in the array.

Note: The email objects returned in the bundle contain only headers. The attachments will be missing, and the bodies will be mostly missing (only the 1st numBodyLines lines of either the plain-text or HTML body will be present).

Returns NULL on failure

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

Returns NULL on failure

This deprecated method will be removed in a future major release of Chilkat. MIME can potentially include non-encoded binary data and mixed character encodings, so downloading emails as a simple MIME string often requires processing and modifications, making it impractical. Instead, applications should use FetchMimeBd or methods that download emails to email objects.

This method downloads emails from the POP3 server for each UIDL in uidlArray and returns an object containing the collection of downloaded MIME strings.

Returns NULL on failure

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

Returns NULL on failure

This method is deprecated. Applications should instead call FetchOne.

Fetches a single header by message number. Returns an email object on success, or a null reference on failure.

Returns NULL on failure

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

Returns NULL on failure

This method is deprecated. Applications should instead call FetchByUidl.

Fetches a single header by UIDL. Returns an email object on success, or a null reference on failure.

Note: The email objects returned in the bundle contain only headers. The attachments will be missing, and the bodies will be mostly missing (only the 1st uidl lines of either the plain-text or HTML body will be present).

Returns NULL on failure

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

Returns NULL on failure

This method is deprecated. Applications should instead call FetchAll.

Retrieves all emails from the POP3 server, limiting the body to the first numBodyLines lines and excluding attachments. The returned emails are valid objects with truncated bodies and no attachments.

Returns NULL on failure

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

Returns NULL on failure

This method is deprecated. Applications should instead call FetchFull.

If a partial email (header-only) is retrieved using GetHeaders or GetAllHeaders, this method will download and return the full email from the server using the partial email as an argument.

Returns NULL on failure

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

Returns NULL on failure

This method is deprecated. Applications should instead call FetchRange.

The same as the GetAllHeaders method, except only the emails from fromIndex to toIndex on the POP3 server are returned. The first email on the server is at index 0.

Returns NULL on failure

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

Returns NULL on failure

This method is deprecated. Applications should instead call GetServerCert.

Returns the POP3 server's SSL certificate. This is available after connecting via SSL to a POP3 server. (To use POP3 SSL, set the PopSsl property = TRUE.)

Returns a null reference if no POP3 SSL certificate is available.

Returns NULL on failure

This method is deprecated. Applications should instead call GetServerCert.

If using SSL/TLS, this method returns the SMTP server's digital certificate used with the secure connection.

Returns NULL on failure

This method is deprecated. Applications should instead call FetchUidls.

Returns the UIDLs of the emails currently stored on the POP3 server.

Returns NULL on failure

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

Returns NULL on failure

This method is deprecated. Call GetLastJsonData instead.

Provides information about what transpired in the last method called on this object instance. For many methods, there is no information. However, for some methods, details about what occurred can be obtained by getting the LastJsonData right after the method call returns.

Returns NULL on failure

This deprecated method will be removed in a future Chilkat major version. Applications should instead call the email object's LoadEml method.

Loads a .eml file containing an email.

Returns NULL on failure

This method is deprecated. Applications should instead call LoadMbxFile.

Loads a .mbx file containing emails and returns an email bundle. If a Filter is present, only emails matching the filter are returned.

Returns NULL on failure

This deprecated method will be removed in a future Chilkat major version. Applications should instead call the email object's SetFromMimeText method.

Creates and loads an email from a MIME string. Returns a null reference on failure.

Returns NULL on failure

This deprecated method will be removed in a future Chilkat major version. Applications should instead call the email object's SetFromXmlText method.

Loads an XML file containing a single email and returns an email object. Returns a null reference on failure.

Returns NULL on failure

This deprecated method will be removed in a future Chilkat major version. Applications should instead call the email object's SetFromXmlText method.

Loads an XML string containing a single email and returns an email object. Returns a null reference on failure.

Returns NULL on failure

This deprecated method will be removed in a future Chilkat major version. Applications should instead call the email bundle object's LoadXml method.

Loads an XML file containing one or more emails and returns an email bundle. If a Filter is present, only emails matching the filter are returned. Returns a null reference on failure.

Returns NULL on failure

This deprecated method will be removed in a future Chilkat major version. Applications should instead call the email bundle object's LoadXmlString method.

Loads from an XML string containing emails and returns an email bundle. If a Filter is present, only emails matching the filter are returned.

Returns NULL on failure

This deprecated method will be removed in a future Chilkat major version. Applications should instead use the Chilkat Dns class to do MX lookups.

Performs a DNS MX lookup to return the mail server hostname based on an email address.

Returns TRUE for success, FALSE for failure.

This deprecated method will be removed in a future Chilkat major version. Applications should instead use the Chilkat Dns class to do MX lookups.

Performs a DNS MX lookup to return the list of mail server hostnames based on an email address. The primary server is at index 0. In most cases, there is only one mail server for a given email address.

Returns NULL on failure

This method is the same as RenderToMime, but the MIME is returned in a byte array. If an email uses an 8bit or binary MIME encoding, then calling RenderToMime may introduce errors because it is not possible to return non-text binary data as a string. Therefore, calling RenderToMimeBytes is recommended over RenderToMime, unless it is assured that the email (MIME) does not use a binary encoding for non-text data.

Returns TRUE for success, FALSE for failure.

This method is the same as SendMime, except the MIME is passed in a byte array. This can be important if the MIME uses a binary encoding, or if a DKIM/DomainKey signature is included.

To understand how the fromAddr and recipients relate to the email addresses found in the MIME headers (FROM, TO, CC), see the link below entitled SMTP Protocol in a Nutshell. The fromAddr is what is passed to the SMTP server in the MAIL FROM command. The recipients are the email addresses passed in RCPT TO commands. These are usually the same email addresses found in the MIME headers, but need not be (unless the SMTP server enforces policies that require them to be the same).

Note: Returns TRUE if the final SMTP status code in the SMTP session is in the 200's or 300's. See SMTP Server Return Codes

Returns TRUE for success, FALSE for failure.

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

Returns NULL on failure

This method is deprecated. Applications should instead call FetchAll.

Downloads and removes all email from a POP3 server. A bundle containing the emails is returned. A null reference is returned on failure.

Returns NULL on failure

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

Returns NULL on failure

This deprecated method will be removed in a future major release of Chilkat. MIME can potentially include non-encoded binary data and mixed character encodings, so downloading emails as a simple MIME string often requires processing and modifications, making it impractical. Instead, applications should use FetchMimeBd or methods that download emails to email objects.

Same as FetchMultipleMime except that the downloaded emails are also deleted from the server. Returns a null reference on failure.

Returns NULL on failure

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

Returns NULL on failure