CkMailMan C++ Class Reference (Visual C++)
CkMailMan
The Chilkat MailMan class is reponsible for sending email though SMTP and receiving/managing email on POP3 servers.
Properties
bool get_AllOrNone(void);
void put_AllOrNone(bool newVal);
Prevents sending any email if any of the addresses in the recipient list are rejected by the SMTP server. The default value is false, 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.
bool get_AutoGenMessageId(void);
void put_AutoGenMessageId(bool newVal);
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 (true), 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 false.
bool get_AutoSaveCerts(void);
void put_AutoSaveCerts(bool newVal);
Controls whether certificates found in incoming signed emails are automatically saved to the "Chilkat" certificate store. The default is false. The Chilkat cert store is located in the registry in HKEY_LOCAL_MACHINE/Software/Chilkat/SystemCertificates.
bool get_AutoUnwrapSecurity(void);
void put_AutoUnwrapSecurity(bool newVal);
When an email is downloaded from a POP3 server or loaded from a .eml file, it is automatically "unwrapped" if the email is signed and/or encrypted. The results of the digital signature verification and decryption can be accessed with the following email object properties and methods: EncryptedBy, SignedBy, ReceivedEncrypted, ReceivedSigned, GetEncryptedByCert, and GetSignedByCert.
To auto-unwrap, set this property equal to true (the default). Otherwise set it to false.
void get_ClientIpAddress(CkString &str);
void put_ClientIpAddress(const char *newVal);
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.
long get_ConnectTimeout(void);
void put_ConnectTimeout(long numSeconds);
The time (in seconds) to wait before while trying to connect to a mail server (POP3 or SMTP). The default value is 30.
void get_DsnEnvid(CkString &str);
void put_DsnEnvid(const char *str);
(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.
void get_DsnNotify(CkString &str);
void put_DsnNotify(const char *str);
(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".
void get_DsnRet(CkString &str);
void put_DsnRet(const char *str);
(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.
bool get_EmbedCertChain(void);
void put_EmbedCertChain(bool newVal);
If true, 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 true, then the root CA certificate is also included in the S/MIME signature.
void get_Filter(CkString &str);
void put_Filter(const char *str);
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)
long get_HeartbeatMs(void);
void put_HeartbeatMs(long millisec);
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.
void get_HeloHostname(CkString &str);
void put_HeloHostname(const char *str);
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.
bool get_ImmediateDelete(void);
void put_ImmediateDelete(bool newVal);
If true (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 true, 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 false, it must make sure to call Pop3EndSession to ensure that messages marked for deletion are actually deleted. POP3 Session Management
bool get_IncludeRootCert(void);
void put_IncludeRootCert(bool newVal);
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 true.
void LastErrorHtml(CkString &str);
Retrieves the last-error information in HTML format. When a Chilkat method returns a failure status, the last-error information is saved and can be retrieved until the next method is called on the same object instance.Error information in HTML format for the last method called.
void LastErrorText(CkString &str);
Retrieves the last-error information in plain-text format. When a Chilkat method returns a failure status, the last-error information is saved and can be retrieved until the next method is called on the same object instance.Error information in plain-text format for the last method called.
void LastErrorXml(CkString &str);
Retrieves the last-error information in XML format. When a Chilkat method returns a failure status, the last-error information is saved and can be retrieved until the next method is called on the same object instance.Error information in XML format for the last method called.
void get_LastSendQFilename(CkString &str);
The name of the file created in the SMTPQ's queue directory for the last email sent via SendQ, SendQ2, or SendMimeQ.
long get_LastSmtpStatus(void);
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.
void get_LogMailReceivedFilename(CkString &str);
void put_LogMailReceivedFilename(const char *str);
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.
void get_LogMailSentFilename(CkString &str);
void put_LogMailSentFilename(const char *str);
A log filename where the MailMan will log the exact message sent to the SMTP server. This property is helpful in debugging.
void get_MailHost(CkString &str);
void put_MailHost(const char *str);
The hostname of the POP3 server. Do not include "http://" in the hostname. The hostname may also be an IP address string, such as "168.144.70.227".
long get_MailPort(void);
void put_MailPort(long newVal);
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.
long get_MaxCount(void);
void put_MaxCount(long newVal);
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.
bool get_OpaqueSigning(void);
void put_OpaqueSigning(bool newVal);
When set to true, signed emails are sent using opaque signing. The default is to send clear-text (multipart/signed) emails.
bool get_Pop3SPA(void);
void put_Pop3SPA(bool newVal);
Controls whether SPA authentication for POP3 is used or not. To use SPA authentication, set this propoerty = true. No other programming changes are required. The default value is false.
int get_Pop3SessionId(void);
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.
void get_Pop3SessionLog(CkString &log);
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.
bool get_Pop3SslServerCertVerified(void);
When connecting via SSL, this property is true if the POP3 server's SSL certificate was verified. Otherwise it is set to false.
void get_PopPassword(CkString &str);
void put_PopPassword(const char *str);
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.
void put_PopPasswordBase64(const char *strBase64);
Provides a way to specify the POP3 password from a Base64-encoded string.
bool get_PopSsl(void);
void put_PopSsl(bool newVal);
Controls whether SSL is used when reading email from a POP3 server. Note: Check first to determine if your POP3 server can accept SSL connections. Also, be sure to set the MailPort property to the SSL POP3 port number, which is typically 995. Set to true for SSL, false for unencrypted TCP/IP connection.
void get_PopUsername(CkString &str);
void put_PopUsername(const char *str);
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.
long get_ReadTimeout(void);
void put_ReadTimeout(long numSeconds);
The maximum time to wait, in seconds, if the POP3 or SMTP server stops responding. The default value is 30 seconds.
bool get_ResetDateOnLoad(void);
void put_ResetDateOnLoad(bool newVal);
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 false (to not reset the date). To automatically reset the date, set this property equal to true.
int get_SendBufferSize(void);
void put_SendBufferSize(int newVal);
The buffer size to be used with the underlying TCP/IP socket for sending. The default value is 32767.
bool get_SendIndividual(void);
void put_SendIndividual(bool newVal);
Determines how emails are sent to distribution lists. If true, 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 false, 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 true.
long get_SizeLimit(void);
void put_SizeLimit(long newVal);
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.
void get_SmtpAuthMethod(CkString &str);
void put_SmtpAuthMethod(const char *str);
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".
void get_SmtpHost(CkString &str);
void put_SmtpHost(const char *str);
The hostname of the SMTP server. Do not include "http://" in the hostname. The hostname may also be set to an IP address string, such as "168.144.70.227". Sending Email without an SMTP Server
void get_SmtpLoginDomain(CkString &str);
void put_SmtpLoginDomain(const char *str);
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.
void get_SmtpPassword(CkString &str);
void put_SmtpPassword(const char *str);
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.
long get_SmtpPort(void);
void put_SmtpPort(long newVal);
The port number of the SMTP server used to send email. Only needs to be set if the SMTP server is running on a non-standard port. The default value is 25. If SmtpSsl is set to true, this property should be set to 465. (TCP port 465 is reserved by common industry practice for secure SMTP communication using the SSL protocol.)
void get_SmtpSessionLog(CkString &log);
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.
bool get_SmtpSsl(void);
void put_SmtpSsl(bool newVal);
When set to True, causes the mailman to connect to the SMTP server via the SSL protocol. GMail SMTP port 465 (SSL)
bool get_SmtpSslServerCertVerified(void);
If using SSL, this property will be set to true if the SMTP server's SSL certificate was verified when establishing the connection. Otherwise it is set to false.
void get_SmtpUsername(CkString &str);
void put_SmtpUsername(const char *str);
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
bool get_StartTLS(void);
void put_StartTLS(bool newVal);
When set to true, causes the mailman to issue a STARTTLS command to switch over to a secure SSL/TLS connection prior to authenticating and sending email. The default value is false. GMail SMTP port 587 (STARTTLS)
bool get_Utf8(void) const;
void put_Utf8(bool b);
When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.
void get_Version(CkString &str);
The version of this component, such as "v1.0.0"
Methods
long CheckMail();
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.
void 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.
void ClearPop3SessionLog();
Clears the contents of the Pop3SessionLog property.
void ClearSmtpSessionLog();
Clears the contents of the SmtpSessionLog property.
bool CloseSmtpConnection();
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). Returns true for success, false for failure. Minimizing SMTP Sessions
CkEmailBundle * CopyMail();
Copy the email from a POP3 server into a EmailBundle. This does not remove the email from the POP3 server. Returns a null reference on failure
bool DeleteBundle(const CkEmailBundle * bundle);
Removes all the emails present in the bundle from the POP3 email server. Returns true for success, false for failure.
bool DeleteBundle(const CkEmailBundle & bundle);
Removes all the emails present in the bundle from the POP3 email server. Returns true for success, false for failure.
bool DeleteByMsgnum(int msgnum);
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.
bool DeleteByUidl(const char * uidl);
Removes a single email from the server by UIDL. Returns true for success, false for failure.
bool DeleteEmail(const CkEmail * email);
Removes an email from the POP3 server. The email argument is an email that was previously downloaded from the mail server, either in its entirety, or partially (as with GetAllHeaders or GetHeaders). Returns true for success, false for failure.
bool DeleteEmail(const CkEmail & email);
Removes an email from the POP3 server. The email argument is an email that was previously downloaded from the mail server, either in its entirety, or partially (as with GetAllHeaders or GetHeaders). Returns true for success, false for failure.
bool DeleteMultiple(const CkStringArray * uidlArray);
Removes from the POP3 mail server any email that has a UIDL equal to one of the UIDLs in the StringArray. Returns true for success, false for failure.
bool DeleteMultiple(const CkStringArray & uidlArray);
Removes from the POP3 mail server any email that has a UIDL equal to one of the UIDLs in the StringArray. Returns true for success, false for failure.
CkEmail * FetchByMsgnum(int msgnum);
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 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 a null reference on failure
CkEmail * FetchEmail(const char * uidl);
Fetches an email from the POP3 mail server given its UIDL. The email will remain on the mail 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 a null reference on failure
bool FetchMime(const char * uidl, CkByteData & mimeBytes);
Fetches an email by UIDL and returns the MIME source of the email in a byte array.
bool FetchMimeByMsgnum(int msgnum, CkByteData & outBytes);
To be documented soon...
CkEmailBundle * FetchMultiple(const CkStringArray * uidlArray);
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.
A null reference is returned on failure. Returns a null reference on failure Process Large POP3 Mailbox
CkEmailBundle * FetchMultiple(const CkStringArray & uidlArray);
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.
A null reference is returned on failure. Returns a null reference on failure Process Large POP3 Mailbox
CkEmailBundle * FetchMultipleHeaders(const CkStringArray * uidlArray, long numBodyLines);
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 a null reference on failure
CkEmailBundle * FetchMultipleHeaders(const CkStringArray & uidlArray, long numBodyLines);
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 a null reference on failure
CkStringArray * FetchMultipleMime(const CkStringArray * uidlArray);
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 a null reference on failure
CkStringArray * FetchMultipleMime(const CkStringArray & uidlArray);
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 a null reference on failure
CkEmail * FetchSingleHeader(long numBodyLines, long messageNumber);
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 a null reference on failure
CkEmail * FetchSingleHeaderByUidl(long numBodyLines, const char * uidl);
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 ARG2 lines of either the plain-text or HTML body will be present). Returns a null reference on failure
CkEmailBundle * GetAllHeaders(long numBodyLines);
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.
A null reference is returned on failure. Returns a null reference on failure
CkStringArray * GetBadEmailAddresses();
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 a null reference on failure
CkEmail * GetFullEmail(const CkEmail * email);
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 a null reference on failure
CkEmail * GetFullEmail(const CkEmail & email);
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 a null reference on failure
CkEmailBundle * GetHeaders(long numBodyLines, long fromIndex, long toIndex);
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 a null reference on failure. Returns a null reference on failure
int GetMailboxCount();
Returns the number of emails on the POP3 server, or -1 for failure.
This method is identical to CheckEmail. It was added for clarity.
bool GetMailboxInfoXml(CkString & xml);
Returns an XML document with information about the emails in a POP3 mailbox. The XML contains the UIDL and size (in bytes) of each email in the mailbox. Returns true for success, false for failure. Example: Get POP3 Mailbox XML Summary
unsigned long GetMailboxSize();
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.
CkCert * GetPop3SslServerCert();
Returns the POP3 server's SSL certificate. This is available after connecting via SSL to a POP3 server. (To use POP3 SSL, set the PopSsl property = true.)
Returns a null reference if no POP3 SSL certificate is available.
int GetSizeByUidl(const char * uidl);
To be documented soon...
CkCert * GetSmtpSslServerCert();
To be documented soon...
CkStringArray * GetUidls();
Returns the UIDLs of the emails currently stored on the POP3 server. Returns a null reference on failure
bool IsSmtpDsnCapable();
Contacts the SMTP server and determines if it supports the DSN (Delivery Status Notification) features specified by RFC 3461 and supported by the DsnEnvid, DsnNotify, and DsnRet properties. Returns true if the SMTP server supports DSN, otherwise returns false.
bool IsUnlocked();
Returns true if the mailman is already unlocked, otherwise returns false.
CkEmail * LoadEml(const char * emlFilename);
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 a null reference on failure MHT = EML
CkEmailBundle * LoadMbx(const char * mbxFileName);
Loads a .mbx file containing emails and returns an email bundle. If a Filter is present, only emails matching the filter are returned.
A null reference is returned on failure. Returns a null reference on failure
CkEmail * LoadMime(const char * mimeText);
Creates and loads an email from a MIME string. Returns a null reference on failure. Returns a null reference on failure
CkEmail * LoadXmlEmail(const char * folderPath);
Loads an XML file containing a single email and returns an email object. Returns a null reference on failure. Returns a null reference on failure
CkEmail * LoadXmlEmailString(const char * xmlString);
Loads an XML string containing a single email and returns an email object. Returns a null reference on failure. Returns a null reference on failure
CkEmailBundle * LoadXmlFile(const char * folderPath);
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 a null reference on failure
CkEmailBundle * LoadXmlString(const char * xmlString);
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 a null reference on failure
bool MxLookup(const char * emailAddr, CkString & strHostname);
Performs a DNS MX lookup to return the mail server hostname based on an email address. Returns true for success, false for failure. MX Lookup Example
CkStringArray * MxLookupAll(const char * emailAddress);
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 a null reference on failure
bool OpenSmtpConnection();
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 true for success, false for failure. Minimizing SMTP Connections
bool Pop3BeginSession();
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 true for success, false for failure. More about POP3 Session Management
bool Pop3EndSession();
Call to explicitly end a POP3 session. If the ImmediateDelete property is set to false, and emails marked for deletion will be deleted at this time. Returns true for success, false for failure. More about POP3 Session Management
bool Pop3Noop();
Sends a NOOP command to the POP3 server. This may be a useful method to call periodically to keep a connection open, or to verify that the POP3 connection (session) is open and functioning. Returns true for success, false for failure.
bool Pop3Reset();
Sends a RSET command to the POP3 server. If any messages have been marked as deleted by the POP3
server, they are unmarked. Calling Pop3Reset resets the POP3 session to a valid, known starting point. Returns true for success, false for failure.
bool QuickSend(const char * from, const char * to, const char * subject, const char * body, const char * smtpServer);
A quick way to send an email to a single recipient without having to explicitly create an email object. Returns true for success, false for failure.
bool RenderToMime(const CkEmail * email, CkString & str);
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 true for success, false for failure.
bool RenderToMime(const CkEmail & email, CkString & str);
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 true for success, false for failure.
bool SaveLastError(const char * filename);
Saves the last error information to an XML formatted file.
bool SendBundle(const CkEmailBundle * bundle);
Sends a bundle of emails. This is identical to calling SendEmail for each email in the bundle.
If an error occurs when sending one of the emails in the bundle, it will continue with each subsequent email until each email in the bundle has been attempted (unless a fatal error occurs, in which case the send is aborted).
Because it is difficult or impossible to programmatically identify which emails in the bundle failed and which succeeded, it is best to write a loop that sends each email separately (via the SendEmail method). Returns true for success, false for failure.
bool SendBundle(const CkEmailBundle & bundle);
Sends a bundle of emails. This is identical to calling SendEmail for each email in the bundle.
If an error occurs when sending one of the emails in the bundle, it will continue with each subsequent email until each email in the bundle has been attempted (unless a fatal error occurs, in which case the send is aborted).
Because it is difficult or impossible to programmatically identify which emails in the bundle failed and which succeeded, it is best to write a loop that sends each email separately (via the SendEmail method). Returns true for success, false for failure.
bool SendEmail(const CkEmail * email);
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 true for success, false for failure. 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
bool SendEmail(const CkEmail & email);
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 true for success, false for failure. 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
bool SendMime(const char * fromAddr, const char * recipients, const char * mimeSource);
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. Returns true for success, false for failure.
bool SendMimeQ(const char * fromAddr, const char * recipients, const char * mimeSource);
Same as SendMime, except the email is written to the Chilkat SMTPQ's queue directory for background sending from the SMTPQ service. Returns true for success, false for failure.
bool SendMimeToList(const char * fromAddr, const char * distListFilename, const char * mimeSource);
Same as SendMime, but the recipient list is read from a text file ( distListFilename) containing one email address per line. Returns true for success, false for failure.
bool SendQ(const CkEmail * email);
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. Returns true for success, false for failure.
bool SendQ(const CkEmail & email);
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. Returns true for success, false for failure.
bool SendQ2(const CkEmail * email, const char * queueDir);
Same as SendQ, but the queue directory can be explicitly specified in a method argument. Returns true for success, false for failure.
bool SendQ2(const CkEmail & email, const char * queueDir);
Same as SendQ, but the queue directory can be explicitly specified in a method argument. Returns true for success, false for failure.
bool SendToDistributionList(CkEmail & emailObj, CkStringArray & recipientList);
Send the same email to a list of email addresses. Send Identical Email to Distribution List
bool SetDecryptCert2(const CkCert & cert, CkPrivateKey & key);
To be documented soon.
void SetProgressCallback(CkMailProgress * cb);
Used to specify a callback object for progress monitoring of email sending and receiving.
void SetSslClientCert(CkCert & cert);
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.
bool SmtpNoop();
Sends a no-op to the SMTP server. Calling this method is good for testing to see if the connection to the SMTP server is working and valid. The SmtpNoop method will automatically establish the SMTP connection if it does not already exist. Returns true for success, false for failure.
bool SmtpReset();
Sends an RSET command to the SMTP server. This method is rarely needed. The RSET command resets the state of the connection to the SMTP server to the initial state (so that the component can proceed with sending a new email). The SmtpReset method would only be needed if a mail-sending method failed and left the connection with the SMTP server open and in a non-initial state. (A situation that is probably not even possible with the Chilkat mail component.) Returns true for success, false for failure.
bool SshAuthenticatePk(bool bSmtp, const char * sshUsername, CkSshKey & sshPrivateKey);
Authenticates with the SSH server using public-key authentication. bSmtp should be set to true for SMTP SSH tunneling (port forwarding) or false 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 true for success, false for failure.
bool SshAuthenticatePw(bool bSmtp, const char * sshLogin, const char * sshPassword);
Authenticates with the SSH server using a sshLogin and sshPassword. bSmtp should be set to true for SMTP SSH tunneling (port forwarding) or false 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 true for success, false for failure.
bool SshCloseTunnel(bool bSmtp);
Closes the SSH tunnel for SMTP or POP3. bSmtp should be set to true for SMTP and false for POP3. Returns true for success, false for failure.
bool SshTunnel(bool bSmtp, const char * sshServerHostname, int sshPort);
Connects to an SSH server and creates a tunnel for SMTP or POP3. If bSmtp is true, then an SSH tunnel is created for SMTP. If bSmtp is false, 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 true for success, false for failure.
CkEmailBundle * TransferMail();
Downloads and removes all email from a POP3 server. A bundle containing the emails is returned. A null reference is returned on failure. Returns a null reference on failure
CkStringArray * TransferMultipleMime(const CkStringArray * uidlArray);
Same as FetchMultipleMime except that the downloaded emails are also deleted from the server. Returns a null reference on failure. Returns a null reference on failure
CkStringArray * TransferMultipleMime(const CkStringArray & uidlArray);
Same as FetchMultipleMime except that the downloaded emails are also deleted from the server. Returns a null reference on failure. Returns a null reference on failure
bool UnlockComponent(const char * code);
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. Returns true for success, false for failure.
bool VerifyPopConnection();
Return true if a TCP/IP connection can be established with the POP3 server, otherwise returns false.
bool VerifyPopLogin();
Return true if a TCP/IP connection and login is successful with the POP3 server. Otherwise return false.
bool VerifyRecipients(const CkEmail & email, CkStringArray & saBadAddrs);
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. Returns true for success, false for failure.
bool VerifySmtpConnection();
Return true if a TCP/IP connection can be established with the SMTP server, otherwise returns false.
bool VerifySmtpLogin();
Return true if a TCP/IP connection and login is successful with the SMTP server. Otherwise returns false.
const char * clientIpAddress();
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.
const char * dsnEnvid();
(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.
const char * dsnNotify();
(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".
const char * dsnRet();
(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.
const char * filter();
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)
const char * getMailboxInfoXml();
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. Example: Get POP3 Mailbox XML Summary
const char * heloHostname();
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.
const char * lastErrorHtml();
Error information in HTML format for the last method called.
const char * lastErrorText();
Error information in plain-text format for the last method called.
const char * lastErrorXml();
Error information in XML format for the last method called.
const char * lastSendQFilename();
The name of the file created in the SMTPQ's queue directory for the last email sent via SendQ, SendQ2, or SendMimeQ.
const char * logMailReceivedFilename();
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.
const char * logMailSentFilename();
A log filename where the MailMan will log the exact message sent to the SMTP server. This property is helpful in debugging.
const char * mailHost();
The hostname of the POP3 server. Do not include "http://" in the hostname. The hostname may also be an IP address string, such as "168.144.70.227".
const char * mxLookup(const char * emailAddr);
Performs a DNS MX lookup to return the mail server hostname based on an email address. MX Lookup Example
const char * pop3SessionLog();
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.
const char * popPassword();
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.
const char * popUsername();
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.
const char * renderToMime(const CkEmail & email);
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.
const char * smtpAuthMethod();
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".
const char * smtpHost();
The hostname of the SMTP server. Do not include "http://" in the hostname. The hostname may also be set to an IP address string, such as "168.144.70.227". Sending Email without an SMTP Server
const char * smtpLoginDomain();
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.
const char * smtpPassword();
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.
const char * smtpSessionLog();
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.
const char * smtpUsername();
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
const char * version();
The version of this component, such as "v1.0.0"
|