MailMan PureBasic Reference Documentation

MailMan

Current Version: 10.1.0

Requires Chilkat Bundle License

The Chilkat MailMan class is reponsible for sending email though SMTP and receiving/managing email on POP3 servers.

Object Creation

obj.i = CkMailMan::ckCreate()

; Make sure to dispose of the object when finished like this:
CkMailMan::ckDispose(obj);

Properties

AbortCurrent

Declare.i ckAbortCurrent(obj.i)
Declare setCkAbortCurrent(obj.i, value.i)

Introduced in version 9.5.0.58

When set to 1, 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 0 when the next method is called. When the abort occurs, this property is reset to 0. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

AllOrNone

Declare.i ckAllOrNone(obj.i)
Declare setCkAllOrNone(obj.i, value.i)

Prevents sending any email if any of the addresses in the recipient list are rejected by the SMTP server. The default value is 0, which indicates that the mail sending should continue even if some email addresses are invalid. (Note: Not all SMTP servers check the validity of email addresses, and even for those that do, it is not 100% accurate.)

Note: An SMTP server only knows the validity of email addresses within the domain it controls.

Important: The AllOrNone property only works if SMTP pipelining is turned off. By default, the SmtpPipelining property is turned on and has the value of 1. If all-or-none behavior is desired, make sure to set SmtpPipelining equal to 0.

More Information and Examples

AutoFix Explained in More Detail

AutoFix

Declare.i ckAutoFix(obj.i)
Declare setCkAutoFix(obj.i, value.i)

If 1, then the following will occur when a connection is made to an SMTP or POP3 server:

1) If the SmtpPort property = 465, then sets StartTLS = 0 and SmtpSsl = 1
2) If the SmtpPort property = 25, sets SmtpSsl = 0
3) If the MailPort property = 995, sets PopSsl = 1
4) If the MailPort property = 110, sets PopSsl = 0

The default value of this property is 1.

More Information and Examples

AutoFix Explained in More Detail

AutoGenMessageId

Declare.i ckAutoGenMessageId(obj.i)
Declare setCkAutoGenMessageId(obj.i, value.i)

Controls whether a unique Message-ID header is auto-generated for each email sent.

The Message-ID header field should contain a unique message ID for each email that is sent. The default behavior is to auto-generate this header field at the time the message is sent. This makes it easier for the same email object to be re-used. If the message ID is not unique, the SMTP server may consider the message to be a duplicate of one that has already been sent, and may discard it without sending. This property controls whether message IDs are automatically generated. If auto-generation is turned on (1), the value returned by GetHeaderField("Message-ID") will not reflect the actual message ID that gets sent with the email.

To turn off automatic Message-ID generation, set this property to 0.

More Information and Examples

Auto-Generate or Explicitly Specify the Message-ID Email Header

AutoSmtpRset

Declare.i ckAutoSmtpRset(obj.i)
Declare setCkAutoSmtpRset(obj.i, value.i)

If 1, then the SMTP "RSET" command is automatically sent to ensure that the SMTP connection is in a valid state when a new email is about to be sent on an already established connection. The default value is 0.

Important: This property only applies when an email is sent on an already-open SMTP connection.

AutoUnwrapSecurity

Declare.i ckAutoUnwrapSecurity(obj.i)
Declare setCkAutoUnwrapSecurity(obj.i, value.i)

Introduced in version 9.5.0.49

If 1, then digitally signed and/or encrypted email when downloaded from a mail server is automatically "unwrapped" and the results of the signature validation and decryption are available in various email object properties and methods. The default value of this property is 1. Set this property to 0 to prevent unwrapping.

Note: A digitally signed or encrypted email can ONLY be verified and/or decrypted when initially loading the original MIME into the email object (i.e. when downloading from the server, or when loading from MIME). Once the MIME is parsed and stored in the internal email object format, the exactnes of the MIME has been lost and the signature can no longer be verified. This is why the signature is verified upon the intial loading of the MIME, and the results are made available through the various properties and methods. This property provides a means for downloading email where the .p7m (or .p7s) attachments are are to be treated as simple attachments and the desire is to access or save the original .p7m/.p7s files.

ClientIpAddress

Declare.s ckClientIpAddress(obj.i)
Declare setCkClientIpAddress(obj.i, value.s)

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

More Information and Examples

Important Bind to Adapter Notes for Windows

ConnectFailReason

Declare.i ckConnectFailReason(obj.i) ; (read-only)

Introduced in version 9.5.0.56

This property will be set to the status of the last connection made (or failed to be made) by any method.

Possible values are:

0 = success

Normal (non-TLS) sockets:
1 = empty hostname
2 = DNS lookup failed
3 = DNS timeout
4 = Aborted by application.
5 = Internal failure.
6 = Connect Timed Out
7 = Connect Rejected (or failed for some other reason)

SSL/TLS:
100 = TLS internal error.
101 = Failed to send client hello.
102 = Unexpected handshake message.
103 = Failed to read server hello.
104 = No server certificate.
105 = Unexpected TLS protocol version.
106 = Server certificate verify failed (the server certificate is expired or the cert's signature verification failed).
107 = Unacceptable TLS protocol version.
109 = Failed to read handshake messages.
110 = Failed to send client certificate handshake message.
111 = Failed to send client key exchange handshake message.
112 = Client certificate's private key not accessible.
113 = Failed to send client cert verify handshake message.
114 = Failed to send change cipher spec handshake message.
115 = Failed to send finished handshake message.
116 = Server's Finished message is invalid.

ConnectTimeout

Declare.i ckConnectTimeout(obj.i)
Declare setCkConnectTimeout(obj.i, value.i)

The time (in seconds) to wait before while trying to connect to a mail server (POP3 or SMTP). The default value is 30.

DebugLogFilePath

Declare.s ckDebugLogFilePath(obj.i)
Declare setCkDebugLogFilePath(obj.i, value.s)

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.

More Information and Examples

Example showing how to use DebugLogFilePath.

DsnEnvid

Declare.s ckDsnEnvid(obj.i)
Declare setCkDsnEnvid(obj.i, value.s)

(An SMTP DSN service extension feature) An arbitrary string that will be used as the ENVID property when sending email. See RFC 3461 for more details.

DsnNotify

Declare.s ckDsnNotify(obj.i)
Declare setCkDsnNotify(obj.i, value.s)

(An SMTP DSN service extension feature) A string that will be used as the NOTIFY parameter when sending email. (See RFC 3461 for more details. ) This string can be left blank, or can be set to "NEVER", or any combination of a comma-separated list of "SUCCESS", "FAILURE", or "NOTIFY".

DsnRet

Declare.s ckDsnRet(obj.i)
Declare setCkDsnRet(obj.i, value.s)

(An SMTP DSN service extension feature) A string that will be used as the RET parameter when sending email. (See RFC 3461 for more details. ) This string can be left blank, or can be set to "FULL" to receive entire-message DSN notifications, or "HDRS" to receive header-only DSN notifications.

EmbedCertChain

Declare.i ckEmbedCertChain(obj.i)
Declare setCkEmbedCertChain(obj.i, value.i)

If 1, causes the digital certificate chain to be embedded in signed emails. The certificates in the chain of authentication are embedded up to but not including the root certificate. If the IncludeRootCert property is also 1, then the root CA certificate is also included in the S/MIME signature.

Filter

Declare.s ckFilter(obj.i)
Declare setCkFilter(obj.i, value.s)

An expression that is applied to any of the following method calls when present: LoadXmlFile, LoadXmlString, LoadMbx, CopyMail, and TransferMail. For these methods, only the emails that match the filter's expression are returned in the email bundle. In the case of TransferMail, only the matching emails are removed from the mail server. The filter allows any header field, or the body, to be checked.

Here are some examples of expressions:

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

Here are the general rules for forming filter expressions:

Any MIME header field name can be used, case is insensitive. 
Literal strings are double-quoted, and case is insensitive. 
The "*" wildcard matches 0 or more occurrences of any character. 
Parentheses can be used to control precedence. 
The logical operators are: AND, OR, NOT (case insensitive) 
Comparison operators are: =, <, >, <=, >=, <> 
String comparison operators are: CONTAINS, LIKE (case insensitive)

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

More Information and Examples

More information about the Filter property (for POP3)

HeloHostname

Declare.s ckHeloHostname(obj.i)
Declare setCkHeloHostname(obj.i, value.s)

Specifies the hostname to be used for the EHLO/HELO command sent to an SMTP server. By default, this property is an empty string which causes the local hostname to be used.

HttpProxyAuthMethod

Declare.s ckHttpProxyAuthMethod(obj.i)
Declare setCkHttpProxyAuthMethod(obj.i, value.s)

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

HttpProxyDomain

Declare.s ckHttpProxyDomain(obj.i)
Declare setCkHttpProxyDomain(obj.i, value.s)

The NTLM authentication domain (optional) if NTLM authentication is used.

HttpProxyHostname

Declare.s ckHttpProxyHostname(obj.i)
Declare setCkHttpProxyHostname(obj.i, value.s)

If an HTTP proxy is to be used, set this property to the HTTP proxy hostname or IPv4 address (in dotted decimal notation).

HttpProxyPassword

Declare.s ckHttpProxyPassword(obj.i)
Declare setCkHttpProxyPassword(obj.i, value.s)

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy password.

HttpProxyPort

Declare.i ckHttpProxyPort(obj.i)
Declare setCkHttpProxyPort(obj.i, value.i)

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

HttpProxyUsername

Declare.s ckHttpProxyUsername(obj.i)
Declare setCkHttpProxyUsername(obj.i, value.s)

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy login name.

ImmediateDelete

Declare.i ckImmediateDelete(obj.i)
Declare setCkImmediateDelete(obj.i, value.i)

If 1 (the default) then any method that deletes an email from the POP3 server will also issue a QUIT command to close the session to ensure the message is deleted immediately.

The POP3 protocol is such that the DELE command marks a message for deletion. It is not actually deleted until the QUIT command is sent and the session is closed. If ImmediateDelete is 1, then any Chilkat MailMan method that marks a message (or messages) for deletion will also followup with a QUIT command and close the session. If your program sets ImmediateDelete to 0, it must make sure to call Pop3EndSession to ensure that messages marked for deletion are actually deleted.

More Information and Examples

POP3 Session Management

IncludeRootCert

Declare.i ckIncludeRootCert(obj.i)
Declare setCkIncludeRootCert(obj.i, value.i)

Controls whether the root certificate in the chain of authentication (i.e. the CA root certificate) is included within the S/MIME signature of a signed email. Note: This property only applies if the EmbedCertChain property is also 1.

IsPop3Connected

Declare.i ckIsPop3Connected(obj.i) ; (read-only)

Introduced in version 9.5.0.48

Returns 1 if still connected to the POP3 server. Otherwise returns 0.

Note: Accessing this property does not trigger any communication with the POP3 server. A connection to the POP3 server is established by explicitly calling Pop3BeginSession, or it is implicitly established as needed by any method that requires communication. A lost connection might only be detected when attempting to communicate with the server. To truly determine if a connection to the POP3 server is open and valid, it may be necessary to call the Pop3Noop method instead. This property might return 1 if the server has disconnected, but the client has not attempted to communicate with the server since the disconnect.

IsSmtpConnected

Declare.i ckIsSmtpConnected(obj.i) ; (read-only)

Returns 1 if still connected to the SMTP server. Otherwise returns 0 (if there was never a connection in the first place, or if the connection was lost).

Note: Accessing this property does not trigger any communication with the SMTP server. A connection to the SMTP server is established by explicitly calling OpenSmtpConnection, or it is implicitly established as needed by any method that requires communication. A lost connection might only be detected when attempting to communicate with the server. To truly determine if a connection to the SMTP server is open and valid, it may be necessary to call the SmtpNoop method instead. This property might return 1 if the server has disconnected, but the client has not attempted to communicate with the server since the disconnect.

LastErrorHtml

Declare.s ckLastErrorHtml(obj.i) ; (read-only)

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.

LastErrorText

Declare.s ckLastErrorText(obj.i) ; (read-only)

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

Declare.s ckLastErrorXml(obj.i) ; (read-only)

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.

LastMethodSuccess

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastSmtpStatus

Declare.i ckLastSmtpStatus(obj.i) ; (read-only)

Returns the last SMTP diagnostic status code. This can be checked after sending an email. SMTP reply codes are defined by RFC 821 - Simple Mail Transfer Protocol.

LastSmtpStatusMsg

Declare.s ckLastSmtpStatusMsg(obj.i) ; (read-only)

Introduced in version 9.5.0.85

Returns the last SMTP status message associated with the last SMTP status code received. This can be checked after sending an email.

LogMailReceivedFilename

Declare.s ckLogMailReceivedFilename(obj.i)
Declare setCkLogMailReceivedFilename(obj.i, value.s)

A log filename where the MailMan will log each message in the exact form it was received from a POP3 server. This property is provided for help in debugging.

LogMailSentFilename

Declare.s ckLogMailSentFilename(obj.i)
Declare setCkLogMailSentFilename(obj.i, value.s)

A log filename where the MailMan will log the exact message sent to the SMTP server. This property is helpful in debugging.

MailHost

Declare.s ckMailHost(obj.i)
Declare setCkMailHost(obj.i, value.s)

The domain name of the POP3 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.

MailPort

Declare.i ckMailPort(obj.i)
Declare setCkMailPort(obj.i, value.i)

The port number of the POP3 server. Only needs to be set if the POP3 server is running on a non-standard port. The default value is 110. (If SSL/TLS is used by setting the PopSsl property = 1, then this property should probably be set to 995, which is the standard SSL/TLS port for POP3.)

MaxCount

Declare.i ckMaxCount(obj.i)
Declare setCkMaxCount(obj.i, value.i)

Limits the number of messages the MailMan will try to retrieve from the POP3 server in a single method call. If you are trying to read a large mailbox, you might set this to a value such as 100 to download 100 emails at a time.

OAuth2AccessToken

Declare.s ckOAuth2AccessToken(obj.i)
Declare setCkOAuth2AccessToken(obj.i, value.s)

Introduced in version 9.5.0.44

The OAUTH2 access token if OAUTH2 authentication is to be used for the authentication. For GMail, the Chilkat HTTP class/object's G_SvcOauthAccessToken method can be called to obtain an OAUTH2 access token for a GMail service account.

Starting in v9.5.0.83, this property can be set to also do XOAUTH2 authentication for POP3 sessions (pop.gmail.com).

More Information and Examples

Get GMail SMTP OAuth2 Access Token for Desktop App SMTP XOAUTH2 Authentication POP3 GMail XOAUTH2 Authentication Get POP3 GMail OAuth2 Access Token for Desktop App

OpaqueSigning

Declare.i ckOpaqueSigning(obj.i)
Declare setCkOpaqueSigning(obj.i, value.i)

When 0, a signed email is generated as multipart/signed. For example:

Content-Type: multipart/signed; charset=utf-8; boundary="------------010909020906040709090605";
 protocol="application/pkcs7-signature";
 micalg=sha256

When 1, a signed email is generated as signed-data. For example:

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

A multipart/signed email is such that the signature is contained in a separate MIME body part and the original content of the email is not encapsulated within the signature. A signed-data email is such that it's non-multipart MIME (content type is "application/pkcs7-signature") and the original email is encapsulated within the signature. This is historically known as an opaque signature.

The default value is 1.

P7mEncryptAttachFilename

Declare.s ckP7mEncryptAttachFilename(obj.i)
Declare setCkP7mEncryptAttachFilename(obj.i, value.s)

Introduced in version 9.5.0.30

The filename attribute to be used in the Content-Disposition header field when sending a PCKS7 encrypted email. The default value is "smime.p7m".

P7mSigAttachFilename

Declare.s ckP7mSigAttachFilename(obj.i)
Declare setCkP7mSigAttachFilename(obj.i, value.s)

Introduced in version 9.5.0.30

The filename attribute to be used in the Content-Disposition header field when sending a PCKS7 opaque signed email. The default value is "smime.p7m".

P7sSigAttachFilename

Declare.s ckP7sSigAttachFilename(obj.i)
Declare setCkP7sSigAttachFilename(obj.i, value.s)

Introduced in version 9.5.0.30

The filename attribute to be used in the Content-Disposition header field when sending a signed email with a detached PKCS7 signature. The default value is "smime.p7s".

Pop3SessionId

Declare.i ckPop3SessionId(obj.i) ; (read-only)

0 if no POP3 session is active. Otherwise a positive integer that is incremented with each new POP3 session. It may be used to determine if a new POP3 session has been established.

Pop3SessionLog

Declare.s ckPop3SessionLog(obj.i) ; (read-only)

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

More Information and Examples

POP3 Session Log

Pop3SPA

Declare.i ckPop3SPA(obj.i)
Declare setCkPop3SPA(obj.i, value.i)

Controls whether SPA authentication for POP3 is used or not. To use SPA authentication, set this property = 1. No other programming changes are required. The default value is 0.

Note: If SPA (i.e. NTLM) authentication does not succeed, set the Global.DefaultNtlmVersion property equal to 1 and then retry.

Pop3SslServerCertVerified

Declare.i ckPop3SslServerCertVerified(obj.i) ; (read-only)

When connecting via SSL, this property is 1 if the POP3 server's SSL certificate was verified. Otherwise it is set to 0.

Pop3Stls

Declare.i ckPop3Stls(obj.i)
Declare setCkPop3Stls(obj.i, value.i)

If 1, then an unencrypted connection (typically on port 110) is automatically converted to a secure TLS connection via the STLS command (see RFC 2595) when connecting. This should only be used with POP3 servers that are known to support the STLS capability. If this property is set to 1, then the PopSsl property should be set to 0. (The PopSsl property controls whether the connection is SSL/TLS from the beginning. Setting the Pop3Stls property = 1 indicates that the POP3 client will initially connect unencrypted and then convert to TLS.)

The default value of this property is 0.

More Information and Examples

Pop3StlsIfPossible

Declare.i ckPop3StlsIfPossible(obj.i)
Declare setCkPop3StlsIfPossible(obj.i, value.i)

Introduced in version 9.5.0.92

If 1, then an unencrypted connection (typically on port 110) is automatically converted to a secure TLS connection via the STLS command if the mail server supports the STLS command. If the mail server does not support STLS, then the connection will remain unencrypted.

The default value of this property is 0.

PopPassword

Declare.s ckPopPassword(obj.i)
Declare setCkPopPassword(obj.i, value.s)

The POP3 password.

If the Pop3SPA property is set, the PopUsername and PopPassword 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.

PopPasswordBase64

Declare.s ckPopPasswordBase64(obj.i)
Declare setCkPopPasswordBase64(obj.i, value.s)

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

PopSsl

Declare.i ckPopSsl(obj.i)
Declare setCkPopSsl(obj.i, value.i)

Controls whether TLS/SSL is used when reading email from a POP3 server. Note: Check first to determine if your POP3 server can accept TLS/SSL connections. Also, be sure to set the MailPort property to the TLS/SSL POP3 port number, which is typically 995.

The default value of this property is 0.

PopUsername

Declare.s ckPopUsername(obj.i)
Declare setCkPopUsername(obj.i, value.s)

The POP3 login name.

If the Pop3SPA property is set, the PopUsername and PopPassword 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.

PreferIpv6

Declare.i ckPreferIpv6(obj.i)
Declare setCkPreferIpv6(obj.i, value.i)

If 1, then use IPv6 over IPv4 when both are supported for a particular domain. The default value of this property is 0, which will choose IPv4 over IPv6.

ReadTimeout

Declare.i ckReadTimeout(obj.i)
Declare setCkReadTimeout(obj.i, value.i)

The maximum time to wait, in seconds, if the POP3 or SMTP server stops responding. The default value is 30 seconds.

More Information and Examples

SMTP Timeout Sending Large Emails

RequireSslCertVerify

Declare.i ckRequireSslCertVerify(obj.i)
Declare setCkRequireSslCertVerify(obj.i, value.i)

If 1, then the mailman will verify the SMTP or POP3 server's SSL certificate when connecting. The certificate is expired, or if the cert's signature is invalid, the connection is not allowed. The default value of this property is 0. (Obviously, this only applies to SSL/TLS connections.)

ResetDateOnLoad

Declare.i ckResetDateOnLoad(obj.i)
Declare setCkResetDateOnLoad(obj.i, value.i)

Controls whether the Date header field is reset to the current date/time when an email is loaded from LoadMbx, LoadEml, LoadMime, LoadXml, or LoadXmlString. The default is 0 (to not reset the date). To automatically reset the date, set this property equal to 1.

SendBufferSize

Declare.i ckSendBufferSize(obj.i)
Declare setCkSendBufferSize(obj.i, value.i)

The buffer size to be used with the underlying TCP/IP socket for sending. The default value is 32767.

SendIndividual

Declare.i ckSendIndividual(obj.i)
Declare setCkSendIndividual(obj.i, value.i)

Determines how emails are sent to distribution lists. If 1, emails are sent to each recipient in the list one at a time, with the "To"header field containing the email address of the recipient. If 0, emails will contain in the "To"header field, and are sent to 100 BCC recipients at a time. As an example, if your distribution list contained 350 email addresses, 4 emails would be sent, the first 3 having 100 BCC recipients, and the last email with 50 BCC recipients.The default value of this property is 1.

SizeLimit

Declare.i ckSizeLimit(obj.i)
Declare setCkSizeLimit(obj.i, value.i)

The MailMan will not try to retrieve mail messages from a POP3 server that are greater than this size limit. The default value is 0 indicating no size limit. The SizeLimit is specified in number of bytes.

SmtpAuthMethod

Declare.s ckSmtpAuthMethod(obj.i)
Declare setCkSmtpAuthMethod(obj.i, value.s)

This property should usually be left empty. The MailMan will by default choose the most secure login method available to prevent unencrypted username and passwords from being transmitted if possible. However, some SMTP servers may not advertise the acceptable authorization methods, and therefore it is not possible to automatically determine the best authorization method. To force a particular auth method, or to prevent any authorization from being used, set this property to one of the following values: "NONE", "LOGIN", "PLAIN", "CRAM-MD5", or "NTLM".

Note: If NTLM authentication does not succeed, set the Global.DefaultNtlmVersion property equal to 1 and then retry.

More Information and Examples

Send Email without Authentication (no Login)SMTP NTLM Authentication

SmtpFailReason

Declare.s ckSmtpFailReason(obj.i) ; (read-only)

Introduced in version 9.5.0.48

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

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

SmtpHost

Declare.s ckSmtpHost(obj.i)
Declare setCkSmtpHost(obj.i, value.s)

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.

More Information and Examples

Sending Email without an SMTP Server

SmtpLoginDomain

Declare.s ckSmtpLoginDomain(obj.i)
Declare setCkSmtpLoginDomain(obj.i, value.s)

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.

SmtpPassword

Declare.s ckSmtpPassword(obj.i)
Declare setCkSmtpPassword(obj.i, value.s)

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.

SmtpPipelining

Declare.i ckSmtpPipelining(obj.i)
Declare setCkSmtpPipelining(obj.i, value.i)

Introduced in version 9.5.0.49

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

SmtpPort

Declare.i ckSmtpPort(obj.i)
Declare setCkSmtpPort(obj.i, value.i)

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 1, this property should be set to 465. (TCP port 465 is reserved by common industry practice for secure SMTP communication using the SSL protocol.)

SmtpSessionLog

Declare.s ckSmtpSessionLog(obj.i) ; (read-only)

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.

SmtpSsl

Declare.i ckSmtpSsl(obj.i)
Declare setCkSmtpSsl(obj.i, value.i)

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

More Information and Examples

GMail SMTP port 465 (SSL)AutoFix Explained in More Detail

SmtpSslServerCertVerified

Declare.i ckSmtpSslServerCertVerified(obj.i) ; (read-only)

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

SmtpUsername

Declare.s ckSmtpUsername(obj.i)
Declare setCkSmtpUsername(obj.i, value.s)

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

More Information and Examples

550 5.7.1 Unable to relay

SocksHostname

Declare.s ckSocksHostname(obj.i)
Declare setCkSocksHostname(obj.i, value.s)

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

SocksPassword

Declare.s ckSocksPassword(obj.i)
Declare setCkSocksPassword(obj.i, value.s)

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

SocksPort

Declare.i ckSocksPort(obj.i)
Declare setCkSocksPort(obj.i, value.i)

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

SocksUsername

Declare.s ckSocksUsername(obj.i)
Declare setCkSocksUsername(obj.i, value.s)

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

SocksVersion

Declare.i ckSocksVersion(obj.i)
Declare setCkSocksVersion(obj.i, value.i)

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

Declare.i ckSoRcvBuf(obj.i)
Declare setCkSoRcvBuf(obj.i, value.i)

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.

More Information and Examples

More Information about TCP performance and Buffer Sizes

SoSndBuf

Declare.i ckSoSndBuf(obj.i)
Declare setCkSoSndBuf(obj.i, value.i)

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.

More Information and Examples

More Information about TCP performance and Buffer Sizes

SslAllowedCiphers

Declare.s ckSslAllowedCiphers(obj.i)
Declare setCkSslAllowedCiphers(obj.i, value.s)

Introduced in version 9.5.0.48

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

To 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"

SslProtocol

Declare.s ckSslProtocol(obj.i)
Declare setCkSslProtocol(obj.i, value.s)

Introduced in version 9.5.0.46

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

The 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".

StartTLS

Declare.i ckStartTLS(obj.i)
Declare setCkStartTLS(obj.i, value.i)

When set to 1, 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 0.

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

More Information and Examples

GMail SMTP port 587 (STARTTLS)

StartTLSifPossible

Declare.i ckStartTLSifPossible(obj.i)
Declare setCkStartTLSifPossible(obj.i, value.i)

Introduced in version 9.5.0.67

When set to 1, 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 1.

Note: Setting the StartTLS property = 1 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.

TlsCipherSuite

Declare.s ckTlsCipherSuite(obj.i) ; (read-only)

Introduced in version 9.5.0.49

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.

TlsPinSet

Declare.s ckTlsPinSet(obj.i)
Declare setCkTlsPinSet(obj.i, value.s)

Introduced in version 9.5.0.55

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.

More Information and Examples

Encodings Supported by Chilkat

TlsVersion

Declare.s ckTlsVersion(obj.i) ; (read-only)

Introduced in version 9.5.0.49

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

UncommonOptions

Declare.s ckUncommonOptions(obj.i)
Declare setCkUncommonOptions(obj.i, value.s)

Introduced in version 9.5.0.80

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.

More Information and Examples

SMTP Enable TLS 1.3

UseApop

Declare.i ckUseApop(obj.i)
Declare setCkUseApop(obj.i, value.i)

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

VerboseLogging

Declare.i ckVerboseLogging(obj.i)
Declare setCkVerboseLogging(obj.i, value.i)

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

Version

Declare.s ckVersion(obj.i) ; (read-only)

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddPfxSourceFile

Declare.i ckAddPfxSourceFile(obj.i, pfxFilePath.s, password.s)

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 1 for success, 0 for failure.

CheckMail

Declare.i ckCheckMail(obj.i)

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.

More Information and Examples

Test HotMail POP3 (pop3.live.com or pop-mail.outlook.com)

CheckMailAsync ⁽¹⁾

Declare.i ckCheckMailAsync(obj.i)

Creates an asynchronous task to call the CheckMail method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

ClearBadEmailAddresses

Declare ckClearBadEmailAddresses(obj.i)

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.

ClearPop3SessionLog

Declare ckClearPop3SessionLog(obj.i)

Clears the contents of the Pop3SessionLog property.

ClearSmtpSessionLog

Declare ckClearSmtpSessionLog(obj.i)

Clears the contents of the SmtpSessionLog property.

CloseSmtpConnection

Declare.i ckCloseSmtpConnection(obj.i)

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 1 for success, 0 for failure.

More Information and Examples

Minimizing SMTP Sessions

CloseSmtpConnectionAsync ⁽¹⁾

Declare.i ckCloseSmtpConnectionAsync(obj.i)

Creates an asynchronous task to call the CloseSmtpConnection method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

CopyMail

Declare.i ckCopyMail(obj.i)

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

Returns 0 on failure

More Information and Examples

POP3 CopyMail Example

CopyMailAsync ^{(1) (2)}

Declare.i ckCopyMailAsync(obj.i)

Creates an asynchronous task to call the CopyMail method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

DeleteBundle

Declare.i ckDeleteBundle(obj.i, emailBundle.i)

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 1, which is the default. If ImmediateDelete equals 0, 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 1 for success, 0 for failure.

DeleteBundleAsync ⁽¹⁾

Declare.i ckDeleteBundleAsync(obj.i, emailBundle.i)

Creates an asynchronous task to call the DeleteBundle method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

DeleteByMsgnum

Declare.i ckDeleteByMsgnum(obj.i, msgnum.l)

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 1 for success, 0 for failure.

DeleteByMsgnumAsync ⁽¹⁾

Declare.i ckDeleteByMsgnumAsync(obj.i, msgnum.l)

Creates an asynchronous task to call the DeleteByMsgnum method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

DeleteByUidl

Declare.i ckDeleteByUidl(obj.i, uidl.s)

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 1, which is the default. If ImmediateDelete equals 0, 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 1 for success, 0 for failure.

DeleteByUidlAsync ⁽¹⁾

Declare.i ckDeleteByUidlAsync(obj.i, uidl.s)

Creates an asynchronous task to call the DeleteByUidl method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

DeleteEmail

Declare.i ckDeleteEmail(obj.i, email.i)

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 1, which is the default. If ImmediateDelete equals 0, 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 1 for success, 0 for failure.

DeleteEmailAsync ⁽¹⁾

Declare.i ckDeleteEmailAsync(obj.i, email.i)

Creates an asynchronous task to call the DeleteEmail method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

DeleteMultiple

Declare.i ckDeleteMultiple(obj.i, uidlArray.i)

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 1, which is the default. If ImmediateDelete equals 0, 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 1 for success, 0 for failure.

More Information and Examples

Using GMail? You'll need to read this information.

DeleteMultipleAsync ⁽¹⁾

Declare.i ckDeleteMultipleAsync(obj.i, uidlArray.i)

Creates an asynchronous task to call the DeleteMultiple method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

FetchByMsgnum

Declare.i ckFetchByMsgnum(obj.i, msgnum.l)

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 0 on failure

FetchByMsgnumAsync ^{(1) (2)}

Declare.i ckFetchByMsgnumAsync(obj.i, msgnum.l)

Creates an asynchronous task to call the FetchByMsgnum method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

FetchEmail

Declare.i ckFetchEmail(obj.i, uidl.s)

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 0 on failure

More Information and Examples

POP3 Fetch a Single Email by UIDL

FetchEmailAsync ^{(1) (2)}

Declare.i ckFetchEmailAsync(obj.i, uidl.s)

Creates an asynchronous task to call the FetchEmail method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

FetchMimeBd

Declare.i ckFetchMimeBd(obj.i, uidl.s, mimeData.i)

Introduced in version 9.5.0.73

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

Returns 1 for success, 0 for failure.

More Information and Examples

POP3 Fetch Mime Source of Email by UIDL

FetchMimeBdAsync ⁽¹⁾

Declare.i ckFetchMimeBdAsync(obj.i, uidl.s, mimeData.i)

Introduced in version 9.5.0.73

Creates an asynchronous task to call the FetchMimeBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

FetchMultiple

Declare.i ckFetchMultiple(obj.i, uidlArray.i)

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 0 on failure

More Information and Examples

Process Large POP3 Mailbox

FetchMultipleAsync ^{(1) (2)}

Declare.i ckFetchMultipleAsync(obj.i, uidlArray.i)

Creates an asynchronous task to call the FetchMultiple method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

FetchMultipleHeaders

Declare.i ckFetchMultipleHeaders(obj.i, uidlArray.i, numBodyLines.l)

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 0 on failure

FetchMultipleHeadersAsync ^{(1) (2)}

Declare.i ckFetchMultipleHeadersAsync(obj.i, uidlArray.i, numBodyLines.l)

Creates an asynchronous task to call the FetchMultipleHeaders method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

FetchMultipleMime

Declare.i ckFetchMultipleMime(obj.i, uidlArray.i)

Given an array of UIDL strings, fetchs all the emails from the POP3 server whose UIDL is present in the array, and returns the MIME source of each email in an "stringarray" -- an object containing a collection of strings. Returns a null reference on failure.

Returns 0 on failure

FetchMultipleMimeAsync ^{(1) (2)}

Declare.i ckFetchMultipleMimeAsync(obj.i, uidlArray.i)

Creates an asynchronous task to call the FetchMultipleMime method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

FetchSingleHeader

Declare.i ckFetchSingleHeader(obj.i, numBodyLines.l, messageNumber.l)

Fetches a single header by message number. 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 messageNumber lines of either the plain-text or HTML body will be present).

Also Important:Message numbers are specific to a POP3 session (whereas UIDLs are valid across sessions). Be very careful when using this method.

Returns 0 on failure

FetchSingleHeaderAsync ^{(1) (2)}

Declare.i ckFetchSingleHeaderAsync(obj.i, numBodyLines.l, messageNumber.l)

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 0 on failure

FetchSingleHeaderByUidl

Declare.i ckFetchSingleHeaderByUidl(obj.i, numBodyLines.l, uidl.s)

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 0 on failure

FetchSingleHeaderByUidlAsync ^{(1) (2)}

Declare.i ckFetchSingleHeaderByUidlAsync(obj.i, numBodyLines.l, uidl.s)

Creates an asynchronous task to call the FetchSingleHeaderByUidl method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetAllHeaders

Declare.i ckGetAllHeaders(obj.i, numBodyLines.l)

Returns all the emails from the POP3 server, but only the first numBodyLines lines of the body. Attachments are not returned. The emails returned in the bundle are valid email objects, the only difference is that the body is truncated to include only the top numBodyLines lines, and the attachments will be missing.

Returns 0 on failure

GetAllHeadersAsync ^{(1) (2)}

Declare.i ckGetAllHeadersAsync(obj.i, numBodyLines.l)

Creates an asynchronous task to call the GetAllHeaders method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetBadEmailAddrs

Declare.i ckGetBadEmailAddrs(obj.i)

Returns a string array object containing a list of failed and invalid email addresses that have accumulated during SMTP sends. The list will not contain duplicates. Also, this only works with some SMTP servers -- not all SMTP servers check the validity of each email address.

Note: An SMTP server can only validate the email addresses within it's own domain. External email address are not verifiable at the time of sending.

Returns 0 on failure

More Information and Examples

MailMan GetBadEmailAddrs

GetFullEmail

Declare.i ckGetFullEmail(obj.i, email.i)

If a partial email was obtained using GetHeaders or GetAllHeaders, this method will take the partial email as an argument, and download the full email from the server. A new email object (separate from the partial email) is returned. A null reference is returned on failure.

Returns 0 on failure

GetFullEmailAsync ^{(1) (2)}

Declare.i ckGetFullEmailAsync(obj.i, email.i)

Creates an asynchronous task to call the GetFullEmail method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetHeaders

Declare.i ckGetHeaders(obj.i, numBodyLines.l, fromIndex.l, toIndex.l)

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 0 on failure

GetHeadersAsync ^{(1) (2)}

Declare.i ckGetHeadersAsync(obj.i, numBodyLines.l, fromIndex.l, toIndex.l)

Creates an asynchronous task to call the GetHeaders method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetMailboxCount

Declare.i ckGetMailboxCount(obj.i)

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

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

GetMailboxCountAsync ⁽¹⁾

Declare.i ckGetMailboxCountAsync(obj.i)

Creates an asynchronous task to call the GetMailboxCount method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetMailboxInfoXml

Declare.s ckGetMailboxInfoXml(obj.i)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples

Example: Get POP3 Mailbox XML Summary

GetMailboxInfoXmlAsync ⁽¹⁾

Declare.i ckGetMailboxInfoXmlAsync(obj.i)

Creates an asynchronous task to call the GetMailboxInfoXml method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetMailboxSize

Declare.i ckGetMailboxSize(obj.i)

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.

GetMailboxSizeAsync ⁽¹⁾

Declare.i ckGetMailboxSizeAsync(obj.i)

Creates an asynchronous task to call the GetMailboxSize method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetPop3SslServerCert

Declare.i ckGetPop3SslServerCert(obj.i)

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

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

Returns 0 on failure

GetSentToEmailAddrs

Declare.i ckGetSentToEmailAddrs(obj.i)

Returns the list of successful email addresses in the last call to a mail sending method, such as SendEmail.

When an email is sent, the email addresses that were flagged invalid by the SMTP server are saved in a "bad email addresses" list within the mailman object, and the acceptable email addresses are saved in a "good email addresses" list (within the mailman object). These internal lists are automatically reset at the start of the next mail-sending method call. This allows for a program to know which email addresses were accepted and which were not.

Note: The AllOrNone property controls whether the mail-sending method, such as SendEmail, returns 0 (to indicate failure) if any single email address is rejected.

Note: An SMTP server can only be aware of invalid email addresses that are of the same domain. For example, the comcast.net mail servers would only be aware of what comcast.net email addresses are valid. All external email addresses are implicitly accepted because the server is simply forwarding the email towards the mail server controlling that domain.

Returns 0 on failure

More Information and Examples

MailMan GetSentToEmailAddrs

GetSizeByUidl

Declare.i ckGetSizeByUidl(obj.i, uidl.s)

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

GetSizeByUidlAsync ⁽¹⁾

Declare.i ckGetSizeByUidlAsync(obj.i, uidl.s)

Creates an asynchronous task to call the GetSizeByUidl method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

GetSmtpSslServerCert

Declare.i ckGetSmtpSslServerCert(obj.i)

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

Returns 0 on failure

GetUidls

Declare.i ckGetUidls(obj.i)

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

Returns 0 on failure

More Information and Examples

Retrieve UIDL's from POP3 Server

GetUidlsAsync ^{(1) (2)}

Declare.i ckGetUidlsAsync(obj.i)

Creates an asynchronous task to call the GetUidls method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

IsSmtpDsnCapable

Declare.i ckIsSmtpDsnCapable(obj.i)

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 1 if the SMTP server supports DSN, otherwise returns 0.

IsSmtpDsnCapableAsync ⁽¹⁾

Declare.i ckIsSmtpDsnCapableAsync(obj.i)

Creates an asynchronous task to call the IsSmtpDsnCapable method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

LastJsonData

Declare.i ckLastJsonData(obj.i)

Introduced in version 9.5.0.69

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 0 on failure

LoadEml

Declare.i ckLoadEml(obj.i, emlFilename.s)

Loads an email from a .eml file. (EML files contain the MIME source of an email.) Returns a null reference on failure.

Note: MHT files can be loaded into an email object by calling this method.

Returns 0 on failure

More Information and Examples

LoadMbx

Declare.i ckLoadMbx(obj.i, mbxFileName.s)

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

Returns 0 on failure

LoadMime

Declare.i ckLoadMime(obj.i, mimeText.s)

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

Returns 0 on failure

LoadTaskCaller

Declare.i ckLoadTaskCaller(obj.i, task.i)

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns 1 for success, 0 for failure.

LoadXmlEmail

Declare.i ckLoadXmlEmail(obj.i, filename.s)

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

Returns 0 on failure

LoadXmlEmailString

Declare.i ckLoadXmlEmailString(obj.i, xmlString.s)

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

Returns 0 on failure

LoadXmlFile

Declare.i ckLoadXmlFile(obj.i, filename.s)

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 0 on failure

LoadXmlString

Declare.i ckLoadXmlString(obj.i, xmlString.s)

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 0 on failure

MxLookup

Declare.s ckMxLookup(obj.i, emailAddress.s)

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

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples

MX Lookup Example

MxLookupAll

Declare.i ckMxLookupAll(obj.i, emailAddress.s)

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 0 on failure

OpenSmtpConnection

Declare.i ckOpenSmtpConnection(obj.i)

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 1 for success, 0 for failure.

More Information and Examples

Minimizing SMTP Connections SMTP SSH Tunneling (Port Forwarding)Send Email with Hotmail (live.com) -- smtp-mail.outlook.com

OpenSmtpConnectionAsync ⁽¹⁾

Declare.i ckOpenSmtpConnectionAsync(obj.i)

Creates an asynchronous task to call the OpenSmtpConnection method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

Pop3Authenticate

Declare.i ckPop3Authenticate(obj.i)

Introduced in version 9.5.0.56

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 1 for success, 0 for failure.

Pop3AuthenticateAsync ⁽¹⁾

Declare.i ckPop3AuthenticateAsync(obj.i)

Introduced in version 9.5.0.56

Creates an asynchronous task to call the Pop3Authenticate method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

Pop3BeginSession

Declare.i ckPop3BeginSession(obj.i)

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 1 for success, 0 for failure.

More Information and Examples

More about POP3 Session Management

Pop3BeginSessionAsync ⁽¹⁾

Declare.i ckPop3BeginSessionAsync(obj.i)

Creates an asynchronous task to call the Pop3BeginSession method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

Pop3Connect

Declare.i ckPop3Connect(obj.i)

Introduced in version 9.5.0.56

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 1 for success, 0 for failure.

Pop3ConnectAsync ⁽¹⁾

Declare.i ckPop3ConnectAsync(obj.i)

Introduced in version 9.5.0.56

Creates an asynchronous task to call the Pop3Connect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

Pop3EndSession

Declare.i ckPop3EndSession(obj.i)

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 0, and emails marked for deletion will be deleted at this time.

Returns 1 for success, 0 for failure.

More Information and Examples

More about POP3 Session Management Test HotMail POP3 (pop3.live.com or pop-mail.outlook.com)

Pop3EndSessionAsync ⁽¹⁾

Declare.i ckPop3EndSessionAsync(obj.i)

Creates an asynchronous task to call the Pop3EndSession method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

Pop3EndSessionNoQuit

Declare.i ckPop3EndSessionNoQuit(obj.i)

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

Pop3EndSessionNoQuitAsync ⁽¹⁾

Declare.i ckPop3EndSessionNoQuitAsync(obj.i)

Creates an asynchronous task to call the Pop3EndSessionNoQuit method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

Pop3Noop

Declare.i ckPop3Noop(obj.i)

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 1 for success, 0 for failure.

Pop3NoopAsync ⁽¹⁾

Declare.i ckPop3NoopAsync(obj.i)

Creates an asynchronous task to call the Pop3Noop method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

Pop3Reset

Declare.i ckPop3Reset(obj.i)

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 1 for success, 0 for failure.

Pop3ResetAsync ⁽¹⁾

Declare.i ckPop3ResetAsync(obj.i)

Creates an asynchronous task to call the Pop3Reset method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

Pop3SendRawCommand

Declare.s ckPop3SendRawCommand(obj.i, command.s, charset.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

Pop3SendRawCommandAsync ⁽¹⁾

Declare.i ckPop3SendRawCommandAsync(obj.i, command.s, charset.s)

Creates an asynchronous task to call the Pop3SendRawCommand method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

QuickSend

Declare.i ckQuickSend(obj.i, fromAddr.s, toAddr.s, subject.s, body.s, smtpServer.s)

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

Returns 1 for success, 0 for failure.

QuickSendAsync ⁽¹⁾

Declare.i ckQuickSendAsync(obj.i, fromAddr.s, toAddr.s, subject.s, body.s, smtpServer.s)

Creates an asynchronous task to call the QuickSend method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

RenderToMime

Declare.s ckRenderToMime(obj.i, email.i)

When an email is sent by calling SendEmail, it is first "rendered" according to the values of the email properties and contents. It may be digitally signed, encrypted, values substituted for replacement patterns, and header fields "Q"or "B" encoded as needed based on the email. The RenderToMime method performs the rendering, but without the actual sending. The MIME text produced is exactly what would be sent to the SMTP server had SendEmail been called. (The SendEmail method is effectively the same as calling RenderToMime followed by a call to SendMime.)

The rendered MIME string is returned on success.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples

Using Replace Patterns in Email

RenderToMimeBd

Declare.i ckRenderToMimeBd(obj.i, email.i, renderedMime.i)

Introduced in version 9.5.0.62

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

Returns 1 for success, 0 for failure.

More Information and Examples

Send DKIM Signed Email

RenderToMimeSb

Declare.i ckRenderToMimeSb(obj.i, email.i, renderedMime.i)

Introduced in version 9.5.0.62

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

Returns 1 for success, 0 for failure.

More Information and Examples

Sign Email using RSASSA-PSS with SHA256 Encrypt Email using RSAES-OAEP with AES-128 CBC and SHA256

SendBundle

Declare.i ckSendBundle(obj.i, bundle.i)

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 1 for success, 0 for failure.

SendBundleAsync ⁽¹⁾

Declare.i ckSendBundleAsync(obj.i, bundle.i)

Creates an asynchronous task to call the SendBundle method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SendEmail

Declare.i ckSendEmail(obj.i, email.i)

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 1 if the final SMTP status code in the SMTP session is in the 200's or 300's. See SMTP Server Return Codes

Returns 1 for success, 0 for failure.

More Information and Examples

Send Email GMail SMTP Send using Previously Obtained OAuth2 Access Token Configure GMail for less secure apps Diagnosing SMTP Failures SocketError: WSAECONNABORTED when Sending Email (SMTP)SMTP 553-Relaying Denied 550 5.7.1 Unable to relay Using undisclosed recipients / Send Failed sockError: 10053, WSAECONNABORTED An established connection was aborted by the software in your host machine Sending Email without a Mail Server (sort of)Invalid Token error when trying to connect with SSL (SMTP, POP3, IMAP, FTP, HTTP)SMTP SSL Clarification Read Receipt vs. Delivery Receipt when Sending Email Validating an Email Address - Unfortunately, Nothing is Perfect POP-before-SMTP Authentication Send Email with Copy Placed in the Sent Folder Send Email Asynchronously using a Task

SendEmailAsync ⁽¹⁾

Declare.i ckSendEmailAsync(obj.i, email.i)

Creates an asynchronous task to call the SendEmail method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SendMime

Declare.i ckSendMime(obj.i, fromAddr.s, recipients.s, mimeSource.s)

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 1 if the final SMTP status code in the SMTP session is in the 200's or 300's. See SMTP Server Return Codes

Returns 1 for success, 0 for failure.

More Information and Examples

SMTP Protocol in a Nutshell Email send function returns success, but recipient never receives email?

SendMimeAsync ⁽¹⁾

Declare.i ckSendMimeAsync(obj.i, fromAddr.s, recipients.s, mimeSource.s)

Creates an asynchronous task to call the SendMime method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SendMimeBd

Declare.i ckSendMimeBd(obj.i, fromAddr.s, recipients.s, mimeData.i)

Introduced in version 9.5.0.73

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

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

Returns 1 for success, 0 for failure.

More Information and Examples

Send DKIM Signed Email Send Email to Distribution List

SendMimeBdAsync ⁽¹⁾

Declare.i ckSendMimeBdAsync(obj.i, fromAddr.s, recipients.s, mimeData.i)

Introduced in version 9.5.0.73

Creates an asynchronous task to call the SendMimeBd method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SendMimeToList

Declare.i ckSendMimeToList(obj.i, fromAddr.s, distListFilename.s, mimeSource.s)

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

Returns 1 for success, 0 for failure.

SendMimeToListAsync ⁽¹⁾

Declare.i ckSendMimeToListAsync(obj.i, fromAddr.s, distListFilename.s, mimeSource.s)

Creates an asynchronous task to call the SendMimeToList method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SetDecryptCert

Declare.i ckSetDecryptCert(obj.i, cert.i)

Introduced in version 9.5.0.40

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

Returns 1 for success, 0 for failure.

SetDecryptCert2

Declare.i ckSetDecryptCert2(obj.i, cert.i, privateKey.i)

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 1 for success, 0 for failure.

SetPassword

Declare.i ckSetPassword(obj.i, protocol.s, password.i)

Introduced in version 9.5.0.71

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 1 for success, 0 for failure.

More Information and Examples

POP3 Login Secure SMTP Login Secure

SetSslClientCert

Declare.i ckSetSslClientCert(obj.i, cert.i)

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 1 for success, 0 for failure.

SetSslClientCertPem

Declare.i ckSetSslClientCertPem(obj.i, pemDataOrFilename.s, pemPassword.s)

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

Returns 1 for success, 0 for failure.

More Information and Examples

How to Create a PEM that Contains Certificates and a Private Key

SetSslClientCertPfx

Declare.i ckSetSslClientCertPfx(obj.i, pfxFilename.s, pfxPassword.s)

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

Returns 1 for success, 0 for failure.

SmtpAuthenticate

Declare.i ckSmtpAuthenticate(obj.i)

Introduced in version 9.5.0.48

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 1 for success, 0 for failure.

More Information and Examples

GMail App Password

SmtpAuthenticateAsync ⁽¹⁾

Declare.i ckSmtpAuthenticateAsync(obj.i)

Introduced in version 9.5.0.48

Creates an asynchronous task to call the SmtpAuthenticate method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SmtpConnect

Declare.i ckSmtpConnect(obj.i)

Introduced in version 9.5.0.48

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 1 for success, 0 for failure.

More Information and Examples

SMTP Connect and Authenticate

SmtpConnectAsync ⁽¹⁾

Declare.i ckSmtpConnectAsync(obj.i)

Introduced in version 9.5.0.48

Creates an asynchronous task to call the SmtpConnect method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SmtpNoop

Declare.i ckSmtpNoop(obj.i)

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 1 for success, 0 for failure.

SmtpNoopAsync ⁽¹⁾

Declare.i ckSmtpNoopAsync(obj.i)

Creates an asynchronous task to call the SmtpNoop method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SmtpReset

Declare.i ckSmtpReset(obj.i)

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 1 for success, 0 for failure.

SmtpResetAsync ⁽¹⁾

Declare.i ckSmtpResetAsync(obj.i)

Creates an asynchronous task to call the SmtpReset method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SmtpSendRawCommand

Declare.s ckSmtpSendRawCommand(obj.i, command.s, charset.s, bEncodeBase64.l)

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 1, then the response is returned in Base64-encoded format. Otherwise the raw response is returned.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

More Information and Examples

SMTP Send Raw Command

SmtpSendRawCommandAsync ⁽¹⁾

Declare.i ckSmtpSendRawCommandAsync(obj.i, command.s, charset.s, bEncodeBase64.l)

Creates an asynchronous task to call the SmtpSendRawCommand method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

SshAuthenticatePk

Declare.i ckSshAuthenticatePk(obj.i, sshLogin.s, sshUsername.i)

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 1 for success, 0 for failure.

SshAuthenticatePkAsync ⁽¹⁾

Declare.i ckSshAuthenticatePkAsync(obj.i, sshLogin.s, sshUsername.i)

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 0 on failure

SshAuthenticatePw

Declare.i ckSshAuthenticatePw(obj.i, sshLogin.s, sshPassword.s)

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 1 for success, 0 for failure.

More Information and Examples

POP3 SSH Tunneling (Port Forwarding)SMTP SSH Tunneling (Port Forwarding)

SshAuthenticatePwAsync ⁽¹⁾

Declare.i ckSshAuthenticatePwAsync(obj.i, sshLogin.s, sshPassword.s)

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 0 on failure

SshCloseTunnel

Declare.i ckSshCloseTunnel(obj.i)

Closes the SSH tunnel for SMTP or POP3.

Returns 1 for success, 0 for failure.

SshCloseTunnelAsync ⁽¹⁾

Declare.i ckSshCloseTunnelAsync(obj.i)

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 0 on failure

SshOpenTunnel

Declare.i ckSshOpenTunnel(obj.i, sshHostname.s, sshPort.l)

Introduced in version 9.5.0.50

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 1 for success, 0 for failure.

More Information and Examples

POP3 SSH Tunneling (Port Forwarding)SMTP SSH Tunneling (Port Forwarding)

SshOpenTunnelAsync ⁽¹⁾

Declare.i ckSshOpenTunnelAsync(obj.i, sshHostname.s, sshPort.l)

Introduced in version 9.5.0.50

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 0 on failure

TransferMail

Declare.i ckTransferMail(obj.i)

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

Returns 0 on failure

TransferMailAsync ^{(1) (2)}

Declare.i ckTransferMailAsync(obj.i)

Creates an asynchronous task to call the TransferMail method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

TransferMultipleMime

Declare.i ckTransferMultipleMime(obj.i, uidlArray.i)

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

Returns 0 on failure

TransferMultipleMimeAsync ^{(1) (2)}

Declare.i ckTransferMultipleMimeAsync(obj.i, uidlArray.i)

Creates an asynchronous task to call the TransferMultipleMime method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

UseCertVault

Declare.i ckUseCertVault(obj.i, vault.i)

Introduced in version 9.5.0.40

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 1 for success, 0 for failure.

UseSsh

Declare.i ckUseSsh(obj.i, ssh.i)

Introduced in version 9.5.0.55

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 1 for success, 0 for failure.

More Information and Examples

SMTP over Multiple Hop SSH POP3 over Multiple Hop SSH

UseSshTunnel

Declare.i ckUseSshTunnel(obj.i, tunnel.i)

Introduced in version 9.5.0.50

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 1 for success, 0 for failure.

VerifyPopConnection

Declare.i ckVerifyPopConnection(obj.i)

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

VerifyPopConnectionAsync ⁽¹⁾

Declare.i ckVerifyPopConnectionAsync(obj.i)

Creates an asynchronous task to call the VerifyPopConnection method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

VerifyPopLogin

Declare.i ckVerifyPopLogin(obj.i)

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

VerifyPopLoginAsync ⁽¹⁾

Declare.i ckVerifyPopLoginAsync(obj.i)

Creates an asynchronous task to call the VerifyPopLogin method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

VerifyRecips

Declare.i ckVerifyRecips(obj.i, email.i, badAddrs.i)

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

Returns 1 for success, 0 for failure.

More Information and Examples

Verify Email Recipients

VerifyRecipsAsync ⁽¹⁾

Declare.i ckVerifyRecipsAsync(obj.i, email.i, badAddrs.i)

Creates an asynchronous task to call the VerifyRecips method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

VerifySmtpConnection

Declare.i ckVerifySmtpConnection(obj.i)

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

VerifySmtpConnectionAsync ⁽¹⁾

Declare.i ckVerifySmtpConnectionAsync(obj.i)

Creates an asynchronous task to call the VerifySmtpConnection method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure

VerifySmtpLogin

Declare.i ckVerifySmtpLogin(obj.i)

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

VerifySmtpLoginAsync ⁽¹⁾

Declare.i ckVerifySmtpLoginAsync(obj.i)

Creates an asynchronous task to call the VerifySmtpLogin method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Returns 0 on failure