TChilkatMailMan2 Delphi Reference
TChilkatMailMan2
The Chilkat MailMan class is reponsible for sending email though SMTP and receiving/managing email on POP3 servers.
Object Creation
var
obj: TChilkatMailMan2;
...
begin
obj := TChilkatMailMan2.Create(Self);
...
// When finished, free the object instance.
obj.Free();
Properties
property AllOrNone: Integer
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.
property AutoFix: Integer
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.
property AutoGenMessageId: Integer
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.
property ClientIpAddress: WideString
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
property ConnectTimeout: Integer
The time (in seconds) to wait before while trying to connect to a mail server (POP3 or SMTP). The default value is 30.
property DebugLogFilePath: WideString
Used for debugging in cases where a Chilkat method call hangs and never returns. This should generally never happen. The only causes for this 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.
This property allows one to specifiy a debug file path that will be created (or appended if it already exists) and information will be logged to it as the Chilkat methods are called. If a hang occurs, the log file may be viewed to get information about what happened.
property DsnEnvid: WideString
(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.
property DsnNotify: WideString
(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".
property DsnRet: WideString
(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.
property EmbedCertChain: Integer
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.
property Filter: WideString
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)
property HeartbeatMs: Integer
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.
property HeloHostname: WideString
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.
property HttpProxyAuthMethod: WideString
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".
property HttpProxyHostname: WideString
If an HTTP proxy is to be used, set this property to the HTTP proxy hostname or IPv4 address (in dotted decimal notation).
property HttpProxyPassword: WideString
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy password.
property HttpProxyPort: Integer
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.)
property HttpProxyUsername: WideString
If an HTTP proxy requiring authentication is to be used, set this property to the HTTP proxy login name.
property ImmediateDelete: Integer
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
property IncludeRootCert: Integer
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.
property IsSmtpConnected: Integer readonly
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.
property LastErrorHtml: WideString readonly
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.
property LastErrorText: WideString readonly
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.
property LastErrorXml: WideString readonly
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.
property LastSendQFilename: WideString readonly
The name of the file created in the SMTPQ's queue directory for the last email sent via SendQ, SendQ2, or SendMimeQ.
property LastSmtpStatus: Integer readonly
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.
property LogMailReceivedFilename: WideString
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.
property LogMailSentFilename: WideString
A log filename where the MailMan will log the exact message sent to the SMTP server. This property is helpful in debugging.
property MailHost: WideString
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.
property MailPort: Integer
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.)
property MaxCount: Integer
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.
property OpaqueSigning: Integer
When set to 1, signed emails are sent using opaque signing. The default is to send clear-text (multipart/signed) emails.
property Pop3SPA: Integer
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.
property Pop3SessionId: Integer readonly
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.
property Pop3SessionLog: WideString readonly
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.
property Pop3SslServerCertVerified: Integer readonly
When connecting via SSL, this property is 1 if the POP3 server's SSL certificate was verified. Otherwise it is set to 0.
property Pop3Stls: Integer
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.)
property PopPassword: WideString
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.
property PopSsl: Integer
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.
property PopUsername: WideString
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.
property ReadTimeout: Integer
The maximum time to wait, in seconds, if the POP3 or SMTP server stops responding. The default value is 30 seconds.
property RequireSslCertVerify: Integer
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.)
property ResetDateOnLoad: Integer
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.
property SendBufferSize: Integer
The buffer size to be used with the underlying TCP/IP socket for sending. The default value is 32767.
property SendIndividual: Integer
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.
property SizeLimit: Integer
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.
property SmtpAuthMethod: WideString
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".
property SmtpHost: WideString
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
property SmtpLoginDomain: WideString
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.
property SmtpPassword: WideString
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.
property SmtpPort: Integer
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.)
property SmtpSessionLog: WideString readonly
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.
property SmtpSsl: Integer
When set to 1, causes the mailman to connect to the SMTP server via the TLS/SSL protocol.
property SmtpSslServerCertVerified: Integer readonly
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.
property SmtpUsername: WideString
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
property SocksHostname: WideString
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).
property SocksPassword: WideString
The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.
property SocksPort: Integer
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).
property SocksUsername: WideString
The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).
property SocksVersion: Integer
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.
property StartTLS: Integer
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.
property UseApop: Integer
If 1, will automatically use APOP authentication if the POP3 server supports it. The default value of this property is 0.
property VerboseLogging: Integer
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0.
property Version: WideString readonly
The version of this component, such as "v1.0.0"
Methods
function AddPfxSourceData(pfxData: OleVariant, password: WideString): Integer;
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 ARG1 contains the bytes of a PFX file (also known as PKCS12 or .p12). Returns 1 for success, 0 for failure.
function AddPfxSourceFile(pfxFilePath: WideString, password: WideString): Integer;
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 ARG1 contains the bytes of a PFX file (also known as PKCS12 or .p12). Returns 1 for success, 0 for failure.
function CheckMail(): Integer;
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.
procedure 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.
procedure ClearPop3SessionLog();
Clears the contents of the Pop3SessionLog property.
procedure ClearSmtpSessionLog();
Clears the contents of the SmtpSessionLog property.
function CloseSmtpConnection(): Integer;
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
function CopyMail(): TChilkatEmailBundle2;
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
function DeleteBundle(bundle: TChilkatEmailBundle2): Integer;
Removes all the emails present in the bundle from the POP3 email server. Returns 1 for success, 0 for failure.
function DeleteByMsgnum(msgnum: Integer): Integer;
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.
function DeleteByUidl(uidl: WideString): Integer;
Removes a single email from the server by UIDL. Returns 1 for success, 0 for failure.
function DeleteEmail(email: TChilkatEmail2): Integer;
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 1 for success, 0 for failure.
function DeleteMultiple(uidlArray: TCkStringArray): Integer;
Removes from the POP3 mail server any email that has a UIDL equal to one of the UIDLs in the StringArray. Returns 1 for success, 0 for failure. Using GMail? You'll need to read this information.
function FetchByMsgnum(msgnum: Integer): TChilkatEmail2;
Fetches an email by message number. WARNING: Be very careful if calling this method. Message numbers are specific to a POP3 session. If a maildrop has (for example) 10 messages, the message numbers will be 1, 2, 3, ... 10. If message number 1 is deleted and a new POP3 session is established, there will be 9 messages numbered 1, 2, 3, ... 9.
IMPORTANT: A POP3 connection must first be established by either calling Pop3BeginSession explicitly, or implicitly by calling some other method that automatically establishes the session. This method will not automatically establish a new POP3 session (because if it did, the message numbers would potentially be different than what the application expects). Returns a null reference on failure
function FetchEmail(uidl: WideString): TChilkatEmail2;
Fetches an email from the POP3 mail server given its UIDL. Calling this method does not remove the email from the server. A typical program might get the email headers from the POP3 server by calling GetAllHeaders or GetHeaders, and then fetch individual emails by UIDL.
Returns a null reference on failure. Returns a null reference on failure
function FetchMime(uidl: WideString): OleVariant;
Fetches an email by UIDL and returns the MIME source of the email in a byte array. Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.
function FetchMimeByMsgnum(msgnum: Integer): OleVariant;
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 a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.
function FetchMultiple(uidlArray: TCkStringArray): TChilkatEmailBundle2;
Given an array of UIDL strings, fetchs all the emails from the POP3 server whose UIDL is present in the array, and returns the emails in a bundle. Returns a null reference on failure
function FetchMultipleHeaders(uidlArray: TCkStringArray, numBodyLines: Integer): TChilkatEmailBundle2;
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
function FetchMultipleMime(uidlArray: TCkStringArray): TCkStringArray;
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
function FetchSingleHeader(numBodyLines: Integer, messageNumber: Integer): TChilkatEmail2;
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
function FetchSingleHeaderByUidl(numBodyLines: Integer, uidl: WideString): TChilkatEmail2;
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
function GetAllHeaders(numBodyLines: Integer): TChilkatEmailBundle2;
Returns all the emails from the POP3 server, but only the first numBodyLines lines of the body. Attachments are not returned. The emails returned in the bundle are valid email objects, the only difference is that the body is truncated to include only the top numBodyLines lines, and the attachments will be missing. Returns a null reference on failure
procedure GetBadEmailAddresses(strArray: TCkStringArray);
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.
function GetFullEmail(email: TChilkatEmail2): TChilkatEmail2;
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
function GetHeaders(numBodyLines: Integer, fromIndex: Integer, toIndex: Integer): TChilkatEmailBundle2;
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
function GetMailboxCount(): Integer;
Returns the number of emails on the POP3 server, or -1 for failure.
This method is identical to CheckEmail. It was added for clarity.
function GetMailboxInfoXml(): WideString;
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 a zero-length WideString on failure
function GetMailboxSize(): Integer;
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.
function GetPop3SslServerCert(): TChilkatCert;
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.
function GetSizeByUidl(uidl: WideString): Integer;
Returns the size of an email (including attachments) given the UIDL of the email on the POP3 server. Returns -1 for failure.
function GetSmtpSslServerCert(): TChilkatCert;
If using SSL/TLS, this method returns the SMTP server's digital certificate used with the secure connection.
function GetUidls(): TCkStringArray;
Returns the UIDLs of the emails currently stored on the POP3 server. Returns a null reference on failure
function IsSmtpDsnCapable(): Integer;
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.
function IsUnlocked(): Integer;
Returns 1 if the mailman is already unlocked, otherwise returns 0.
function LoadEml(emlFilename: WideString): TChilkatEmail2;
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
function LoadMbx(mbxFileName: WideString): TChilkatEmailBundle2;
Loads a .mbx file 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
function LoadMime(mimeText: WideString): TChilkatEmail2;
Creates and loads an email from a MIME string. Returns a null reference on failure. Returns a null reference on failure
function LoadXmlEmail(emailFilename: WideString): TChilkatEmail2;
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
function LoadXmlEmailString(xmlString: WideString): TChilkatEmail2;
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
function LoadXmlFile(folderPath: WideString): TChilkatEmailBundle2;
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
function LoadXmlString(xmlString: WideString): TChilkatEmailBundle2;
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
function MxLookup(emailAddress: WideString): WideString;
Performs a DNS MX lookup to return the mail server hostname based on an email address. Returns a zero-length WideString on failure
function MxLookupAll(emailAddress: WideString): TCkStringArray;
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
function NewBundle(): TChilkatEmailBundle2;
Creates and returns a new email bundle object. Returns a null reference on failure
function NewEmail(): TChilkatEmail2;
Creates and returns a new email object. Returns a null reference on failure
function OpenSmtpConnection(): Integer;
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
function Pop3BeginSession(): Integer;
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
function Pop3EndSession(): Integer;
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
function Pop3EndSessionNoQuit(): Integer;
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.
function Pop3Noop(): Integer;
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.
function Pop3Reset(): Integer;
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.
function Pop3SendRawCommand(command: WideString, charset: WideString): WideString;
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 a zero-length WideString on failure
function QuickSend(from: WideString, to: WideString, subject: WideString, body: WideString, smtpServer: WideString): Integer;
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.
function RenderToMime(email: TChilkatEmail2): WideString;
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 a zero-length WideString on failure
function RenderToMimeBytes(email: TChilkatEmail2): OleVariant;
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 a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.
function SaveLastError(filename: WideString): Integer;
Saves the last error information to an XML formatted file.
function SendBundle(bundle: TChilkatEmailBundle2): Integer;
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.
function SendEmail(email: TChilkatEmail2): Integer;
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. 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
function SendMime(fromAddr: WideString, recipients: WideString, mimeSource: WideString): Integer;
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 1 for success, 0 for failure.
function SendMimeBytes(from: WideString, recipients: WideString, mimeData: OleVariant): Integer;
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. Returns 1 for success, 0 for failure.
function SendMimeBytesQ(from: WideString, recipients: WideString, mimeData: OleVariant): Integer;
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
function SendMimeQ(fromAddr: WideString, recipients: WideString, mimeSource: WideString): Integer;
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
function SendMimeToList(fromAddr: WideString, distListFilename: WideString, mimeSource: WideString): Integer;
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.
function SendQ(email: TChilkatEmail2): Integer;
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
function SendQ2(email: TChilkatEmail2, queueDir: WideString): Integer;
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
function SendToDistributionList(emailObj: TChilkatEmail2, recipientList: TCkStringArray): Integer;
Send the same email to a list of email addresses.
function SetCSP(csp: TChilkatCSP): Integer;
(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.
function SetDecryptCert2(cert: TChilkatCert, privateKey: TPrivateKey): Integer;
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.
procedure SetSslClientCert(iCert: TChilkatCert);
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.
function SetSslClientCertPem(pemDataOrFilename: WideString, pemPassword: WideString): Integer;
Allows for a client-side certificate to be used for the SSL / TLS connection.
function SetSslClientCertPfx(pfxFilename: WideString, pfxPassword: WideString, certSubjectCN: WideString): Integer;
Allows for a client-side certificate to be used for the SSL / TLS connection.
function SmtpNoop(): Integer;
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.
function SmtpReset(): Integer;
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.
function SmtpSendRawCommand(command: WideString, charset: WideString, bEncodeBase64: Integer): WideString;
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 a zero-length WideString on failure
function SshAuthenticatePk(bSmtp: Integer, sshUsername: WideString, sshPrivateKey: TChilkatSshKey): Integer;
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.
function SshAuthenticatePw(bSmtp: Integer, sshLogin: WideString, sshPassword: WideString): Integer;
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.
function SshCloseTunnel(bSmtp: Integer): Integer;
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.
function SshTunnel(bSmtp: Integer, sshServerHostname: WideString, sshPort: Integer): Integer;
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.
function TransferMail(): TChilkatEmailBundle2;
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
function TransferMultipleMime(uidlArray: TCkStringArray): TCkStringArray;
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
function UnlockComponent(code: WideString): Integer;
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 How UnlockComponent Works
function VerifyPopConnection(): Integer;
Return 1 if a TCP/IP connection can be established with the POP3 server, otherwise returns 0.
function VerifyPopLogin(): Integer;
Return 1 if a TCP/IP connection and login is successful with the POP3 server. Otherwise return 0.
function VerifyRecipients(email: TChilkatEmail2): TCkStringArray;
Initiates sending an email, but aborts just after passing all recipients (TO, CC, BCC) to the SMTP server. This allows your program to collect email addresses flagged as invalid by the SMTP server.
Important: Please read this blog post before using this method: http://www.cknotes.com/?p=249 Returns a null reference on failure
function VerifySmtpConnection(): Integer;
Return 1 if a TCP/IP connection can be established with the SMTP server, otherwise returns 0.
function VerifySmtpLogin(): Integer;
Return 1 if a TCP/IP connection and login is successful with the SMTP server. Otherwise returns 0.
|