MailMan ActiveX Reference Documentation

MailMan

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

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatMailMan2
(ASP)
set obj = Server.CreateObject("Chilkat.MailMan")
(VBScript)
set obj = CreateObject("Chilkat.MailMan")
(Delphi)
obj := TChilkatMailMan2.Create(Self);
(FoxPro)
loObject = CreateObject('Chilkat.MailMan')
(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.MailMan', @obj OUT
(Javascript)
var obj = new ActiveXObject("Chilkat.MailMan");

Properties

AllOrNone As Long

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.

AutoFix As Long

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.

AutoGenMessageId As Long

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.

AutoSmtpRset As Long

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

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

ClientIpAddress As String

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

Important Bind to Adapter Notes for Windows

ConnectTimeout As Long

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

DebugLogFilePath As String

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:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

DsnEnvid As String

(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 As String

(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 As String

(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 As Long

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 As String

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

More information about the Filter property (for POP3)

HeartbeatMs As Long

The time interval, in milliseconds, between AbortCheck event callbacks. The heartbeat provides a means for an application to monitor a mail-sending and/or mail-reading method call, and to abort it while in progress.

HeloHostname As String

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 As String

If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy authentication method name. Valid choices are "LOGIN" or "NTLM".

HttpProxyDomain As String

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

HttpProxyHostname As String

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

HttpProxyPassword As String

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

HttpProxyPort As Long

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 As String

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

ImmediateDelete As Long

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.

POP3 Session Management

IncludeRootCert As Long

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.

IsSmtpConnected As Long (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 in a previous method call).

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 will only be detected when attempting to communicate with the server. To truly determine if a connection to the SMTP server is open and valid, one might call the SmtpNoop method instead. This property can return 1 if the server has disconnected, but the client has not attempted to communicate with the server since the disconnect.

LastErrorHtml As String (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 As String (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.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (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.

LastSendQFilename As String (read-only)

The name of the file created in the SMTPQ's queue directory for the last email sent via SendQ, SendQ2, or SendMimeQ.

LastSmtpStatus As Long (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.

LogMailReceivedFilename As String

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 As String

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

MailHost As String

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 As Long

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 As Long

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.

OpaqueSigning As Long

When set to 1, signed emails are sent using opaque signing. The default is to send clear-text (multipart/signed) emails.

Pop3SPA As Long

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

Pop3SessionId As Long (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 As String (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.

Pop3SslServerCertVerified As Long (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 As Long

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

PopPassword As String

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 As String

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

PopSsl As Long

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.

PopUsername As String

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.

ReadTimeout As Long

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

RequireSslCertVerify As Long

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 As Long

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 As Long

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

SendIndividual As Long

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 is value of this property is 1.

SizeLimit As Long

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 As String

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

SmtpHost As String

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.

Sending Email without an SMTP Server

SmtpLoginDomain As String

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 As String

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.

SmtpPort As Long

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 As String (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 As Long

When set to 1, causes the mailman to connect to the SMTP server via the TLS/SSL protocol.

(ASP) GMail SMTP port 465 (SSL)

(VB6) GMail SMTP port 465 (SSL)

(Delphi) GMail SMTP port 465 (SSL)

(FoxPro) GMail SMTP port 465 (SSL)

(VBScript) GMail SMTP port 465 (SSL)

SmtpSslServerCertVerified As Long (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 As String

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

550 5.7.1 Unable to relay

SoRcvBuf As Long

Sets the receive buffer size socket option. Normally, this property should be left unchanged. The default value is 0, which indicates that the receive buffer size socket option should not be explicitly set (i.e. the system default value, which may vary from system to system, should be used).

This property can be changed if download performance seems slow. It is recommended to be a multiple of 4096. To see the current system's default receive buffer size, examine the LastErrorText property after calling any method that establishes a connection. It should be reported under the heading "SO_RCVBUF". To boost performance, try setting it equal to 2, 3, or 4 times the default value.

More Information about TCP performance and Buffer Sizes

SoSndBuf As Long

Sets the send buffer size socket option. Normally, this property should be left unchanged. The default value is 0, which indicates that the send buffer size socket option should not be explicitly set (i.e. the system default value, which may vary from system to system, should be used).

This property can be changed if upload performance seems slow. It is recommended to be a multiple of 4096. To see the current system's default send buffer size, examine the LastErrorText property after calling any method that establishes a connection. It should be reported under the heading "SO_SNDBUF". To boost performance, try setting it equal to 2, 3, or 4 times the default value.

Note: This property only applies to FTP data connections. The control connection (for sending commands and getting responses) is not typically a performance issue.

More Information about TCP performance and Buffer Sizes

SocksHostname As String

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 As String

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

SocksPort As Long

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 As String

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

SocksVersion As Long

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.

StartTLS As Long

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.

(ASP) GMail SMTP port 587 (STARTTLS)

(VB6) GMail SMTP port 587 (STARTTLS)

(Delphi) GMail SMTP port 587 (STARTTLS)

(FoxPro) GMail SMTP port 587 (STARTTLS)

(VBScript) GMail SMTP port 587 (STARTTLS)

UseApop As Long

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

VerboseLogging As Long

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 As String (read-only)

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

Methods

AddPfxSourceData(pfxData As Variant, password As String) As Long

Adds a PFX to the object's internal list of sources to be searched for certificates and private keys when decrypting or when creating signed email for sending. Multiple PFX sources can be added by calling this method once for each. (On the Windows operating system, the registry-based certificate stores are also automatically searched, so it is commonly not required to explicitly add PFX sources.)

The pfxData contains the bytes of a PFX file (also known as PKCS12 or .p12).

Returns 1 for success, 0 for failure.

AddPfxSourceFile(pfxFilePath As String, password As String) As Long

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() As Long

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.

ClearBadEmailAddresses()

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

Clears the contents of the Pop3SessionLog property.

ClearSmtpSessionLog()

Clears the contents of the SmtpSessionLog property.

CloseSmtpConnection() As Long

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.

Minimizing SMTP Sessions

CopyMail() As ChilkatEmailBundle2

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

DeleteBundle(emailBundle As ChilkatEmailBundle2) As Long

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.

DeleteByMsgnum(msgnum As Long) As Long

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.

DeleteByUidl(uidl As String) As Long

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.

DeleteEmail(email As ChilkatEmail2) As Long

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.

DeleteMultiple(uidlArray As CkStringArray) As Long

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.

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

FetchByMsgnum(msgnum As Long) As ChilkatEmail2

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

FetchEmail(uidl As String) As ChilkatEmail2

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.

FetchMime(uidl As String) As Variant

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

Returns 1 for success, 0 for failure.

FetchMimeByMsgnum(msgnum As Long) As Variant

Fetches an email by message number and returns the MIME source of the email in a byte array. WARNING: Message sequend 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 1 for success, 0 for failure.

FetchMultiple(uidlArray As CkStringArray) As ChilkatEmailBundle2

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.

(ASP) Process Large POP3 Mailbox

(VB6) Process Large POP3 Mailbox

(Delphi) Process Large POP3 Mailbox

(FoxPro) Process Large POP3 Mailbox

(VBScript) Process Large POP3 Mailbox

FetchMultipleHeaders(uidlArray As CkStringArray, numBodyLines As Long) As ChilkatEmailBundle2

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

FetchMultipleMime(uidlArray As CkStringArray) As CkStringArray

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.

FetchSingleHeader(numBodyLines As Long, messageNumber As Long) As ChilkatEmail2

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.

FetchSingleHeaderByUidl(numBodyLines As Long, uidl As String) As ChilkatEmail2

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

GetAllHeaders(numBodyLines As Long) As ChilkatEmailBundle2

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.

GetBadEmailAddresses(strArray As Chilkat)

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.

GetFullEmail(email As ChilkatEmail2) As ChilkatEmail2

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.

GetHeaders(numBodyLines As Long, fromIndex As Long, toIndex As Long) As ChilkatEmailBundle2

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.

GetMailboxCount() As Long

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

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

GetMailboxInfoXml() As String

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

(ASP) Example: Get POP3 Mailbox XML Summary

(VB6) Example: Get POP3 Mailbox XML Summary

(Delphi) Example: Get POP3 Mailbox XML Summary

(FoxPro) Example: Get POP3 Mailbox XML Summary

(VBScript) Example: Get POP3 Mailbox XML Summary

GetMailboxSize() As Long

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.

GetPop3SslServerCert() As ChilkatCert

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.

GetSentToEmailAddrs() As CkStringArray

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.

GetSizeByUidl(uidl As String) As Long

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

GetSmtpSslServerCert() As ChilkatCert

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

GetUidls() As CkStringArray

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

Returns 1 for success, 0 for failure.

IsSmtpDsnCapable() As Long

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.

IsUnlocked() As Long

Returns 1 if the mailman is already unlocked, otherwise returns 0.

LoadEml(emlFilename As String) As ChilkatEmail2

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.

MHT = EML

LoadMbx(mbxFileName As String) As ChilkatEmailBundle2

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

LoadMime(mimeText As String) As ChilkatEmail2

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

LoadXmlEmail(filename As String) As ChilkatEmail2

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

LoadXmlEmailString(xmlString As String) As ChilkatEmail2

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

LoadXmlFile(filename As String) As ChilkatEmailBundle2

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.

LoadXmlString(xmlString As String) As ChilkatEmailBundle2

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

MxLookup(emailAddress As String) As String

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

Returns 1 for success, 0 for failure.

(ASP) MX Lookup Example

(VB6) MX Lookup Example

(Delphi) MX Lookup Example

(FoxPro) MX Lookup Example

(PHP using ActiveX) MX Lookup Example

(VBScript) MX Lookup Example

MxLookupAll(emailAddress As String) As CkStringArray

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.

OpenSmtpConnection() As Long

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.

Returns 1 for success, 0 for failure.

Minimizing SMTP Connections

Pop3BeginSession() As Long

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.

Returns 1 for success, 0 for failure.

More about POP3 Session Management

Pop3EndSession() As Long

Call to explicitly end a POP3 session. 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 about POP3 Session Management

Pop3EndSessionNoQuit() As Long

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.

Pop3Noop() As Long

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.

Pop3Reset() As Long

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.

Pop3SendRawCommand(command As String, charset As String) As String

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

QuickSend(fromAddr As String, toAddr As String, subject As String, body As String, smtpServer As String) As Long

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.

RenderToMime(email As ChilkatEmail2) As String

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

The rendered MIME string is returned on success.

Returns 1 for success, 0 for failure.

RenderToMimeBytes(email As ChilkatEmail2) As Variant

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

Returns 1 for success, 0 for failure.

SendBundle(bundle As ChilkatEmailBundle2) As Long

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.

SendEmail(email As ChilkatEmail2) As Long

Sends a single email.

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.

Returns 1 for success, 0 for failure.

(ASP) Send Email

(VB6) Send Email

(Delphi) Send Email

(FoxPro) Send Email

(PHP using ActiveX) Send Email

(VBScript) Send Email

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 (so-to-speak)

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

SendMime(fromAddr As String, recipients As String, mimeSource As String) As Long

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 of the email are passed as a string of comma separated email addresses (without friendly names). The fromAddr is the reverse-path email address. This is where bounced email 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).

Returns 1 for success, 0 for failure.

SMTP Protocol in a Nutshell

SendMimeBytes(fromAddr As String, recipients As String, mimeSource As Variant) As Long

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

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

Returns 1 for success, 0 for failure.

SMTP Protocol in a Nutshell

SendMimeBytesQ(from As String, recipients As String, mimeData As Variant) As Long

This method is the samem as SendMimeQ, except the MIME is passed in a byte array argument instead of a string argument.

Returns 1 for success, 0 for failure.

SMTPQ Windows Service Download

SMTPQ Documentation

SMTPQ Catgegory on Chilkat Blog

SendMimeQ(fromAddr As String, recipients As String, mimeSource As String) As Long

Same as SendMime, except the email is written to the Chilkat SMTPQ's queue directory for background sending from the SMTPQ service.

Returns 1 for success, 0 for failure.

SMTPQ Windows Service Download

SMTPQ Documentation

SMTPQ Catgegory on Chilkat Blog

SendMimeToList(fromAddr As String, distListFilename As String, mimeSource As String) As Long

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.

SendQ(email As ChilkatEmail2) As Long

Queues an email to be sent using the Chilkat SMTP queue service. This is the same as SendEmail, except the email is written to the SMTPQ's queue directory.

The email is written as a .eml to the SMTPQ's queue directory. The SMTP server hostname, login, password, and send-time parameters are saved as encrypted headers in the .eml. The SMTPQ service watches the queue directory. When a .eml file appears, it loads the .eml, extracts and removes the encrypted information from the header, and sends the email.

Note: When the Chilkat SMTPQ service is configured, the location of the queue directory is written to the registry. Because Chilkat SMTPQ is a 32-bit service, it is the 32-bit registry that is written. (Microsoft 64-bit systems have two separate registries -- one for 32-bit and one for 64-bit.) Therefore, if your application is a 64-bit app, the registry lookup for the queue directory will fail. You should instead call the SendQ2 method which allows for the queue directory to be explicitly specified.

Returns 1 for success, 0 for failure.

SMTPQ Windows Service Download

SMTPQ Documentation

SMTPQ Catgegory on Chilkat Blog

SendQ2(email As ChilkatEmail2, queueDir As String) As Long

Same as SendQ, but the queue directory can be explicitly specified in a method argument.

Returns 1 for success, 0 for failure.

SMTPQ Windows Service Download

SMTPQ Documentation

SMTPQ Catgegory on Chilkat Blog

SendToDistributionList(emailObj As ChilkatEmail2, recipientList As CkStringArray) As Long

Send the same email to a list of email addresses.

Returns 1 for success, 0 for failure.

(ASP) Send Identical Email to Distribution List

(VB6) Send Identical Email to Distribution List

(Delphi) Send Identical Email to Distribution List

(FoxPro) Send Identical Email to Distribution List

(PHP using ActiveX) Send Identical Email to Distribution List

(VBScript) Send Identical Email to Distribution List

SetCSP(csp As ChilkatCsp) As Long

(Only applies to the Microsoft Windows OS) Sets the Cryptographic Service Provider (CSP) to be used for encryption or digital signing, or decryption / signature verification.

This is not commonly used becaues the default Microsoft CSP is typically appropriate. One instance where SetCSP is necessary is when using the Crypto-Pro CSP for the GOST R 34.10-2001 and GOST R 34.10-94 providers.

Returns 1 for success, 0 for failure.

SetDecryptCert2(cert As ChilkatCert, privateKey As PrivateKey) As Long

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.

SetSslClientCert(cert As ChilkatCert) As Long

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(pemDataOrFilename As String, pemPassword As String) As Long

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

Returns 1 for success, 0 for failure.

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

SetSslClientCertPfx(pfxFilename As String, pfxPassword As String) As Long

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

Returns 1 for success, 0 for failure.

SmtpNoop() As Long

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.

SmtpReset() As Long

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.

SmtpSendRawCommand(command As String, charset As String, bEncodeBase64 As Long) As String

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

SshAuthenticatePk(bSmtp As Long, sshUsername As String, sshPrivateKey As ChilkatSshKey) As Long

Authenticates with the SSH server using public-key authentication. bSmtp should be set to 1 for SMTP SSH tunneling (port forwarding) or 0 for POP3 SSH tunneling (port forwarding). The corresponding public key must have been installed on the SSH server for the sshUsername. Authentication will succeed if the matching sshPrivateKey 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.

SshAuthenticatePw(bSmtp As Long, sshLogin As String, sshPassword As String) As Long

Authenticates with the SSH server using a sshLogin and sshPassword. bSmtp should be set to 1 for SMTP SSH tunneling (port forwarding) or 0 for POP3 SSH tunneling (port forwarding).

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.

SshCloseTunnel(bSmtp As Long) As Long

Closes the SSH tunnel for SMTP or POP3. bSmtp should be set to 1 for SMTP and 0 for POP3.

Returns 1 for success, 0 for failure.

SshTunnel(bSmtp As Long, sshServerHostname As String, sshPort As Long) As Long

Connects to an SSH server and creates a tunnel for SMTP or POP3. If bSmtp is 1, then an SSH tunnel is created for SMTP. If bSmtp is 0, the SSH tunnel is created for POP3. The sshServerHostname 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 AuthenticatePw or AuthenticatePk to authenticate.

Note: Once the SSH tunnel is setup by calling SshTunnel 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.

Note: Tunnels are setup separately for POP3 and SMTP. The bSmtp indicates whether the tunnel is for SMTP or POP3.

Important: When reporting problems, please send the full contents of the LastErrorText property to support@chilkatsoft.com.

Returns 1 for success, 0 for failure.

TransferMail() As ChilkatEmailBundle2

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

TransferMultipleMime(uidlArray As CkStringArray) As CkStringArray

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

UnlockComponent(code As String) As Long

Unlocks the component. This must be called once at the beginning of your program (or ASP / ASP.NET page). It is very fast and has negligible overhead. An arbitrary string, such as "Hello World" may be passed to automatically begin a fully-functional 30-day trial.

A valid permanent unlock code for this object will always included the substring "MAIL".

Returns 1 for success, 0 for failure.

Diagnosing UnlockComponent Problems

UnlockComponent LastErrorText shows exact string passed to it.

Verify UnlockComponent Success w/ Permanent Unlock Code

LastErrorText Standard Information

VerifyPopConnection() As Long

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

VerifyPopLogin() As Long

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

VerifySmtpConnection() As Long

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

VerifySmtpLogin() As Long

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

Events

AbortCheck(abort As Long)

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

EmailReceived(subject As String, fromAddr As String, fromName As String, returnPath As String, date As String, uidl As String, sizeInBytes As Long)

To be documented soon...

PercentDone(pctDone As Long, abort As Long)

Provides the percentage completed for any method that involves network communications or time-consuming processing. This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100). The abort output argument provides a means for aborting the operation. Setting it to 1 will cause the method to abort and return a failed status (or whatever return value indicates failure).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

ProgressInfo(name As String, value As String)

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.