Email ActiveX Reference Documentation

Email

Represents a complete Email object.

Object Creation

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

Properties

Body As String

The body of the email. If the email has both HTML and plain-text bodies, this property returns the HTML body. The GetHtmlBody and GetPlainTextBody methods can be used to access a specific body. The HasHtmlBody and HasPlainTextBody methods can be used to determine the presence of a body.

BounceAddress As String

The "return-path" address of the email to be used when the email is sent. Bounces (i.e. delivery status notifications, or DSN's) will go to this address.

Note: This is not the content of the "return-path" header for emails that are downloaded from a POP3 or IMAP server. The BounceAddress is the email address to be used in the process of sending the email via SMTP. (See the "SMTP Protocol in a Nutshell" link below.) The BounceAddress is the email address passed in the "MAIL FROM" SMTP command which becomes the "return-path" header in the email when received.

SMTP Protocol in a Nutshell

Charset As String

Sets the charset for the entire email. The header fields and plain-text/HTML bodies will be converted and sent in this charset. (This includes parsing and updating the HTML with the appropriate META tag specifying the charset.) All formatting and encoding of the email MIME is handled automatically by the Chilkat Mail component. If your application wants to send a Shift_JIS email, you simply set the Charset property to "Shift_JIS". Note: If a charset property is not explicitly set, the Chilkat component automatically detects the charset and chooses the appropriate charset. If all characters are 7bit (i.e. us-ascii) the charset is left blank. If the email contain a mix of languages such that no one charset can be chosen, or if the language cannot be determined without ambiguity, then the "utf-8" charset will be chosen.

DebugLogFilePath As String

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

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

Decrypted As Long (read-only)

1 if the email arrived encrypted and was successfully decrypted, otherwise 0.

EmailDate As Date

The date/time from the "Date" header in UTC/GMT standard time. Use the LocalDate property to get the local date and time.

EmailDateStr As String

The date/time from the "Date" header in the UTC/GMT timezone in RFC822 string form.

EncryptedBy As String (read-only)

If the email was received encrypted, this contains the details of the certificate used for encryption.

FileDistList As String

Set this property to send an email to a list of recipients stored in a plain text file. The file format is simple: one recipient per line, no comments allowed, blank lines are ignored.Setting this property is equivalent to adding a "CKX-FileDistList"header field to the email. Chilkat Mail treats header fields beginning with "CKX-"specially in that these fields are never transmitted with the email when sent. However, CKX fields are saved and restored when saving to XML or loading from XML (or MIME). When sending an email containing a "CKX-FileDistList"header field, Chilkat Mail will read the distribution list file and send the email to each recipient. Emails can be sent individually, or with BCC, 100 recipients at a time. (see the MailMan.SendIndividual property).

From As String

The combined name and email address of the sender, such as "John Smith"

FromAddress As String

The email address of the sender.

FromName As String

The name of the sender.

Header As String (read-only)

The complete MIME header of the email.

Language As String (read-only)

A read-only property that identifies the primary language group for the email. Possible values are:

  • "latin1" (for English and all Western European languages)
  • "central" (for Central European languages such as Polish, Czech, Hungarian, etc.)
  • "russian" (for Cyrillic languages)
  • "greek"
  • "turkish"
  • "hebrew"
  • "arabic"
  • "thai"
  • "vietnamese"
  • "chinese"
  • "japanese"
  • "korean"
  • "devanagari"
  • "bengali"
  • "gurmukhi"
  • "gujarati"
  • "oriya"
  • "tamil"
  • "telugu"
  • "kannada"
  • "malayalam"
  • "sinhala"
  • "lao"
  • "tibetan"
  • "myanmar"
  • "georgian"
  • "unknown"
The language group determination is made soley on the subject and plain-text/HTML email bodies. Characters in the FROM, TO, CC, and other header fields are not considered.

The primary determining factor is the characters found in the Subject header field. For example, if an email contains Japanese in the Subject, but the body contains Russian characters, it will be considered "japanese".

The language is determined by where the Unicode chars fall in various blocks in the Unicode Basic Multilingual Plane. For more information, see the book "Unicode Demystified" by Richard Gillam.

LastErrorHtml As String (read-only)

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LastErrorText As String (read-only)

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (read-only)

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

LocalDate As Date

The date/time found in the "Date" header field returned in the local timezone.

LocalDateStr As String

The date/time found in the "Date" header field returned in the local timezone in RFC822 string form.

Mailer As String

Identifies the email software that sent the email.

NumAlternatives As Long (read-only)

The number of alternative bodies present in the email. An email that is not "multipart/alternative"will return 0 alternatives. An email that is "multipart/alternative" will return a number greater than or equal to 1.

NumAttachedMessages As Long (read-only)

Returns the number of embedded emails. Some mail clients will embed an email that is to be forwarded into a new email as a "message/rfc822" subpart of the MIME message structure. This property tells how many emails have been embedded. The original email can be retrieved by calling GetAttachedMessage.

More about Attached Email Messages

NumAttachments As Long (read-only)

The number of attachments contained in the email.

Note: If an email is downloaded from an IMAP server without attachments, then the number of attachments should be obtained by calling the IMAP object's GetMailNumAttach method. This property indicates the actual number of attachments already present within the email object.

Email Attachment Not Found?

POP3 Headers and Attachment Info

Email Attachment Info when Downloading from IMAP without Attachments

NumBcc As Long (read-only)

The number of blind carbon-copy email recipients.

(ASP) Getting TO / CC Email Recipients

(VB6) Getting TO / CC Email Recipients

(Delphi) Getting TO / CC Email Recipients

(FoxPro) Getting TO / CC Email Recipients

(PHP using ActiveX) Getting TO / CC Email Recipients

(VBScript) Getting TO / CC Email Recipients

NumCC As Long (read-only)

The number of carbon-copy email recipients.

(ASP) Getting TO / CC Email Recipients

(VB6) Getting TO / CC Email Recipients

(Delphi) Getting TO / CC Email Recipients

(FoxPro) Getting TO / CC Email Recipients

(PHP using ActiveX) Getting TO / CC Email Recipients

(VBScript) Getting TO / CC Email Recipients

NumDaysOld As Long (read-only)

Returns the number of days old from the current system date/time. The email's date is obtained from the "Date" header field. If the Date header field is missing, or invalid, then -9999 is returned. A negative number may be returned if the Date header field contains a future date/time. (However, -9999 represents an error condition.)

NumHeaderFields As Long (read-only)

The number of header fields.

NumRelatedItems As Long (read-only)

The number of related items present in this email. Related items are typically image files (JPEGs or GIFs) or style sheets (CSS files) that are included with HTML formatted messages with internal "CID"hyperlinks.

NumReplacePatterns As Long (read-only)

Returns the number of replacement patterns previously set by calling the SetReplacePattern method 1 or more times. If replacement patterns are set, the email bodies and header fields are modified by applying the search/replacement strings during the message sending process.

NumReports As Long (read-only)

(For multipart/report emails that have sub-parts with Content-Types such as message/feedback-report.) Any MIME sub-part within the email that has a Content-Type of "message/*", but is not a "message/rfc822", is considered to be a "report" and is included in this count. (A "message/rfc822" is considered an attached message and is handled by the NumAttachedMessages property and the GetAttachedMessage method.) Any MIME sub-part having a Content-Type equal to "text/rfc822-headers" is also considered to be a "report". The GetReport method may be called to get the body content of each "report" contained within a multipart/report email.

NumTo As Long (read-only)

The number of direct email recipients.

(ASP) Getting TO / CC Email Recipients

(VB6) Getting TO / CC Email Recipients

(Delphi) Getting TO / CC Email Recipients

(FoxPro) Getting TO / CC Email Recipients

(PHP using ActiveX) Getting TO / CC Email Recipients

(VBScript) Getting TO / CC Email Recipients

OverwriteExisting As Long

When 1 (the default) the methods to save email attachments and related items will overwrite files if they already exist. If 0, then the methods that save email attachments and related items will append a string of 4 characters to create a unique filename if a file already exists. The filename of the attachment (or related item) within the email object is updated and can be retrieved by the program to determine the actual file(s) created.

Pkcs7CryptAlg As String

When an email is sent encrypted (using PKCS7 public-key encryption), this selects the underlying symmetric encryption algorithm. Possible values are: "aes", "des", "3des", and "rc2".

Pkcs7KeyLength As Long

When the email is sent encrypted (using PKCS7 public-key encryption), this selects the key length of the underlying symmetric encryption algorithm. The possible values allowed depend on the Pkcs7CryptAlg property. For "aes", the key length may be 128, 192, or 256. For "3des" the key length must be 192. For "des" the key length must be 40. For "rc2" the key length can be 40, 56, 64, or 128.

PreferredCharset As String

Only applies when building an email with non-English characters where the charset is not explicitly set. The Chilkat email component will automatically choose a charset based on the languages found within an email (if the charset is not already specified within the MIME or explicitly specified by setting the Charset property). The default charset chosen for each language is:

Chinese: gb2312
Japanese: shift_JIS
Korean: ks_c_5601-1987
Thai: windows-874
All others: iso-8859-*

This allows for charsets such as iso-2022-jp to be chosen instead of the default. If the preferred charset does not apply to the situation, it is not used. For example, if the preferred charset is iso-2022-jp, but the email contains Greek characters, then the preferred charset is ignored.

PrependHeaders As Long

If 1, then header fields added via the AddHeaderField or AddHeaderField2 methods are prepended to the top of the header as opposed to appended to the bottom. The default value is 0.

ReceivedEncrypted As Long (read-only)

1 if this email was originally received with encryption, otherwise 0.

ReceivedSigned As Long (read-only)

1 if this email was originally received with a digital signature, otherwise 0.

ReplyTo As String

The email address to be used when a recipient replies.

ReturnReceipt As Long

Set to 1 if you want the email to request a return-receipt when received by the recipient. The default value is 0.

SendEncrypted As Long

Set to 1 if this email should be sent encrypted.

(ASP) Auto-Select Cert and Send Encrypted Email

(VB6) Auto-Select Cert and Send Encrypted Email

(Delphi) Auto-Select Cert and Send Encrypted Email

(FoxPro) Auto-Select Cert and Send Encrypted Email

(PHP using ActiveX) Auto-Select Cert and Send Encrypted Email

(VBScript) Auto-Select Cert and Send Encrypted Email

(ASP) Using a .cer Certificate File for Encrypted Email

(VB6) Using a .cer Certificate File for Encrypted Email

(Delphi) Using a .cer Certificate File for Encrypted Email

(FoxPro) Using a .cer Certificate File for Encrypted Email

(PHP using ActiveX) Using a .cer Certificate File for Encrypted Email

(VBScript) Using a .cer Certificate File for Encrypted Email

(ASP) Select Cert for Encrypted Email

(VB6) Select Cert for Encrypted Email

(Delphi) Select Cert for Encrypted Email

(FoxPro) Select Cert for Encrypted Email

(VBScript) Select Cert for Encrypted Email

SendSigned As Long

Set to 1 if this email should be sent with a digital signature.

SignaturesValid As Long (read-only)

1 if the email was received with one or more digital signatures, and if all the signatures were validated indicating that the email was not altered. Otherwise this property is set to 0.

SignedBy As String (read-only)

If the email was received digitally signed, this property contains the fields of the cert's SubjectDN.

For example: US, 60187, Illinois, Wheaton, 1719 E Forest Ave, "Chilkat Software, Inc.", "Chilkat Software, Inc."

It is like the DN (Distinguished Name), but without the "AttrName=" before each attribute.

SigningHashAlg As String

Selects the underlying hash algorithm used when sending signed (PKCS7) email. Possible values are "sha1", "sha256", "sha384", "sha512", "md5", and "md2".

Size As Long (read-only)

The size in bytes of the email, including all parts and attachments.

Subject As String

The email subject.

Uidl As String (read-only)

This is the unique ID assigned by the POP3 server. Emails can be retrieved or deleted from the POP3 server via the UIDL. The header field for this property is "X-UIDL".

Important: Emails downloaded via the IMAP protocol do not have UIDL's. UIDL's are specific to the POP3 protocol. IMAP servers use UID's (notice the spelling difference -- "UIDL" vs. "UID"). An email downloaded via the Chilkat IMAP component will contain a "ckx-imap-uid" header field that contains the UID. This may be accessed via the GetHeaderField method.

UnpackUseRelPaths As Long

Applies to the UnpackHtml method. If 1, then relative paths are used within the HTML for the links to the related files (images and style sheets) that were unpacked to the filesystem. Otherwise absolute paths are used. The default value is 1.

VerboseLogging As Long

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

Version As String (read-only)

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

Methods

AddAttachmentHeader(index As Long, fieldName As String, fieldValue As String)

Adds or replaces a MIME header field in one of the email attachments. If the header field does not exist, it is added. Otherwise it is replaced.

AddBcc(friendlyName As String, emailAddress As String) As Long

Adds a recipient to the blind carbon-copy list. address is required, but name may be empty.

Returns 1 for success, 0 for failure.

Why BCC email addresses do not appear in the email header.

AddCC(friendlyName As String, emailAddress As String) As Long

Adds a recipient to the carbon-copy list. address is required, but name may be empty.

Returns 1 for success, 0 for failure.

AddDataAttachment(filePath As String, content As Variant) As Long

Adds an attachment directly from data in memory to the email.

Returns 1 for success, 0 for failure.

AddDataAttachment2(path As String, content As Variant, contentType As String) As Long

Adds an attachment to an email from in-memory data. Same as AddDataAttachment but allows the content-type to be specified.

Returns 1 for success, 0 for failure.

AddEncryptCert(cert As ChilkatCert) As Long

Allows for certificates to be explicitly specified for sending encrypted email to one or more recipients. Call this method once per certificate to be used. The ClearEncryptCerts method may be called to clear the list of explicitly-specified certificates.

Note: It is possible to send encrypted email without explicitly specifying the certificates. The Chilkat email component will automatically search the registry-based Current-User and Local-Machine certificate stores for certs matching each of the recipients (To, CC, and BCC recipients).

Note: The SentEncryptCert method is equivalent to calling ClearEncryptCerts followed by AddEncryptCert.

Returns 1 for success, 0 for failure.

AddFileAttachment(path As String) As String

Adds a file as an attachment to the email. Returns the MIME content-type of the attachment, which is inferred based on the filename extension.

Returns 1 for success, 0 for failure.

AddFileAttachment2(path As String, contentType As String) As Long

Same as AddFileAttachment, but the content type can be explicitly specified.

Returns 1 for success, 0 for failure.

AddHeaderField(fieldName As String, fieldValue As String)

Any standard or non-standard (custom) header field can be added to the email with this method. One interesting feature is that all header fields whose name begins with "CKX-" will not be included in the header when an email is sent. These fields will be included when saved to or loaded from XML. This makes it easy to include persistent meta-data with an email which your programs can use in any way it chooses.

Important: This method will replace an already-existing header field. To allow for adding duplicate header fields, call AddHeaderField2 (see below).

AddHeaderField2(fieldName As String, fieldValue As String)

This method is the same as AddHeaderField, except that if the header field already exists, it is not replaced. A duplicate header will be added.

AddHtmlAlternativeBody(body As String) As Long

Sets the HTML body of the email. Use this method if there will be multiple versions of the body, but in different formats, such as HTML and plain text. Otherwise, set the body by calling the SetHtmlBody method.

Returns 1 for success, 0 for failure.

AddMultipleBcc(commaSeparatedAddresses As String) As Long

Adds multiple recipients to the blind carbon-copy list. The parameter is a string containing a comma separated list of full email addresses. Returns True if successful.

Returns 1 for success, 0 for failure.

Why BCC email addresses do not appear in the email header.

AddMultipleCC(commaSeparatedAddresses As String) As Long

Adds multiple recipients to the carbon-copy list. The parameter is a string containing a comma separated list of full email addresses. Returns True if successful.

Returns 1 for success, 0 for failure.

AddMultipleTo(commaSeparatedAddresses As String) As Long

Adds multiple recipients to the "to" list. The parameter is a string containing a comma separated list of full email addresses. Returns True if successful.

Returns 1 for success, 0 for failure.

AddPfxSourceData(pfxBytes As Variant, pfxPassword As String) As Long

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

Returns 1 for success, 0 for failure.

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

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

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

Returns 1 for success, 0 for failure.

AddPlainTextAlternativeBody(body As String) As Long

Sets the plain-text body of the email. Use this method if there will be multiple versions of the body, but in different formats, such as HTML and plain text. Otherwise, simply set the Body property.

Returns 1 for success, 0 for failure.

AddRelatedData(path As String, inData As Variant) As String

Adds the memory data as a related item to the email and returns the Content-ID. Emails formatted in HTML can include images with this call and internally reference the image through a "cid"hyperlink. (Chilkat Email.NET fully supports the MHTML standard.)

Returns 1 for success, 0 for failure.

AddRelatedData2(inData As Variant, fileNameInHtml As String)

Adds a related item to the email from in-memory byte data. Related items are things such as images and style sheets that are embedded within an HTML email. They are not considered attachments because their sole purpose is to participate in the display of the HTML. This method differs from AddRelatedData in that it does not use or return a Content-ID. The filename argument should be set to the filename used in the HTML img tag's src attribute (if it's an image), or the URL referenced in an HTML link tag for a stylesheet.

AddRelatedFile(path As String) As String

Adds the contents of a file to the email and returns the Content-ID. Emails formatted in HTML can include images with this call and internally reference the image through a "cid" hyperlink. (Chilkat Email.NET fully supports the MHTML standard.)

Returns 1 for success, 0 for failure.

AddRelatedFile2(filenameOnDisk As String, filenameInHtml As String) As Long

Adds a related item to the email from a file. Related items are things such as images and style sheets that are embedded within an HTML email. They are not considered attachments because their sole purpose is to participate in the display of the HTML. This method differs from AddRelatedFile in that it does not use or return a Content-ID. The filenameInHtml argument should be set to the filename used in the HTML img tag's src attribute (if it's an image), or the URL referenced in an HTML link tag for a stylesheet.

Returns 1 for success, 0 for failure.

AddRelatedHeader(index As Long, fieldName As String, fieldValue As String)

Adds or replaces a MIME header field in one of the email's related items. If the header field does not exist, it is added. Otherwise it is replaced.

AddRelatedString(nameInHtml As String, str As String, charset As String) As String

Adds a related item to the email. A related item is typically an image or style sheet referenced by an HTML tag within the HTML email body. The contents of the related item are passed str. nameInHtml specifies the filename that should be used within the HTML, and not an actual filename on the local filesystem. charset specifies the charset that should be used for the text content of the related item. Returns the content-ID generated for the added item.

Returns 1 for success, 0 for failure.

AddRelatedString2(content As String, charset As String, fileNameInHtml As String)

Adds a related item to the email from an in-memory string. Related items are things such as images and style sheets that are embedded within an HTML email. They are not considered attachments because their sole purpose is to participate in the display of the HTML. The filenameInHtml argument should be set to the filename used in the HTML img tag's src attribute (if it's an image), or the URL referenced in an HTML link tag for a stylesheet. The charset argument indicates that the content should first be converted to the specified charset prior to adding to the email. It should hava a value such as "iso-8859-1", "utf-8", "Shift_JIS", etc.

AddStringAttachment(path As String, content As String) As Long

Adds an attachment directly from a string in memory to the email.

Returns 1 for success, 0 for failure.

AddStringAttachment2(path As String, content As String, charset As String) As Long

Adds an attachment to an email. The filename argument specifies the filename to be used for the attachment and is not an actual filename existing on the local filesystem. The "str" argument contains the text data for the attachment. The string will be converted to the charset specified in the last argument before being added to the email.

Returns 1 for success, 0 for failure.

AddTo(friendlyName As String, emailAddress As String) As Long

Adds a recipient to the "to" list. address is required, but name may be empty. Emails that have no "To" recipients will be sent to <undisclosed-recipients>.

Returns 1 for success, 0 for failure.

AddiCalendarAlternativeBody(icalContent As String, methodName As String) As Long

Adds an iCalendar (text/calendar) alternative body to the email. The icalContent contains the content of the iCalendar data. A sample is shown here:

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//hacksw/handcal//NONSGML v1.0//EN
BEGIN:VEVENT
UID:uid1@example.com
DTSTAMP:19970714T170000Z
ORGANIZER;CN=John Doe:MAILTO:john.doe@example.com
DTSTART:19970714T170000Z
DTEND:19970715T035959Z
SUMMARY:Bastille Day Party
END:VEVENT
END:VCALENDAR
The methodName is the "method" attribute used in the Content-Type header field in the alternative body. For example, if set to "REQUEST", then the alternative body's header would look like this:
Content-Type: text/calendar; method=REQUEST
Content-Transfer-Encoding: base64

Returns 1 for success, 0 for failure.

AesDecrypt(password As String) As Long

Decrypts and restores an email message that was previously encrypted using AesEncrypt. The password must match the password used for encryption.

Returns 1 for success, 0 for failure.

AesEncrypt(password As String) As Long

Encrypts the email body, all alternative bodies, all message sub-parts and attachments using 128-bit AES (Rijndael, CBC mode) encryption. To decrypt, you must use the AesDecrypt method with the same password. The AesEncrypt/Decrypt methods use symmetric password-based greatly simplify sending and receiving encrypted emails because certificates and public/private key issues do not have to be dealt with. However, the sending and receiving applications must both be using Chilkat Email .NET or ActiveX components.

Returns 1 for success, 0 for failure.

AppendToBody(str As String)

Appends a string to the plain-text body.

AspUnpack(prefix As String, saveDir As String, urlPath As String, cleanFiles As Long) As Long

Please see the examples at the following pages for detailed information:

Returns 1 for success, 0 for failure.

Display HTML Email in Web Page

Display HTML Email in IFrame (or Frame)

AspUnpack2(prefix As String, saveDir As String, urlPath As String, cleanFiles As Long) As Variant

Please see the examples at the following pages for detailed information:

Returns 1 for success, 0 for failure.

Display HTML Email in Web Page

Display HTML Email in IFrame (or Frame)

AttachMessage(mimeBytes As Variant) As Long

Attaches a MIME message to the email object. The attached MIME will be encapsulated in an message/rfc822 sub-part. To attach one email object to another, pass the output of GetMimeBinary to the input of this method.

Returns 1 for success, 0 for failure.

BEncodeBytes(inData As Variant, charset As String) As String

Takes a byte array of multibyte (non-Unicode) data and returns a Unicode B-Encoded string.

Returns 1 for success, 0 for failure.

BEncodeString(str As String, charset As String) As String

Takes a Unicode string, converts it to the charset specified in the 2nd parameter, B-Encodes the converted multibyte data, and returns the encoded Unicode string.

Returns 1 for success, 0 for failure.

ClearBcc()

Clears the list of blind carbon-copy recipients.

ClearCC()

Clears the list of carbon-copy recipients.

ClearEncryptCerts()

Clears the internal list of explicitly specified certificates to be used for this encrypted email.

ClearTo()

Clears the list of "to" recipients.

Clone() As ChilkatEmail2

Creates and returns an identical copy of the Email object.

ComputeGlobalKey(encoding As String, bFold As Long) As String

Computes a global unique key for the email that may be used as a key for a relational database table (or anything else). The key is created by a digest-MD5 hash of the concatenation of the following header fields: Message-ID, Subject, From, Date, To. (The header fields are Q/B decoded if necessary, converted to the utf-8 encoding, concatenated, and hashed using MD5.) The 16-byte MD5 hash is returned as an encoded string. The encoding determines the encoding: base64, hex, url, etc. If bFold is 1, then the 16-byte MD5 hash is folded to 8 bytes with an XOR to produce a shorter key.

Returns 1 for success, 0 for failure.

CreateDsn(humanReadableMessage As String, xmlStatusFields As String, bHeaderOnly As Long) As ChilkatEmail2

Creates a new DSN (Delivery Status Notification) email having the format as specified in RFC 3464. See the example (below) for more detailed information.

(ASP) Create DSN (Delivery Status Notification) Email

(VB6) Create DSN (Delivery Status Notification) Email

(Delphi) Create DSN (Delivery Status Notification) Email

(FoxPro) Create DSN (Delivery Status Notification) Email

(PHP using ActiveX) Create DSN (Delivery Status Notification) Email

(VBScript) Create DSN (Delivery Status Notification) Email

CreateForward() As ChilkatEmail2

Returns a copy of the Email object with the body and header fields changed so that the newly created email can be forwarded. After calling CreateForward, simply add new recipients to the created email, and call MailMan.SendEmail.

CreateMdn(humanReadableMessage As String, xmlStatusFields As String, bHeaderOnly As Long) As ChilkatEmail2

Creates a new MDN (Message Disposition Notification) email having the format as specified in RFC 3798. See the example (below) for more detailed information.

(ASP) Create MDN (Message Disposition Notification) Email

(VB6) Create MDN (Message Disposition Notification) Email

(Delphi) Create MDN (Message Disposition Notification) Email

(FoxPro) Create MDN (Message Disposition Notification) Email

(PHP using ActiveX) Create MDN (Message Disposition Notification) Email

(VBScript) Create MDN (Message Disposition Notification) Email

CreateReply() As ChilkatEmail2

Returns a copy of the Email object with the body and header fields changed so that the newly created email can be sent as a reply. After calling CreateReply, simply prepend additional information to the body, and call MailMan.SendEmail.

CreateTempMht(inFilename As String) As String

Saves the email to a temporary MHT file so that a WebBrowser control can navigate to it and display it. If fileName is empty, a temporary filename is generated and returned. If fileName is non-empty, then it will be created or overwritten, and the input filename is simply returned.The MHT file that is created will not contain any of the email's attachments, if any existed. Also, if the email was plain-text, the MHT file will be saved such that the plain-text is converted to HTML using pre-formatted text ("pre" HTML tags) allowing it to be displayed correctly in a WebBrowser.

Returns 1 for success, 0 for failure.

DropAttachments()

Removes all attachments from the email.

DropRelatedItem(index As Long)

A related item is typically an embedded image referenced from the HTML in the email via a "CID" hyperlink. This method removes the Nth embedded image from the email. Note: If the HTML tries to reference the removed image, it will be displayed as a broken image link.

DropRelatedItems()

A related item is typically an embedded image referenced from the HTML in the email via a "CID" hyperlink. This method removes all the embedded images from the email.

DropSingleAttachment(index As Long) As Long

Drops a single attachment from the email. Returns True if successful.

Returns 1 for success, 0 for failure.

FindIssuer(cert As ChilkatCert) As ChilkatCert

Digitally signed and/or encrypted emails are automatically "unwrapped" when received from a POP3 or IMAP server, or when loaded from any source such as a MIME string, in-memory byte data, or a .eml file. The results of the signature verification / decryption are stored in the properties such as ReceivedSigned, ReceivedEncrypted, SignaturesValid, etc. The signing certificate can be obtained via the GetSigningCert function. If the signature contained more certificates in the chain of authentication, this method provides a means to access them.

During signature verification, the email object collects the certs found in the signature and holds onto them internally. To get the issuing certificate of the signing certificate, call this method passing the cert returned by GetSigningCert. If the issuing cert is available, it is returned. Otherwise Nothing is returned. If the cert passed in is the root (i.e. a self-signed certificate), then the cert object returned is a copy of the cert passed in.

To traverse the chain to the root, one would write a loop that on first iteration passes the cert returned by GetSignedByCert (not GetSignerCert), and then on each subsequent iteration passes the cert from the previous iteration. The loop would exit when a cert is returned that has the same SubjectDN and SerialNumber as what was passed in (or when FindIssuer returns Nothing).

GenerateFilename() As String

Generates a unique filename for this email. The filename will be different each time the method is called.

Returns 1 for success, 0 for failure.

GetAltHeaderField(index As Long, fieldName As String) As String

Returns the value of a header field within the Nth alternative body's MIME sub-part.

Returns 1 for success, 0 for failure.

GetAlternativeBody(index As Long) As String

Returns the Nth alternative body. The NumAlternatives property tells the number of alternative bodies present. Use the GetHtmlBody and GetPlainTextBody methods to easily get the HTML or plain text alternative bodies.

Returns 1 for success, 0 for failure.

GetAlternativeBodyByContentType(contentType As String) As String

Returns the alternative body by content-type, such as "text/plain", "text/html", "text/xml", etc.

Returns 1 for success, 0 for failure.

GetAlternativeContentType(index As Long) As String

Returns the content type of the Nth alternative body. The NumAlternatives property tells the number of alternative bodies present.

Returns 1 for success, 0 for failure.

GetAttachedMessage(index As Long) As ChilkatEmail2

Returns an embedded "message/rfc822" subpart as an email object. (Emails are embedded as "message/rfc822" subparts by some mail clients when forwarding an email.) This method allows the original email to be accessed.

GetAttachedMessageFilename(index As Long) As String

Returns the filename of the Nth attached (embedded) email. The filename is the "filename" attribute of the content-disposition header field found within the Nth message/rfc822 sub-part of the calling email object.

Returns 1 for success, 0 for failure.

GetAttachmentContentID(index As Long) As String

Returns the ContentID header field for the Nth attachment. The first attachment is at index 0.

Returns 1 for success, 0 for failure.

GetAttachmentContentType(index As Long) As String

Returns the Content-Type header field for the Nth attachment. Indexing of attachments begins at 0.

Returns 1 for success, 0 for failure.

GetAttachmentData(index As Long) As Variant

Retrieves an attachment's binary data for in-memory access.

Returns 1 for success, 0 for failure.

GetAttachmentFilename(index As Long) As String

Retrieves an attachment's filename.

Returns 1 for success, 0 for failure.

GetAttachmentHeader(attachIndex As Long, fieldName As String) As String

Returns the value of a header field (by name) of an attachment.

Returns 1 for success, 0 for failure.

GetAttachmentSize(index As Long) As Long

Returns the size (in bytes) of the Nth attachment. The 1st attachment is at index 0. Returns -1 if there is no attachment at the specified index.

GetAttachmentString(index As Long, charset As String) As String

Retrieves an attachment's data as a String. All CRLF sequences will be translated to single newline characters.

Returns 1 for success, 0 for failure.

GetAttachmentStringCrLf(index As Long, charset As String) As String

Retrieves an attachment's data as a String. All end-of-lines will be translated to CRLF sequences.

Returns 1 for success, 0 for failure.

GetBcc(index As Long) As String

Returns a blind carbon-copy recipient's full email address.

Returns 1 for success, 0 for failure.

GetBccAddr(index As Long) As String

Returns the Nth BCC address (only the address part, not the friendly-name part).

Returns 1 for success, 0 for failure.

GetBccName(index As Long) As String

Returns the Nth BCC name (only the friendly-name part, not the address part).

Returns 1 for success, 0 for failure.

GetCC(index As Long) As String

Returns a carbon-copy recipient's full email address.

Returns 1 for success, 0 for failure.

(ASP) Getting TO / CC Email Recipients

(VB6) Getting TO / CC Email Recipients

(Delphi) Getting TO / CC Email Recipients

(FoxPro) Getting TO / CC Email Recipients

(PHP using ActiveX) Getting TO / CC Email Recipients

(VBScript) Getting TO / CC Email Recipients

GetCcAddr(index As Long) As String

Returns the Nth CC address (only the address part, not the friendly-name part).

Returns 1 for success, 0 for failure.

GetCcName(index As Long) As String

Returns the Nth CC name (only the friendly-name part, not the address part).

Returns 1 for success, 0 for failure.

GetDeliveryStatusInfo(fieldName As String) As String

If the email is a multipart/report, then it is a delivery status notification. This method can be used to get individual pieces of information from the message/delivery-status part of the email. This method should only be called if the IsMultipartReport method returns 1.

The fieldName should be set a string such as "Final-Recipient", "Status", "Action", "Reporting-MTA", etc.

Reporting-MTA: dns; XYZ.abc.nl

Final-recipient: RFC822; someEmailAddr@doesnotexist123.nl
Action: failed
Status: 5.4.4
X-Supplementary-Info: < #5.4.4 smtp;554 5.4.4
 SMTPSEND.DNS.NonExistentDomain; nonexistent domain>

Returns 1 for success, 0 for failure.

GetDsnFinalRecipients() As CkStringArray

If the email is a multipart/report, then it is a delivery status notification. This method can be used to get Final-Recipient values from the message/delivery-status part of the email. This method should only be called if the IsMultipartReport method returns 1.

GetDt() As CkDateTime

Returns the date/time found in the "Date" header field as a date/time object.

GetEncryptCert() As ChilkatCert

Returns the certificate that was previously set by SetEncryptCert.

GetEncryptedByCert() As ChilkatCert

Returns the certificate associated with a received encrypted email.

GetFileContent(path As String) As Variant

Reads a file and returns the contents as a String. This is here purely for convenience.

Returns 1 for success, 0 for failure.

GetHeaderField(fieldName As String) As String

Returns the value of a header field.

Returns 1 for success, 0 for failure.

GetHeaderFieldName(index As Long) As String

Return the name of the Nth header field. The NumHeaderFields() method can be used to get the number of header fields. The GetHeaderField() method can be used to get the value of the field given the field name.

Returns 1 for success, 0 for failure.

GetHeaderFieldValue(index As Long) As String

Returns the value of the Nth header field. (Indexing begins at 0) The number of header fields can be obtained from the NumHeaderFields property.

Returns 1 for success, 0 for failure.

GetHtmlBody() As String

Returns the body having the "text/html" content type.

Returns 1 for success, 0 for failure.

GetImapUid() As Long

When email headers are downloaded from an IMAP server (using Chilkat IMAP), a "ckx-imap-uid" header field is added. The content of this header is the UID or sequence number of the email on the IMAP server. In addition, a "ckx-imap-isUid" header field is added, and this will have the value YES or NO. If the value is YES, then ckx-imap-uid contains a UID, if the value is NO, then ckx-imap-uid contains the sequence number. This method returns the UID if ckx-imap-uid exists and contains a UID, otherwise it returns -1.

An application that wishes to download the full email would use this UID and then call the Chilkat IMAP object's FetchSingle or FetchSingleAsMime methods.

If this method is not yet available in your version of the Chilkat Email object, you may also call GetHeaderField("ckx-imap-uid") to fetch the UID as a string, and then convert it to an integer.

GetLinkedDomains() As CkStringArray

Parses an HTML email and returns the set of domain names that occur in hyperlinks within the HTML body.

GetMbHeaderField(fieldName As String, charset As String) As Variant

Returns a header field's data in a byte array. If the field was Q or B encoded, this is automatically decoded, and the raw bytes of the field are returned. Call GetHeaderField to retrieve the header field as a Unicode string.

Returns 1 for success, 0 for failure.

GetMbHtmlBody(charset As String) As Variant

Returns the HTML body converted to a specified charset. If no HTML body exists, the returned byte array is empty. The returned data will be such that not only is the character data converted (if necessary) to the convertToCharset, but the HTML is edited to add or modify the META tag that specifies the charset within the HTML.

Returns 1 for success, 0 for failure.

GetMbPlainTextBody(charset As String) As Variant

Returns the plain-text body converted to a specified charset. The return value is a byte array containing multibyte character data.

Returns 1 for success, 0 for failure.

GetMime() As String

Return the email as MIME text containing the email header, body (or bodies), related items (if any), and all attachments

Returns 1 for success, 0 for failure.

GetMimeBinary() As Variant

Returns the full MIME of an email.

Returns 1 for success, 0 for failure.

GetMimeObject() As ChilkatMime

Creates and returns a Mime object containing the contents of the email. This method is provided for those users that need full access to every aspect of the MIME message, such as manipulation of the message headers of attachments and related items contained within message subparts.(The returned Mime object returned is locked, and needs to be unlocked with a Chilkat S/MIME .NET unlock code, which can be obtained by purchasing a Chilkat S/MIME .NET license.)

GetPlainTextBody() As String

Returns the email body having the "text/plain" content type.

Returns 1 for success, 0 for failure.

GetRelatedContentID(index As Long) As String

Returns the content ID of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails.

Returns 1 for success, 0 for failure.

GetRelatedContentLocation(index As Long) As String

Returns the Content-Location of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails.

Returns 1 for success, 0 for failure.

GetRelatedContentType(index As Long) As String

Returns the content-type of the Nth related content item in an email message.

Returns 1 for success, 0 for failure.

GetRelatedData(index As Long) As Variant

Returns the content of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails.

Returns 1 for success, 0 for failure.

GetRelatedFilename(index As Long) As String

Returns the filename of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails.

Returns 1 for success, 0 for failure.

GetRelatedString(index As Long, charset As String) As String

Returns the text with CR line-endings of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails.

Returns 1 for success, 0 for failure.

GetRelatedStringCrLf(index As Long, charset As String) As String

Returns the text with CRLF line-endings of a related item contained with the email. Related items are typically images and style-sheets embedded within HTML emails.

Returns 1 for success, 0 for failure.

GetReplacePattern(index As Long) As String

Returns a replacement pattern previously defined for mail-merge operations.

Returns 1 for success, 0 for failure.

GetReplaceString(index As Long) As String

Returns a replacement string for a previously defined pattern/replacement string pair. (This is a mail-merge feature.)

Returns 1 for success, 0 for failure.

GetReplaceString2(pattern As String) As String

Returns a replacement string for a previously defined pattern/replacement string pair. (This is a mail-merge feature.)

Returns 1 for success, 0 for failure.

GetReport(index As Long) As String

(See the NumReports property.) Returns the body content of the Nth report within a multipart/report email.

Multipart/report is a message type that contains data formatted for a mail server to read. It is split between a text/plain (or some other content/type easily readable) and a message/delivery-status, which contains the data formatted for the mail server to read.

It is defined in RFC 3462

Returns 1 for success, 0 for failure.

GetSignedByCert() As ChilkatCert

Return the certificate used to digitally sign this email.

GetSigningCert() As ChilkatCert

Return the certificate that will be used to digitally sign this email. This is the cerficate that was previously set by calling the SetSigningCert method.

GetTo(index As Long) As String

Returns a "to" recipient's full email address.

Returns 1 for success, 0 for failure.

(ASP) Getting TO / CC Email Recipients

(VB6) Getting TO / CC Email Recipients

(Delphi) Getting TO / CC Email Recipients

(FoxPro) Getting TO / CC Email Recipients

(PHP using ActiveX) Getting TO / CC Email Recipients

(VBScript) Getting TO / CC Email Recipients

GetToAddr(index As Long) As String

Returns the Nth To address (only the address part, not the friendly-name part).

Returns 1 for success, 0 for failure.

GetToName(index As Long) As String

Returns the Nth To name (only the friendly-name part, not the address part).

Returns 1 for success, 0 for failure.

GetXml() As String

Convert the email object to an XML document in memory

Returns 1 for success, 0 for failure.

HasHeaderMatching(fieldName As String, valuePattern As String, caseSensitive As Long) As Long

Returns 1 if the email has a header field with the specified fieldName with a value matching valuePattern. Case sensitivity is controlled by caseSensitive. The valuePattern may include 0 or more asterisk (wildcard) characters which match 0 or more of any character.

HasHtmlBody() As Long

Returns true if the email has an HTML body.

HasPlainTextBody() As Long

Returns true if the email has a plain-text body.

IsMultipartReport() As Long

Returns true if the email is a multipart/report email.

LoadBodyFromFile(filePath As Chilkat, isHtml As Chilkat, charset As Chilkat) As Long

Sets the plain-text or HTML body from the contents of a file. For an HTML file, the isHtml argument should be 1 (otherwise 0). The character encoding of the file, ,such as utf-8, ansi, etc. is specified by charset.

LoadEml(mimePath As String) As Long

Loads a complete email from a .EML file. (EML files are simply RFC822 MIME text files.)

Returns 1 for success, 0 for failure.

LoadXml(xmlPath As String) As Long

Loads an email with the contents of an XML email file.

Returns 1 for success, 0 for failure.

LoadXmlString(xmlStr As String) As Long

Loads an email from an XML string (previously obtained by calling the GetXml method). The contents of the calling email object are erased and replaced with the email contained within the XML string.

Returns 1 for success, 0 for failure.

QEncodeBytes(inData As Variant, charset As String) As String

Takes a byte array of multibyte (non-Unicode) data and returns a Unicode Q-Encoded string.

Returns 1 for success, 0 for failure.

QEncodeString(str As String, charset As String) As String

Takes a Unicode string, converts it to the charset specified in the 2nd parameter, Q-Encodes the converted multibyte data, and returns the encoded Unicode string.

Returns 1 for success, 0 for failure.

RemoveAttachedMessage(idx As Long)

Removes the Nth message/rfc822 sub-part of the email. Indexing begins at 0.

RemoveAttachedMessages()

Removes all message/rfc822 sub-parts of the email object.

RemoveAttachmentPaths()

Removes path information from all attachment filenames.

RemoveHeaderField(fieldName As String)

Removes by name all occurances of a header field.

RemoveHtmlAlternative()

Removes the HTML body from the email (if an HTML body exists).

RemovePlainTextAlternative()

Removes the plain-text body from the email (if a plain-text body exists).

SaveAllAttachments(dirPath As String) As Long

Save all the attachments of an email to files in a directory specified by dirPath. The OverwriteExisting property controls whether existing files are allowed to be overwritten.

Returns 1 for success, 0 for failure.

(ASP) Example: Download and Save Email Attachments (POP3)

(VB6) Example: Download and Save Email Attachments (POP3)

(Delphi) Example: Download and Save Email Attachments (POP3)

(FoxPro) Example: Download and Save Email Attachments (POP3)

(PHP using ActiveX) Example: Download and Save Email Attachments (POP3)

(VBScript) Example: Download and Save Email Attachments (POP3)

SaveAttachedFile(index As Long, dirPath As String) As Long

Saves the Nth email attachment to the directory specified by dirPath. The 1st attachment is at index 0. The OverwriteExisting property controls whether existing files are allowed to be overwritten.

Returns 1 for success, 0 for failure.

(ASP) Example: Download and Save Email Attachments (POP3)

(VB6) Example: Download and Save Email Attachments (POP3)

(Delphi) Example: Download and Save Email Attachments (POP3)

(FoxPro) Example: Download and Save Email Attachments (POP3)

(PHP using ActiveX) Example: Download and Save Email Attachments (POP3)

(VBScript) Example: Download and Save Email Attachments (POP3)

SaveEml(emlFilePath As String) As Long

Convert this email object to EML and save it to a file.

Returns 1 for success, 0 for failure.

SaveRelatedItem(index As Long, dirPath As String) As Long

Saves the Nth related item to the directory specified by dirPath. (The 1st related item is at index 0) Related content items are typically image or style-sheets embedded within an HTML email. The OverwriteExisting property controls whether existing files are allowed to be overwritten.

Returns 1 for success, 0 for failure.

SaveXml(path As String) As Long

Convert this email object to XML and save it to a file.

Returns 1 for success, 0 for failure.

SetAttachmentCharset(index As Long, charset As String) As Long

Sets the charset attribute of the content-type header field for a specified attachment. This can be used if the attachment is a text file that contains text in a non us-ascii charset such as Shift_JIS, iso-8859-2, big5, iso-8859-5, etc.

Returns 1 for success, 0 for failure.

SetAttachmentDisposition(index As Long, disposition As String) As Long

Set's an attachment's disposition. The default disposition of an attachment is "attachment". This method is typically called to change the disposition to "inline". The 1st attachment is at index 0.

Returns 1 for success, 0 for failure.

SetAttachmentFilename(index As Long, filename As String) As Long

Renames a email attachment's filename. The 1st attachment is at index 0.

Returns 1 for success, 0 for failure.

SetCSP(csp As ChilkatCsp) As Long

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

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.

SetDt(dt As CkDateTime) As Long

Sets the "Date" header field of the email to have the value of the date/time object provided.

Returns 1 for success, 0 for failure.

SetEncryptCert(cert As ChilkatCert) As Long

Set the encryption certificate to be used in encryption. Use the CreateCS, CertStore, and Cert classes to create a Cert object by either locating a certificate in a certificate store or loading one from a file.

Returns 1 for success, 0 for failure.

(ASP) Using a .cer Certificate File for Encrypted Email

(VB6) Using a .cer Certificate File for Encrypted Email

(Delphi) Using a .cer Certificate File for Encrypted Email

(FoxPro) Using a .cer Certificate File for Encrypted Email

(PHP using ActiveX) Using a .cer Certificate File for Encrypted Email

(VBScript) Using a .cer Certificate File for Encrypted Email

SetFromMimeBytes(mimeBytes As Variant) As Long

Loads the email object with the mimeBytes. If the email object already contained an email, it is entirely replaced. The character encoding (such as "utf-8", "iso-8859-1", etc.) of the bytes is automatically inferred from the content. If for some reason it is not possible to determine the character encoding, the SetFromMimeBytes2 method may be called to explicitly specify the charset.

Returns 1 for success, 0 for failure.

SetFromMimeBytes2(mimeBytes As Variant, charset As String) As Long

Loads the email object with the mimeBytes. If the email object already contained an email, it is entirely replaced.

The charset specifies the character encoding of the MIME bytes (such as "utf-8", "iso-8859-1", etc.).

Returns 1 for success, 0 for failure.

SetFromMimeObject(mime As ChilkatMime) As Long

Loads and replaces the contents of this email object with the contents of a Mime object

Returns 1 for success, 0 for failure.

SetFromMimeText(mimeText As String) As Long

Loads an email with the contents of a .eml (i.e. MIME) contained in a string. The contents of the email object are completely replaced.

Returns 1 for success, 0 for failure.

SetFromXmlText(xmlStr As String) As Long

Loads an email from an XML string.

Returns 1 for success, 0 for failure.

SetHtmlBody(html As String)

Sets the HTML body of an email.

SetMbHtmlBody(charset As String, inData As Variant) As Long

Sets the HTML email body from a byte array containing character data in the specified character set. This method also updates the email "content-type"header to properly reflect the content type of the body.

Returns 1 for success, 0 for failure.

SetMbPlainTextBody(charset As String, inData As Variant) As Long

Sets the plain-text email body from a byte array containing character data in the specified character set. This method also updates the email "content-type"header to properly reflect the content type of the body.

Returns 1 for success, 0 for failure.

SetRelatedFilename(index As Long, path As String) As Long

Sets the filename for a related item within the email.

Returns 1 for success, 0 for failure.

SetReplacePattern(pattern As String, replaceString As String) As Long

Create a pattern/replacement-text pair for mail-merge. When the email is sent via the MailMan's SendEmail method, or any other mail-sending method, the patterns are replaced with the replacement strings during the sending process. Do define multiple replacement patterns, simply call SetReplacePattern once per pattern/replacement string. (Note: The MailMan's RenderToMime method will also do pattern replacements. Methods such as SaveEml or GetMime do not replace patterns.)

Note: Replacement patterns may be placed in any header field, and in both HTML and plain-text email bodies.

Returns 1 for success, 0 for failure.

SetSigningCert(cert As ChilkatCert) As Long

Set the certificate to be used in creating a digital signature. Use the CreateCS, CertStore, and Cert classes to create a Cert object by either locating a certificate in a certificate store or loading one from a file.

Returns 1 for success, 0 for failure.

SetSigningCert2(cert As ChilkatCert, key As PrivateKey) As Long

Explicitly sets the certificate and private key to be used for sending digitally signed email. If the certificate's private key is already installed on the computer, then one may simply call SetSigningCert because the Chilkat component will automatically locate and use the corresponding private key (stored in the Windows Protected Store). In most cases, if the digital certificate is already installed w/ private key on the computer, it is not necessary to explicitly set the signing certificate at all. The Chilkat component will automatically locate and use the certificate containing the FROM email address (from the registry-based certificate store where it was installed).

Returns 1 for success, 0 for failure.

SetTextBody(bodyText As String, contentType As String)

Sets the body of the email and also sets the Content-Type header field of the contentType. If the email is already multipart/alternative, an additional alternative with the indicated Content-Type will be added. If an alternative with the same Content-Type already exists, it is replaced.

UnSpamify()

Unobfuscates emails by undoing what spammers do to obfuscate email. It removes comments from HTML bodies and unobfuscates hyperlinked URLs.

UnpackHtml(unpackDir As String, htmlFilename As String, partsSubdir As String) As Long

Unpacks an HTML email into an HTML file and related files (images and style sheets). The links within the HTML are updated to point to the files unpacked and saved to disk.

Returns 1 for success, 0 for failure.

UnzipAttachments() As Long

Unzips and replaces any Zip file attachments with the expanded contents. As an example, if an email contained a single Zip file containing 3 GIF image files as an attachment, then after calling this method the email would contain 3 GIF file attachments, and the Zip attachment would be gone.If an email contains multiple Zip file attachments, each Zip is expanded and replaced with the contents.

Returns 1 for success, 0 for failure.

ZipAttachments(zipFilename As String) As Long

Replaces all the attachments of an email with a single Zip file attachment having the filename specified.

Returns 1 for success, 0 for failure.