Email Unicode C Reference Documentation

Email

Represents a complete Email object.

Create/Dispose

HCkEmailW CkEmailW_Create(void);

Creates an instance of the HCkEmailW object and returns a handle (i.e. a "void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkEmailW_Dispose(HCkEmailW handle);

Objects created by calling CkEmailW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkEmailW_Dispose.

Properties

void CkEmailW_getBody(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putBody(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_body(HCkEmailW cHandle);

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.

void CkEmailW_getBounceAddress(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putBounceAddress(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_bounceAddress(HCkEmailW cHandle);

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.

Note: The Sender and BounceAddress properties are identical and perform the same function. Setting the Sender property also sets the BounceAddress property, and vice-versa. The reason for the duplication is that BounceAddress existed first, and developers typically searched for a "Sender" property without realizing that the BounceAddress property served this function.

SMTP Protocol in a Nutshell

void CkEmailW_getCharset(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putCharset(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_charset(HCkEmailW cHandle);

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.

void CkEmailW_getDebugLogFilePath(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putDebugLogFilePath(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_debugLogFilePath(HCkEmailW cHandle);

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.

BOOL CkEmailW_getDecrypted(HCkEmailW cHandle);

TRUE if the email arrived encrypted and was successfully decrypted, otherwise FALSE.

SYSTEMTIME * CkEmailW_getEmailDate(HCkEmailW cHandle);

void CkEmailW_putEmailDate(HCkEmailW cHandle, SYSTEMTIME *newVal);

This property is deprecated. It will be removed in a future version.

The date/time from the "Date" header in UTC/GMT standard time. Use the LocalDate property to get the local date and time. This property should no longer be used because it will be removed in a future version. Use the GetDt method instead.

void CkEmailW_getEmailDateStr(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putEmailDateStr(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_emailDateStr(HCkEmailW cHandle);

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

void CkEmailW_getEncryptedBy(HCkEmailW cHandle, HCkString retval);

const wchar_t *CkEmailW_encryptedBy(HCkEmailW cHandle);

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

void CkEmailW_getFileDistList(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putFileDistList(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_fileDistList(HCkEmailW cHandle);

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

void CkEmailW_getFrom(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putFrom(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_from(HCkEmailW cHandle);

The combined name and email address of the sender, such as "John Smith" . This is the content that will be placed in the From: header field. If the actual sender is to be different, then set the Sender property to a different email address.

Explaining the Email FromName, FromAddress, and From Properties

void CkEmailW_getFromAddress(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putFromAddress(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_fromAddress(HCkEmailW cHandle);

The email address of the sender.

Explaining the Email FromName, FromAddress, and From Properties

void CkEmailW_getFromName(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putFromName(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_fromName(HCkEmailW cHandle);

The name of the sender.

Explaining the Email FromName, FromAddress, and From Properties

void CkEmailW_getHeader(HCkEmailW cHandle, HCkString retval);

const wchar_t *CkEmailW_header(HCkEmailW cHandle);

The complete MIME header of the email.

void CkEmailW_getLanguage(HCkEmailW cHandle, HCkString retval);

const wchar_t *CkEmailW_language(HCkEmailW cHandle);

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.

void CkEmailW_getLastErrorHtml(HCkEmailW cHandle, HCkString retval);

const wchar_t *CkEmailW_lastErrorHtml(HCkEmailW cHandle);

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.

void CkEmailW_getLastErrorText(HCkEmailW cHandle, HCkString retval);

const wchar_t *CkEmailW_lastErrorText(HCkEmailW cHandle);

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

void CkEmailW_getLastErrorXml(HCkEmailW cHandle, HCkString retval);

const wchar_t *CkEmailW_lastErrorXml(HCkEmailW cHandle);

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.

BOOL CkEmailW_getLastMethodSuccess(HCkEmailW cHandle);

void CkEmailW_putLastMethodSuccess(HCkEmailW cHandle, BOOL newVal);

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

SYSTEMTIME * CkEmailW_getLocalDate(HCkEmailW cHandle);

void CkEmailW_putLocalDate(HCkEmailW cHandle, SYSTEMTIME *newVal);

This property is deprecated. It will be removed in a future version.

The date/time found in the "Date" header field returned in the local timezone. This property should no longer be used because it will be removed in a future version. Use the GetDt method instead.

void CkEmailW_getLocalDateStr(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putLocalDateStr(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_localDateStr(HCkEmailW cHandle);

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

void CkEmailW_getMailer(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putMailer(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_mailer(HCkEmailW cHandle);

Identifies the email software that sent the email.

int CkEmailW_getNumAlternatives(HCkEmailW cHandle);

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.

int CkEmailW_getNumAttachedMessages(HCkEmailW cHandle);

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

Load .eml and Examine the Structure, Attachments, and Related Items

int CkEmailW_getNumAttachments(HCkEmailW cHandle);

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

Understanding IMAP Email Attachments

Load .eml and Examine the Structure, Attachments, and Related Items

int CkEmailW_getNumBcc(HCkEmailW cHandle);

The number of blind carbon-copy email recipients.

Getting TO / CC Email Recipients

int CkEmailW_getNumCC(HCkEmailW cHandle);

The number of carbon-copy email recipients.

Getting TO / CC Email Recipients

int CkEmailW_getNumDaysOld(HCkEmailW cHandle);

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

int CkEmailW_getNumDigests(HCkEmailW cHandle);

Introduced in version 9.5.0.66

Returns the number of message/rfc822 parts contained within the multipart/digest enclosure. If no multipart/digest enclosure exists, then this property has the value of 0. The GetDigest method is called to get the Nth digest as an email object.

Parsing a Multipart/Digest Email

int CkEmailW_getNumHeaderFields(HCkEmailW cHandle);

The number of header fields. When accessing a header field by index, the 1st header field is at index 0, and the last is at NumHeaderFields-1. (Chilkat indexing is always 0-based.)

int CkEmailW_getNumRelatedItems(HCkEmailW cHandle);

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.

Load .eml and Examine the Structure, Attachments, and Related Items

int CkEmailW_getNumReplacePatterns(HCkEmailW cHandle);

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.

int CkEmailW_getNumReports(HCkEmailW cHandle);

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

Load .eml and Examine the Structure, Attachments, and Related Items

int CkEmailW_getNumTo(HCkEmailW cHandle);

The number of direct email recipients.

Getting TO / CC Email Recipients

void CkEmailW_getOaepHash(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putOaepHash(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_oaepHash(HCkEmailW cHandle);

Introduced in version 9.5.0.67

Selects the hash algorithm for use within OAEP padding when encrypting email using RSAES-OAEP. The valid choices are "sha1", "sha256", "sha384", "sha512",

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

void CkEmailW_getOaepMgfHash(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putOaepMgfHash(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_oaepMgfHash(HCkEmailW cHandle);

Introduced in version 9.5.0.71

Selects the MGF hash algorithm for use within OAEP padding when encrypting email using RSAES-OAEP. The valid choices are "sha1", "sha256", "sha384", "sha512",

BOOL CkEmailW_getOaepPadding(HCkEmailW cHandle);

void CkEmailW_putOaepPadding(HCkEmailW cHandle, BOOL newVal);

Introduced in version 9.5.0.67

Selects the RSA encryption scheme when encrypting email. The default value is FALSE, which selects RSAES_PKCS1-V1_5. If set to TRUE, then RSAES_OAEP is used.

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

Send Encrypted Email using RSAES-OAEP with AES-128 CBC and SHA256

BOOL CkEmailW_getOverwriteExisting(HCkEmailW cHandle);

void CkEmailW_putOverwriteExisting(HCkEmailW cHandle, BOOL newVal);

When TRUE (the default) the methods to save email attachments and related items will overwrite files if they already exist. If FALSE, 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.

void CkEmailW_getPkcs7CryptAlg(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putPkcs7CryptAlg(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_pkcs7CryptAlg(HCkEmailW cHandle);

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". The default value is "aes".

Send Encrypted Email with a Selected Algorithm (AES, 3DES, etc.)

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

Send Encrypted Email using RSAES-OAEP with AES-128 CBC and SHA256

int CkEmailW_getPkcs7KeyLength(HCkEmailW cHandle);

void CkEmailW_putPkcs7KeyLength(HCkEmailW cHandle, int newVal);

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.

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

void CkEmailW_getPreferredCharset(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putPreferredCharset(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_preferredCharset(HCkEmailW cHandle);

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.

Controlling Charset of HTML Email

BOOL CkEmailW_getPrependHeaders(HCkEmailW cHandle);

void CkEmailW_putPrependHeaders(HCkEmailW cHandle, BOOL newVal);

If TRUE, 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 FALSE.

BOOL CkEmailW_getReceivedEncrypted(HCkEmailW cHandle);

TRUE if this email was originally received with encryption, otherwise FALSE.

BOOL CkEmailW_getReceivedSigned(HCkEmailW cHandle);

TRUE if this email was originally received with a digital signature, otherwise FALSE.

POP3 Verify Signed (S/MIME) Email

void CkEmailW_getReplyTo(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putReplyTo(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_replyTo(HCkEmailW cHandle);

Sets the "Reply-To" header field to the specified email address.

BOOL CkEmailW_getReturnReceipt(HCkEmailW cHandle);

void CkEmailW_putReturnReceipt(HCkEmailW cHandle, BOOL newVal);

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

BOOL CkEmailW_getSendEncrypted(HCkEmailW cHandle);

void CkEmailW_putSendEncrypted(HCkEmailW cHandle, BOOL newVal);

Set to TRUE if this email should be sent encrypted.

Using a .cer Certificate File for Encrypted Email

Select Cert for Encrypted Email

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

Send Encrypted Email using RSAES-OAEP with AES-128 CBC and SHA256

void CkEmailW_getSender(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putSender(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_sender(HCkEmailW cHandle);

Introduced in version 9.5.0.41

The sender's address for this email message.

This is the address of the actual sender acting on behalf of the author listed in the From: field.

Note: The Sender and BounceAddress properties are identical and perform the same function. Setting the Sender property also sets the BounceAddress property, and vice-versa. The reason for the duplication is that BounceAddress existed first, and developers typically searched for a "Sender" property without realizing that the BounceAddress property served this function.

Important Note: This property does not contain the value of the "Sender" header field, if one exists, for a received email. It is a property that is used when sending email. To get the value of the "Sender" header field (which may not always exist), call the GetHeaderField method instead.

Notes about the Sender Property

BOOL CkEmailW_getSendSigned(HCkEmailW cHandle);

void CkEmailW_putSendSigned(HCkEmailW cHandle, BOOL newVal);

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

Send a Signed Email using RSASSA-PSS with SHA256

BOOL CkEmailW_getSignaturesValid(HCkEmailW cHandle);

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

POP3 Verify Signed (S/MIME) Email

void CkEmailW_getSignedBy(HCkEmailW cHandle, HCkString retval);

const wchar_t *CkEmailW_signedBy(HCkEmailW cHandle);

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.

void CkEmailW_getSigningAlg(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putSigningAlg(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_signingAlg(HCkEmailW cHandle);

Introduced in version 9.5.0.67

Selects the signature algorithm to be used when sending signed (PKCS7) email. The default value is "PKCS1-v1_5". This can be set to "RSASSA-PSS" (or simply "pss") to use the RSASSA-PSS signature scheme.

Note: This property only applies when signing with an RSA private key. It does not apply for ECC or DSA private keys.

Sign Email using RSASSA-PSS with SHA256

Send a Signed Email using RSASSA-PSS with SHA256

void CkEmailW_getSigningHashAlg(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putSigningHashAlg(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_signingHashAlg(HCkEmailW cHandle);

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

int CkEmailW_getSize(HCkEmailW cHandle);

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

void CkEmailW_getSubject(HCkEmailW cHandle, HCkString retval);

void CkEmailW_putSubject(HCkEmailW cHandle, const wchar_t *newVal);

const wchar_t *CkEmailW_subject(HCkEmailW cHandle);

The email subject.

void CkEmailW_getUidl(HCkEmailW cHandle, HCkString retval);

const wchar_t *CkEmailW_uidl(HCkEmailW cHandle);

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.

BOOL CkEmailW_getUnpackUseRelPaths(HCkEmailW cHandle);

void CkEmailW_putUnpackUseRelPaths(HCkEmailW cHandle, BOOL newVal);

Applies to the UnpackHtml method. If TRUE, 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 TRUE.

BOOL CkEmailW_getVerboseLogging(HCkEmailW cHandle);

void CkEmailW_putVerboseLogging(HCkEmailW cHandle, BOOL newVal);

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

void CkEmailW_getVersion(HCkEmailW cHandle, HCkString retval);

const wchar_t *CkEmailW_version(HCkEmailW cHandle);

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

Methods

BOOL CkEmailW_AddAttachmentBd(HCkEmailW cHandle, const wchar_t *filename, HCkBinDataW binData, const wchar_t *contentType);

Introduced in version 9.5.0.63

Adds an attachment using the contents of a BinData object. If contentType is empty, then the content-type will be inferred from the filename extension.

Returns TRUE for success, FALSE for failure.

Add Email Attachment from FTP

void CkEmailW_AddAttachmentHeader(HCkEmailW cHandle, int index, const wchar_t *fieldName, const wchar_t *fieldValue);

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.

BOOL CkEmailW_AddBcc(HCkEmailW cHandle, const wchar_t *friendlyName, const wchar_t *emailAddress);

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

Returns TRUE for success, FALSE for failure.

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

BOOL CkEmailW_AddCC(HCkEmailW cHandle, const wchar_t *friendlyName, const wchar_t *emailAddress);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_AddDataAttachment(HCkEmailW cHandle, const wchar_t *fileName, const unsigned char * content);

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

Returns TRUE for success, FALSE for failure.

Add Binary Email Attachment from In-Memory Bytes

BOOL CkEmailW_AddDataAttachment2(HCkEmailW cHandle, const wchar_t *fileName, const unsigned char * content, const wchar_t *contentType);

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

Returns TRUE for success, FALSE for failure.

Add Binary Email Attachment from In-Memory Bytes

BOOL CkEmailW_AddEncryptCert(HCkEmailW cHandle, HCkCertW cert);

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. On Windows computers, the registry-based Current-User and Local-Machine certificate stores are automatically searched for certs matching each of the recipients (To, CC, and BCC recipients).

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

Returns TRUE for success, FALSE for failure.

Send Encrypted Email using RSAES-OAEP with AES-128 CBC and SHA256

BOOL CkEmailW_AddFileAttachment(HCkEmailW cHandle, const wchar_t *path, const wchar_t *outStrContentType);

const wchar_t *CkEmailW_addFileAttachment(HCkEmailW cHandle, const wchar_t *path);

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 TRUE for success, FALSE for failure.

Send Email With Attachments

BOOL CkEmailW_AddFileAttachment2(HCkEmailW cHandle, const wchar_t *path, const wchar_t *contentType);

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

Returns TRUE for success, FALSE for failure.

Send HTML Email with Attachments

void CkEmailW_AddHeaderField(HCkEmailW cHandle, const wchar_t *fieldName, const wchar_t *fieldValue);

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

void CkEmailW_AddHeaderField2(HCkEmailW cHandle, const wchar_t *fieldName, const wchar_t *fieldValue);

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.

BOOL CkEmailW_AddHtmlAlternativeBody(HCkEmailW cHandle, const wchar_t *body);

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 TRUE for success, FALSE for failure.

Send HTML Email with Attachments

BOOL CkEmailW_AddiCalendarAlternativeBody(HCkEmailW cHandle, const wchar_t *icalContent, const wchar_t *methodName);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_AddMultipleBcc(HCkEmailW cHandle, const wchar_t *commaSeparatedAddresses);

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 TRUE for success, FALSE for failure.

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

BOOL CkEmailW_AddMultipleCC(HCkEmailW cHandle, const wchar_t *commaSeparatedAddresses);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_AddMultipleTo(HCkEmailW cHandle, const wchar_t *commaSeparatedAddresses);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_AddPfxSourceData(HCkEmailW cHandle, const unsigned char * pfxBytes, const wchar_t *pfxPassword);

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 TRUE for success, FALSE for failure.

Demonstrates how to call AddPfxSourceData for an Email Object

BOOL CkEmailW_AddPfxSourceFile(HCkEmailW cHandle, const wchar_t *pfxFilePath, const wchar_t *pfxPassword);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_AddPlainTextAlternativeBody(HCkEmailW cHandle, const wchar_t *body);

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 TRUE for success, FALSE for failure.

Send HTML Email with Attachments

BOOL CkEmailW_AddRelatedBd(HCkEmailW cHandle, const wchar_t *filename, HCkBinDataW binData, const wchar_t *outStr);

const wchar_t *CkEmailW_addRelatedBd(HCkEmailW cHandle, const wchar_t *filename, HCkBinDataW binData);

Introduced in version 9.5.0.65

Adds a related item using the contents of a BinData object. Returns the Content-ID for the newly added relted item.

Returns TRUE for success, FALSE for failure.

Unpack HTML Email to Files

BOOL CkEmailW_AddRelatedBd2(HCkEmailW cHandle, HCkBinDataW binData, const wchar_t *fileNameInHtml);

Introduced in version 9.5.0.65

Adds a related item using the contents of a BinData object. The fileNameInHtml should be set to the filename/path/url used in the corresponding HTML IMG tag's "src" attribute.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_AddRelatedData(HCkEmailW cHandle, const wchar_t *fileName, const unsigned char * inData, const wchar_t *outStr);

const wchar_t *CkEmailW_addRelatedData(HCkEmailW cHandle, const wchar_t *fileName, const unsigned char * inData);

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 TRUE for success, FALSE for failure.

Send HTML Email with Image to iPhone

Send HTML Email with Embedded Image Loaded from Memory

void CkEmailW_AddRelatedData2(HCkEmailW cHandle, const unsigned char * inData, const wchar_t *fileNameInHtml);

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.

void CkEmailW_AddRelatedData2P(HCkEmailW cHandle, const unsigned char * pBytes, unsigned long szBytes, const wchar_t *fileNameInHtml);

The same as AddRelatedData2, except the data is passed in as a "const unsigned char *" with the byte count in szBytes.

BOOL CkEmailW_AddRelatedDataP(HCkEmailW cHandle, const wchar_t *nameInHtml, const unsigned char * pBytes, unsigned long szBytes, const wchar_t *outStrContentId);

const wchar_t *CkEmailW_addRelatedDataP(HCkEmailW cHandle, const wchar_t *nameInHtml, const unsigned char * pBytes, unsigned long szBytes);

The same as AddRelatedData, except the data is passed in as a "const unsigned char *" with the byte count in szBytes. The Content-ID assigned to the related item is returned (in ARG4 for the upper-case alternative for this method).

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_AddRelatedFile(HCkEmailW cHandle, const wchar_t *path, const wchar_t *outStrContentID);

const wchar_t *CkEmailW_addRelatedFile(HCkEmailW cHandle, const wchar_t *path);

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 TRUE for success, FALSE for failure.

Send HTML Email with Image to iPhone

Send HTML Email with Attachments

BOOL CkEmailW_AddRelatedFile2(HCkEmailW cHandle, const wchar_t *filenameOnDisk, const wchar_t *filenameInHtml);

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. The filenameOnDisk is the path in the local filesystem of the file to be added.

Note: Outlook.com will not properly display embedded HTMl images when the filenameInHtml includes a path part. Apparently, Outlook.com is only capable of correctly displaying images when the filenameInHtml is a only a filename. Other email clients, such as Mozilla Thunderbird, have no trouble when the filenameInHtml includes a path part.

Returns TRUE for success, FALSE for failure.

void CkEmailW_AddRelatedHeader(HCkEmailW cHandle, int index, const wchar_t *fieldName, const wchar_t *fieldValue);

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.

BOOL CkEmailW_AddRelatedString(HCkEmailW cHandle, const wchar_t *nameInHtml, const wchar_t *str, const wchar_t *charset, const wchar_t *outCid);

const wchar_t *CkEmailW_addRelatedString(HCkEmailW cHandle, const wchar_t *nameInHtml, const wchar_t *str, const wchar_t *charset);

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 TRUE for success, FALSE for failure.

Send HTML Email with External CSS as Related Item

void CkEmailW_AddRelatedString2(HCkEmailW cHandle, const wchar_t *fileNameInHtml, const wchar_t *content, const wchar_t *charset);

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.

Send HTML Email with CSS as Related Item using Content-Location

BOOL CkEmailW_AddStringAttachment(HCkEmailW cHandle, const wchar_t *path, const wchar_t *content);

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

Returns TRUE for success, FALSE for failure.

Send HTML Email with Attachments

BOOL CkEmailW_AddStringAttachment2(HCkEmailW cHandle, const wchar_t *path, const wchar_t *content, const wchar_t *charset);

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

Note: Beginning in v9.5.0.48, the charset may be prepended with "bom-" or "no-bom-" to include or exclude the BOM (preamble) for charsets such as utf-16 or utf-8. For example: "no-bom-utf-8" or "bom-utf-8".

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_AddTo(HCkEmailW cHandle, const wchar_t *friendlyName, const wchar_t *emailAddress);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_AesDecrypt(HCkEmailW cHandle, const wchar_t *password);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_AesEncrypt(HCkEmailW cHandle, const wchar_t *password);

Encrypts the email body, all alternative bodies, all message sub-parts and attachments using 128-bit AES CBC encryption. Decrypting is achieved by calling AesDecrypt with the same password. The AesEncrypt/Decrypt methods use symmetric password-based AES encryption and greatly simplify sending and receiving encrypted emails because certificates and private keys are not used. However, the sending and receiving applications must both use Chilkat, and the password must be pre-known on both ends.

Returns TRUE for success, FALSE for failure.

void CkEmailW_AppendToBody(HCkEmailW cHandle, const wchar_t *str);

Appends a string to the plain-text body.

BOOL CkEmailW_ApplyFixups(HCkEmailW cHandle, const wchar_t *fixups);

Introduced in version 9.5.0.71

Sometimes emails created by other software or systems are not formatted according to typical conventions. This method provides a means to automatically fix certain problems.

The fixups set to a comma-separated list of keywords that identify the fixups to be applied. At the moment, there is only one fixup defined ("FixRelated") as described here:

  • FixRelated: Fixes the email so that HTML related items (images for example) are properly located in the email MIME structure. This prevents them from being seen as attachments.
  • Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_AspUnpack(HCkEmailW cHandle, const wchar_t *prefix, const wchar_t *saveDir, const wchar_t *urlPath, BOOL cleanFiles);

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

Returns TRUE for success, FALSE for failure.

Display HTML Email in Web Page

Display HTML Email in IFrame (or Frame)

BOOL CkEmailW_AspUnpack2(HCkEmailW cHandle, const wchar_t *prefix, const wchar_t *saveDir, const wchar_t *urlPath, BOOL cleanFiles, const unsigned char * outHtml);

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

Returns TRUE for success, FALSE for failure.

Display HTML Email in Web Page

Display HTML Email in IFrame (or Frame)

BOOL CkEmailW_AttachMessage(HCkEmailW cHandle, const unsigned char * mimeBytes);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_BEncodeBytes(HCkEmailW cHandle, const unsigned char * inData, const wchar_t *charset, const wchar_t *outEncodedStr);

const wchar_t *CkEmailW_bEncodeBytes(HCkEmailW cHandle, const unsigned char * inData, const wchar_t *charset);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_BEncodeString(HCkEmailW cHandle, const wchar_t *str, const wchar_t *charset, const wchar_t *outEncodedStr);

const wchar_t *CkEmailW_bEncodeString(HCkEmailW cHandle, const wchar_t *str, const wchar_t *charset);

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 TRUE for success, FALSE for failure.

void CkEmailW_ClearBcc(HCkEmailW cHandle);

Clears the list of blind carbon-copy recipients.

void CkEmailW_ClearCC(HCkEmailW cHandle);

Clears the list of carbon-copy recipients.

void CkEmailW_ClearEncryptCerts(HCkEmailW cHandle);

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

void CkEmailW_ClearTo(HCkEmailW cHandle);

Clears the list of "to" recipients.

HCkEmailW CkEmailW_Clone(HCkEmailW cHandle);

Creates and returns an identical copy of the Email object.

Returns NULL on failure

BOOL CkEmailW_ComputeGlobalKey(HCkEmailW cHandle, const wchar_t *encoding, BOOL bFold, const wchar_t *outStr);

const wchar_t *CkEmailW_computeGlobalKey(HCkEmailW cHandle, const wchar_t *encoding, BOOL bFold);

This method is deprecated. It will be removed in a future version.

Important: New programs should ComputeGlobalKey2 instead. This method did not adequately canonicalize the string passed to the digest-MD5 hash and therefore different versions of Chilkat may produce different results with this method.

Computes a global unique key for the email. 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 TRUE, then the 16-byte MD5 hash is folded to 8 bytes with an XOR to produce a shorter key.

Returns TRUE for success, FALSE for failure.

Generate a Unique Key for an Email

BOOL CkEmailW_ComputeGlobalKey2(HCkEmailW cHandle, const wchar_t *encoding, BOOL bFold, const wchar_t *outStr);

const wchar_t *CkEmailW_computeGlobalKey2(HCkEmailW cHandle, const wchar_t *encoding, BOOL bFold);

Introduced in version 9.5.0.59

Computes a global unique key for the email. The key is created by a digest-MD5 hash of the concatenation of the following:

messageID + CRLF + subject + CRLF + from + CRLF + date + CRLF + recipientAddrs

messageID contains the contents of the Message-ID header field.
subject contains the contents of the Subject header field, trimmed of whitespace from both ends, 
    where TAB chars are converted to SPACE chars, and internal whitespace is trimmed so that 
   no more than one SPACE char in a row exists.
from contains the lowercase FROM header email address.
date contains the contents of the DATE header field.
toAddrs contains lowercase TO and CC recipient email addresses, comma separated, with duplicates removed, and sorted 
    in ascending order.  The BCC addresses are NOT included.

(After calling this method, the LastErrorText property can be examined to see the string that was hashed.)
The 16-byte MD5 hash is returned as an encoded string. The encoding determines the encoding: base64, hex, url, etc. If bFold is TRUE, then the 16-byte MD5 hash is folded to 8 bytes with an XOR to produce a shorter key.

Returns TRUE for success, FALSE for failure.

HCkEmailW CkEmailW_CreateDsn(HCkEmailW cHandle, const wchar_t *humanReadableMessage, const wchar_t *xmlStatusFields, BOOL bHeaderOnly);

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

Returns NULL on failure

Create DSN (Delivery Status Notification) Email

HCkEmailW CkEmailW_CreateForward(HCkEmailW cHandle);

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.

Returns NULL on failure

HCkEmailW CkEmailW_CreateMdn(HCkEmailW cHandle, const wchar_t *humanReadableMessage, const wchar_t *xmlStatusFields, BOOL bHeaderOnly);

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

Returns NULL on failure

Create MDN (Message Disposition Notification) Email

HCkEmailW CkEmailW_CreateReply(HCkEmailW cHandle);

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.

Note: Attachments are not included in the returned reply email. However, attached messages are included. If an application does not wish to include the attached messages in a reply email, they can be removed by calling RemoveAttachedMessages on the reply email object.

Returns NULL on failure

BOOL CkEmailW_CreateTempMht(HCkEmailW cHandle, const wchar_t *inFilename, const wchar_t *outPath);

const wchar_t *CkEmailW_createTempMht(HCkEmailW cHandle, const wchar_t *inFilename);

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 TRUE for success, FALSE for failure.

void CkEmailW_DropAttachments(HCkEmailW cHandle);

Removes all attachments from the email.

void CkEmailW_DropRelatedItem(HCkEmailW cHandle, int index);

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.

void CkEmailW_DropRelatedItems(HCkEmailW cHandle);

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.

BOOL CkEmailW_DropSingleAttachment(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

HCkCertW CkEmailW_FindIssuer(HCkEmailW cHandle, HCkCertW cert);

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

Returns NULL on failure

BOOL CkEmailW_GenerateFilename(HCkEmailW cHandle, const wchar_t *outStrFilename);

const wchar_t *CkEmailW_generateFilename(HCkEmailW cHandle);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAlternativeBody(HCkEmailW cHandle, int index, const wchar_t *outStrBody);

const wchar_t *CkEmailW_getAlternativeBody(HCkEmailW cHandle, int index);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAlternativeBodyBd(HCkEmailW cHandle, int index, HCkBinDataW binData);

Introduced in version 9.5.0.67

Returns contents of the Nth alternative body to binData. The 1st alternative body is at index 0. This method should only be called when the NumAlternatives property has a value greater than 0.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAlternativeBodyByContentType(HCkEmailW cHandle, const wchar_t *contentType, const wchar_t *outStr);

const wchar_t *CkEmailW_getAlternativeBodyByContentType(HCkEmailW cHandle, const wchar_t *contentType);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAlternativeContentType(HCkEmailW cHandle, int index, const wchar_t *outStrContentType);

const wchar_t *CkEmailW_getAlternativeContentType(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAltHeaderField(HCkEmailW cHandle, int index, const wchar_t *fieldName, const wchar_t *outStr);

const wchar_t *CkEmailW_getAltHeaderField(HCkEmailW cHandle, int index, const wchar_t *fieldName);

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

Returns TRUE for success, FALSE for failure.

HCkEmailW CkEmailW_GetAttachedMessage(HCkEmailW cHandle, int index);

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.

Returns NULL on failure

Load .eml and Examine the Structure, Attachments, and Related Items

BOOL CkEmailW_GetAttachedMessageAttr(HCkEmailW cHandle, int index, const wchar_t *fieldName, const wchar_t *attrName, const wchar_t *outStr);

const wchar_t *CkEmailW_getAttachedMessageAttr(HCkEmailW cHandle, int index, const wchar_t *fieldName, const wchar_t *attrName);

Introduced in version 9.5.0.41

Returns a header field attribute value for the Nth attached (embedded) email. For example, to get the value of the "name" attribute in the Content-Type header for the 1st attached message:

Content-Type: message/rfc822; name="md75000024149.eml"
then the method arguments should contain the values 0, "Content-Type", "name".

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAttachedMessageFilename(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getAttachedMessageFilename(HCkEmailW cHandle, int index);

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.

Important: The attached message filename is only present if the Content-Disposition header exists AND contains a "filename" attribute. If questions arise, one could open the email in a text editor to examine the MIME sub-header for the attached message (where the Content-Type = "message/rfc822"). For example, here is a sub-header that has a filename:

Content-Type: message/rfc822; name="GetAttachedMessageAttr.eml"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="GetAttachedMessageAttr.eml"
Here is an attached message sub-header that does NOT have a filename:
Content-Type: message/rfc822
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAttachmentAttr(HCkEmailW cHandle, int index, const wchar_t *fieldName, const wchar_t *attrName, const wchar_t *outStr);

const wchar_t *CkEmailW_getAttachmentAttr(HCkEmailW cHandle, int index, const wchar_t *fieldName, const wchar_t *attrName);

Introduced in version 9.5.0.41

Returns a header field attribute value from the header field of the Nth attachment.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAttachmentBd(HCkEmailW cHandle, int index, HCkBinDataW binData);

Introduced in version 9.5.0.67

Copies an attachment's binary data into binData. The first attachment is at index 0.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAttachmentContentID(HCkEmailW cHandle, int index, const wchar_t *outStrContentID);

const wchar_t *CkEmailW_getAttachmentContentID(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

Load .eml and Examine the Structure, Attachments, and Related Items

BOOL CkEmailW_GetAttachmentContentType(HCkEmailW cHandle, int index, const wchar_t *outStrContentType);

const wchar_t *CkEmailW_getAttachmentContentType(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

Load .eml and Examine the Structure, Attachments, and Related Items

BOOL CkEmailW_GetAttachmentData(HCkEmailW cHandle, int index, const unsigned char * outData);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAttachmentFilename(HCkEmailW cHandle, int index, const wchar_t *outStrFilename);

const wchar_t *CkEmailW_getAttachmentFilename(HCkEmailW cHandle, int index);

Retrieves an attachment's filename.

Returns TRUE for success, FALSE for failure.

Understanding IMAP Email Attachments

Load .eml and Examine the Structure, Attachments, and Related Items

BOOL CkEmailW_GetAttachmentHeader(HCkEmailW cHandle, int attachIndex, const wchar_t *fieldName, const wchar_t *outFieldValue);

const wchar_t *CkEmailW_getAttachmentHeader(HCkEmailW cHandle, int attachIndex, const wchar_t *fieldName);

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

Returns TRUE for success, FALSE for failure.

Load .eml and Examine the Structure, Attachments, and Related Items

int CkEmailW_GetAttachmentSize(HCkEmailW cHandle, int index);

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.

Load .eml and Examine the Structure, Attachments, and Related Items

BOOL CkEmailW_GetAttachmentString(HCkEmailW cHandle, int index, const wchar_t *charset, const wchar_t *outStr);

const wchar_t *CkEmailW_getAttachmentString(HCkEmailW cHandle, int index, const wchar_t *charset);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetAttachmentStringCrLf(HCkEmailW cHandle, int index, const wchar_t *charset, const wchar_t *outStrData);

const wchar_t *CkEmailW_getAttachmentStringCrLf(HCkEmailW cHandle, int index, const wchar_t *charset);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetBcc(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getBcc(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetBccAddr(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getBccAddr(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetBccName(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getBccName(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetCC(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getCC(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

Getting TO / CC Email Recipients

BOOL CkEmailW_GetCcAddr(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getCcAddr(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetCcName(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getCcName(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetDeliveryStatusInfo(HCkEmailW cHandle, const wchar_t *fieldName, const wchar_t *outFieldValue);

const wchar_t *CkEmailW_getDeliveryStatusInfo(HCkEmailW cHandle, const wchar_t *fieldName);

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

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 TRUE for success, FALSE for failure.

Load .eml and Examine the Structure, Attachments, and Related Items

HCkEmailW CkEmailW_GetDigest(HCkEmailW cHandle, int index);

Introduced in version 9.5.0.66

Returns an digest contained within a multipart/digest as an email object. The 1st digest is at index 0. Use the NumDigests property to get the number of digests available.

Note: This example requires Chilkat v9.5.0.66 or greater.

Returns NULL on failure

Parsing a Multipart/Digest Email

HCkStringArrayW CkEmailW_GetDsnFinalRecipients(HCkEmailW cHandle);

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

Returns NULL on failure

Load .eml and Examine the Structure, Attachments, and Related Items

HCkDateTimeW CkEmailW_GetDt(HCkEmailW cHandle);

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

Returns NULL on failure

Get Email Date/Time

HCkCertW CkEmailW_GetEncryptCert(HCkEmailW cHandle);

Returns the certificate that was previously set by SetEncryptCert.

Returns NULL on failure

HCkCertW CkEmailW_GetEncryptedByCert(HCkEmailW cHandle);

Returns the certificate associated with a received encrypted email.

Returns NULL on failure

BOOL CkEmailW_GetFileContent(HCkEmailW cHandle, const wchar_t *path, const unsigned char * outData);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetHeaderField(HCkEmailW cHandle, const wchar_t *fieldName, const wchar_t *outStrFieldData);

const wchar_t *CkEmailW_getHeaderField(HCkEmailW cHandle, const wchar_t *fieldName);

Returns the value of a header field.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetHeaderFieldName(HCkEmailW cHandle, int index, const wchar_t *outStrFieldName);

const wchar_t *CkEmailW_getHeaderFieldName(HCkEmailW cHandle, int index);

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.

The 1st header field is at index 0. (All Chilkat indexing is 0-based.)

Returns TRUE for success, FALSE for failure.

Email Received Header Fields

BOOL CkEmailW_GetHeaderFieldValue(HCkEmailW cHandle, int index, const wchar_t *outStrFieldValue);

const wchar_t *CkEmailW_getHeaderFieldValue(HCkEmailW cHandle, int index);

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

The 1st header field is at index 0, the last header field is at index NumHeaderFields-1. (All Chilkat indexing is 0-based.)

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetHtmlBody(HCkEmailW cHandle, const wchar_t *outStrBody);

const wchar_t *CkEmailW_getHtmlBody(HCkEmailW cHandle);

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

Returns TRUE for success, FALSE for failure.

int CkEmailW_GetImapUid(HCkEmailW cHandle);

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.

Note:If an email was downloaded from the IMAP server in a way such that the UID is not received, then there will be no "ckx-imap-uid" header field and this method would return -1. For example, if emails are downloaded by sequence numbers via the Imap.FetchSequence method, then UIDs are not used and therefore the email object will not contain this information.

HCkStringArrayW CkEmailW_GetLinkedDomains(HCkEmailW cHandle);

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

Returns NULL on failure

BOOL CkEmailW_GetMbHeaderField(HCkEmailW cHandle, const wchar_t *fieldName, const wchar_t *charset, const unsigned char * outBytes);

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.

The 1st header field is at index 0. (All Chilkat indexing is 0-based.)

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetMbHtmlBody(HCkEmailW cHandle, const wchar_t *charset, const unsigned char * outData);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_GetMbPlainTextBody(HCkEmailW cHandle, const wchar_t *charset, const unsigned char * outData);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetMime(HCkEmailW cHandle, const wchar_t *outStrMime);

const wchar_t *CkEmailW_getMime(HCkEmailW cHandle);

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

Returns TRUE for success, FALSE for failure.

Note About Safeguarding 8bit and Binary MIME Bodies when Getting MIME as a String

BOOL CkEmailW_GetMimeBd(HCkEmailW cHandle, HCkBinDataW bindat);

Introduced in version 9.5.0.62

Return the email as binary MIME containing the email header, body (or bodies), related items (if any), and all attachments. The MIME is appended to the existing contents (if any) of bindat.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetMimeBinary(HCkEmailW cHandle, const unsigned char * outBytes);

Returns the full MIME of an email.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetMimeSb(HCkEmailW cHandle, HCkStringBuilderW sb);

Introduced in version 9.5.0.62

Return the email as MIME text containing the email header, body (or bodies), related items (if any), and all attachments. The MIME is appended to the existing contents (if any) of sb.

Returns TRUE for success, FALSE for failure.

Load MIME Object from Email Object

BOOL CkEmailW_GetNthBinaryPartOfType(HCkEmailW cHandle, int index, const wchar_t *contentType, BOOL inlineOnly, BOOL excludeAttachments, const unsigned char * outBytes);

Introduced in version 9.5.0.44

Returns the binary bytes of the Nth MIME sub-part having a specified content type (such as "application/pdf". Indexing begins at 0. Call GetNumPartsOfType to find out how many MIME sub-parts exist for any given content type. If inlineOnly is TRUE, then only MIME sub-parts having a content-disposition of "inline" are included. If excludeAttachments is TRUE, then MIME sub-parts having a content-disposition of "attachment" are excluded.

Note: If the email was downloaded as header-only, it will not contain all the parts of the full email. Also, if downloaded from IMAP excluding attachments, those parts that are the attachments will (of course) be missing.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetNthTextPartOfType(HCkEmailW cHandle, int index, const wchar_t *contentType, BOOL inlineOnly, BOOL excludeAttachments, const wchar_t *outStr);

const wchar_t *CkEmailW_getNthTextPartOfType(HCkEmailW cHandle, int index, const wchar_t *contentType, BOOL inlineOnly, BOOL excludeAttachments);

Introduced in version 9.5.0.44

Returns the text of the Nth MIME sub-part having a specified content type (such as "text/plain". Indexing begins at 0. Call GetNumPartsOfType to find out how many MIME sub-parts exist for any given content type. If inlineOnly is TRUE, then only MIME sub-parts having a content-disposition of "inline" are included. If excludeAttachments is TRUE, then MIME sub-parts having a content-disposition of "attachment" are excluded.

Note: If the email was downloaded as header-only, it will not contain all the parts of the full email. Also, if downloaded from IMAP excluding attachments, those parts that are the attachments will (of course) be missing.

Returns TRUE for success, FALSE for failure.

int CkEmailW_GetNumPartsOfType(HCkEmailW cHandle, const wchar_t *contentType, BOOL inlineOnly, BOOL excludeAttachments);

Introduced in version 9.5.0.44

Returns the number of MIME sub-parts within the email having a specified content type (such as "text/plain"). If inlineOnly is TRUE, then only MIME sub-parts having a content-disposition of "inline" are included. If excludeAttachments is TRUE, then MIME sub-parts having a content-disposition of "attachment" are excluded.

Note: If the email was downloaded as header-only, it will not contain all the parts of the full email. Also, if downloaded from IMAP excluding attachments, those parts that are the attachments will (of course) be missing.

BOOL CkEmailW_GetPlainTextBody(HCkEmailW cHandle, const wchar_t *outStrBody);

const wchar_t *CkEmailW_getPlainTextBody(HCkEmailW cHandle);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetRelatedAttr(HCkEmailW cHandle, int index, const wchar_t *fieldName, const wchar_t *attrName, const wchar_t *outStr);

const wchar_t *CkEmailW_getRelatedAttr(HCkEmailW cHandle, int index, const wchar_t *fieldName, const wchar_t *attrName);

Introduced in version 9.5.0.41

Returns a header field attribute value from the header field of the Nth related item.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetRelatedContentID(HCkEmailW cHandle, int index, const wchar_t *outStrContentID);

const wchar_t *CkEmailW_getRelatedContentID(HCkEmailW cHandle, int index);

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 TRUE for success, FALSE for failure.

Load .eml and Examine the Structure, Attachments, and Related Items

BOOL CkEmailW_GetRelatedContentLocation(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getRelatedContentLocation(HCkEmailW cHandle, int index);

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 TRUE for success, FALSE for failure.

Load .eml and Examine the Structure, Attachments, and Related Items

BOOL CkEmailW_GetRelatedContentType(HCkEmailW cHandle, int index, const wchar_t *outStrContentType);

const wchar_t *CkEmailW_getRelatedContentType(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

Load .eml and Examine the Structure, Attachments, and Related Items

BOOL CkEmailW_GetRelatedData(HCkEmailW cHandle, int index, const unsigned char * outBuffer);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetRelatedFilename(HCkEmailW cHandle, int index, const wchar_t *outStrFilename);

const wchar_t *CkEmailW_getRelatedFilename(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

Load .eml and Examine the Structure, Attachments, and Related Items

BOOL CkEmailW_GetRelatedString(HCkEmailW cHandle, int index, const wchar_t *charset, const wchar_t *outStrData);

const wchar_t *CkEmailW_getRelatedString(HCkEmailW cHandle, int index, const wchar_t *charset);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_GetRelatedStringCrLf(HCkEmailW cHandle, int index, const wchar_t *charset, const wchar_t *outStr);

const wchar_t *CkEmailW_getRelatedStringCrLf(HCkEmailW cHandle, int index, const wchar_t *charset);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_GetReplacePattern(HCkEmailW cHandle, int index, const wchar_t *outStrPattern);

const wchar_t *CkEmailW_getReplacePattern(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetReplaceString(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getReplaceString(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetReplaceString2(HCkEmailW cHandle, const wchar_t *pattern, const wchar_t *outStr);

const wchar_t *CkEmailW_getReplaceString2(HCkEmailW cHandle, const wchar_t *pattern);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetReport(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getReport(HCkEmailW cHandle, int index);

(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 TRUE for success, FALSE for failure.

Load .eml and Examine the Structure, Attachments, and Related Items

HCkCertW CkEmailW_GetSignedByCert(HCkEmailW cHandle);

Return the certificate used to digitally sign this email.

Returns NULL on failure

POP3 Verify Signed (S/MIME) Email

HCkCertChainW CkEmailW_GetSignedByCertChain(HCkEmailW cHandle);

Introduced in version 9.5.0.40

Return the full certificate chain of the certificate used to digitally sign this email.

Returns NULL on failure

HCkCertW CkEmailW_GetSigningCert(HCkEmailW cHandle);

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.

Returns NULL on failure

BOOL CkEmailW_GetTo(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getTo(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

Getting TO / CC Email Recipients

BOOL CkEmailW_GetToAddr(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getToAddr(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetToName(HCkEmailW cHandle, int index, const wchar_t *outStr);

const wchar_t *CkEmailW_getToName(HCkEmailW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_GetXml(HCkEmailW cHandle, const wchar_t *outStrXml);

const wchar_t *CkEmailW_getXml(HCkEmailW cHandle);

Convert the email object to an XML document in memory

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_HasHeaderMatching(HCkEmailW cHandle, const wchar_t *fieldName, const wchar_t *valuePattern, BOOL caseSensitive);

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

BOOL CkEmailW_HasHtmlBody(HCkEmailW cHandle);

Returns true if the email has an HTML body.

BOOL CkEmailW_HasPlainTextBody(HCkEmailW cHandle);

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

BOOL CkEmailW_IsMultipartReport(HCkEmailW cHandle);

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

BOOL CkEmailW_LoadEml(HCkEmailW cHandle, const wchar_t *mimePath);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_LoadTaskResult(HCkEmailW cHandle, HCkTaskW task);

Introduced in version 9.5.0.52

Loads the email object from a completed asynchronous task.

Returns TRUE for success, FALSE for failure.

Async Methods Returning an Object

BOOL CkEmailW_LoadXml(HCkEmailW cHandle, const wchar_t *xmlPath);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_LoadXmlString(HCkEmailW cHandle, const wchar_t *xmlStr);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_QEncodeBytes(HCkEmailW cHandle, const unsigned char * inData, const wchar_t *charset, const wchar_t *outEncodedStr);

const wchar_t *CkEmailW_qEncodeBytes(HCkEmailW cHandle, const unsigned char * inData, const wchar_t *charset);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_QEncodeString(HCkEmailW cHandle, const wchar_t *str, const wchar_t *charset, const wchar_t *outEncodedStr);

const wchar_t *CkEmailW_qEncodeString(HCkEmailW cHandle, const wchar_t *str, const wchar_t *charset);

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 TRUE for success, FALSE for failure.

void CkEmailW_RemoveAttachedMessage(HCkEmailW cHandle, int idx);

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

void CkEmailW_RemoveAttachedMessages(HCkEmailW cHandle);

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

void CkEmailW_RemoveAttachmentPaths(HCkEmailW cHandle);

Removes path information from all attachment filenames.

void CkEmailW_RemoveHeaderField(HCkEmailW cHandle, const wchar_t *fieldName);

Removes by name all occurrences of a header field.

void CkEmailW_RemoveHtmlAlternative(HCkEmailW cHandle);

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

void CkEmailW_RemovePlainTextAlternative(HCkEmailW cHandle);

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

BOOL CkEmailW_SaveAllAttachments(HCkEmailW cHandle, const wchar_t *dirPath);

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.

Note: Email attachment filenames can be renamed or modified prior to saving. The number of attachments is available in the NumAttachments property. An application can loop over the attachments to get the filename for each by calling GetAttachmentFilename(index). Each attachment's filename can be set by calling SetAttachmentFilename(index, newFilename).

Returns TRUE for success, FALSE for failure.

Example: Download and Save Email Attachments (POP3)

Understanding IMAP Email Attachments

BOOL CkEmailW_SaveAttachedFile(HCkEmailW cHandle, int index, const wchar_t *dirPath);

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 TRUE for success, FALSE for failure.

Example: Download and Save Email Attachments (POP3)

BOOL CkEmailW_SaveEml(HCkEmailW cHandle, const wchar_t *emlFilePath);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_SaveLastError(HCkEmailW cHandle, const wchar_t *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_SaveRelatedItem(HCkEmailW cHandle, int index, const wchar_t *dirPath);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_SaveXml(HCkEmailW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_SetAttachmentCharset(HCkEmailW cHandle, int index, const wchar_t *charset);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_SetAttachmentDisposition(HCkEmailW cHandle, int index, const wchar_t *disposition);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_SetAttachmentFilename(HCkEmailW cHandle, int index, const wchar_t *filename);

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

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_SetBinaryBody(HCkEmailW cHandle, const unsigned char * byteData, const wchar_t *contentType, const wchar_t *disposition, const wchar_t *filename);

Introduced in version 9.5.0.44

Sets the main body of the email to binary content of any type. The disposition can be an empty string, "inline", or "attachment". If a filename is specified, the disposition must be non-empty because the filename is an attribute of the content-disposition header field.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_SetCSP(HCkEmailW cHandle, HCkCspW csp);

(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 TRUE for success, FALSE for failure.

BOOL CkEmailW_SetDecryptCert(HCkEmailW cHandle, HCkCertW cert);

Introduced in version 9.5.0.57

Allows for a certificate to be explicity provided for decryption. When an email object is loaded via any method, such as LoadEml, SetFromMimeText, SetFromMimeBytes, etc., security layers (signatures and encryption) are automatically unwrapped. This method could be called prior to calling a method that loads the email.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_SetDecryptCert2(HCkEmailW cHandle, HCkCertW cert, HCkPrivateKeyW key);

Introduced in version 9.5.0.57

Allows for a certificate and private key to be explicity specified for decryption. When an email object is loaded via any method, such as LoadEml, SetFromMimeText, SetFromMimeBytes, etc., security layers (signatures and encryption) are automatically unwrapped. Decryption requires a private key. On Windows-based systems, the private key is often pre-installed and nothing need be done to provide it because Chilkat will automatically find it and use it. However, if not on a Windows system, or if the private key was not pre-installed, then it can be provided by this method, or via the AddPfxSourceFile / AddPfxSourceData methods.

Returns TRUE for success, FALSE for failure.

Multipart/signed Email Handling

BOOL CkEmailW_SetDt(HCkEmailW cHandle, HCkDateTimeW dt);

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

Returns TRUE for success, FALSE for failure.

Set the Email Date Header to the Current System Date/Time

void CkEmailW_SetEdifactBody(HCkEmailW cHandle, const wchar_t *message, const wchar_t *name, const wchar_t *filename, const wchar_t *charset);

Introduced in version 9.5.0.28

Creates a typical email used to send EDIFACT messages. Does the following:

  1. Sets the email body to the EDIFACT message passed in message.
  2. Sets the Content-Transfer-Encoding to Base64.
  3. Set the Content-Type equal to "application/EDIFACT".
  4. Sets the Content-Type header's name attribute to name.
  5. Sets the Content-Disposition equal to "attachment".
  6. Sets the Content-Disposition's "filename" attribute equal to filename.
  7. The EDIFACT message is converted to the charset indicated by charset, and encoded using Base64 in the email body.
The email's subject, recipients, FROM address, and other headers are left unmodified.

BOOL CkEmailW_SetEncryptCert(HCkEmailW cHandle, HCkCertW cert);

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 TRUE for success, FALSE for failure.

Using a .cer Certificate File for Encrypted Email

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

BOOL CkEmailW_SetFromMimeBd(HCkEmailW cHandle, HCkBinDataW bindat);

Introduced in version 9.5.0.62

Loads an email with the MIME stored in a BinData object. The contents of the email object are completely replaced.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_SetFromMimeBytes(HCkEmailW cHandle, const unsigned char * mimeBytes);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_SetFromMimeBytes2(HCkEmailW cHandle, const unsigned char * mimeBytes, const wchar_t *charset);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_SetFromMimeSb(HCkEmailW cHandle, HCkStringBuilderW sb);

Introduced in version 9.5.0.62

Loads an email with the MIME stored in a StringBuilder object. The contents of the email object are completely replaced.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_SetFromMimeText(HCkEmailW cHandle, const wchar_t *mimeText);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_SetFromXmlText(HCkEmailW cHandle, const wchar_t *xmlStr);

Loads an email from an XML string.

Returns TRUE for success, FALSE for failure.

void CkEmailW_SetHtmlBody(HCkEmailW cHandle, const wchar_t *html);

Sets the HTML body of an email.

Send HTML Email with Image to iPhone

BOOL CkEmailW_SetMbHtmlBody(HCkEmailW cHandle, const wchar_t *charset, const unsigned char * inData);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_SetMbPlainTextBody(HCkEmailW cHandle, const wchar_t *charset, const unsigned char * inData);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_SetRelatedFilename(HCkEmailW cHandle, int index, const wchar_t *path);

Sets the filename for a related item within the email.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_SetReplacePattern(HCkEmailW cHandle, const wchar_t *pattern, const wchar_t *replaceString);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_SetSigningCert(HCkEmailW cHandle, HCkCertW cert);

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 TRUE for success, FALSE for failure.

Sign Email using RSASSA-PSS with SHA256

BOOL CkEmailW_SetSigningCert2(HCkEmailW cHandle, HCkCertW cert, HCkPrivateKeyW key);

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 TRUE for success, FALSE for failure.

void CkEmailW_SetTextBody(HCkEmailW cHandle, const wchar_t *bodyText, const wchar_t *contentType);

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.

BOOL CkEmailW_UidlEquals(HCkEmailW cHandle, HCkEmailW e);

True if the caller email has a UIDL that equals the email passed in the argument.

BOOL CkEmailW_UnpackHtml(HCkEmailW cHandle, const wchar_t *unpackDir, const wchar_t *htmlFilename, const wchar_t *partsSubdir);

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 TRUE for success, FALSE for failure.

void CkEmailW_UnSpamify(HCkEmailW cHandle);

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

BOOL CkEmailW_UnzipAttachments(HCkEmailW cHandle);

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 TRUE for success, FALSE for failure.

BOOL CkEmailW_UseCertVault(HCkEmailW cHandle, HCkXmlCertVaultW vault);

Introduced in version 9.5.0.40

Adds an XML certificate vault to the object's internal list of sources to be searched for certificates and private keys when encrypting/decrypting or signing/verifying. Unlike the AddPfxSourceData and AddPfxSourceFile methods, only a single XML certificate vault can be used. If UseCertVault is called multiple times, only the last certificate vault will be used, as each call to UseCertVault will replace the certificate vault provided in previous calls.

Returns TRUE for success, FALSE for failure.

BOOL CkEmailW_ZipAttachments(HCkEmailW cHandle, const wchar_t *zipFilename);

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

Returns TRUE for success, FALSE for failure.