CkEmail Perl Reference Documentation

CkEmail

Current Version: 9.5.0.75

Represents a complete Email object.

Object Creation

$obj = chilkat::CkEmail->new();

Properties

Body
# $strVal is a string
# $ckStr is a CkString
$email->get_Body($ckStr);
$strVal = $email->body();
$email->put_Body($strVal);

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.

top
BounceAddress
# $strVal is a string
# $ckStr is a CkString
$email->get_BounceAddress($ckStr);
$strVal = $email->bounceAddress();
$email->put_BounceAddress($strVal);

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.

More Information and Examples
top
Charset
# $strVal is a string
# $ckStr is a CkString
$email->get_Charset($ckStr);
$strVal = $email->charset();
$email->put_Charset($strVal);

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.

More Information and Examples
top
DebugLogFilePath
# $strVal is a string
# $ckStr is a CkString
$email->get_DebugLogFilePath($ckStr);
$strVal = $email->debugLogFilePath();
$email->put_DebugLogFilePath($strVal);

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.

top
Decrypted
# $boolVal is a boolean
$boolVal = $email->get_Decrypted();

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

top
EmailDateStr
# $strVal is a string
# $ckStr is a CkString
$email->get_EmailDateStr($ckStr);
$strVal = $email->emailDateStr();
$email->put_EmailDateStr($strVal);

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

top
EncryptedBy
# $strVal is a string
# $ckStr is a CkString
$email->get_EncryptedBy($ckStr);
$strVal = $email->encryptedBy();

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

top
FileDistList
# $strVal is a string
# $ckStr is a CkString
$email->get_FileDistList($ckStr);
$strVal = $email->fileDistList();
$email->put_FileDistList($strVal);

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

top
From
# $strVal is a string
# $ckStr is a CkString
$email->get_From($ckStr);
$strVal = $email->ck_from();
$email->put_From($strVal);

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.

top
FromAddress
# $strVal is a string
# $ckStr is a CkString
$email->get_FromAddress($ckStr);
$strVal = $email->fromAddress();
$email->put_FromAddress($strVal);

The email address of the sender.

top
FromName
# $strVal is a string
# $ckStr is a CkString
$email->get_FromName($ckStr);
$strVal = $email->fromName();
$email->put_FromName($strVal);

The name of the sender.

top
Header
# $strVal is a string
# $ckStr is a CkString
$email->get_Header($ckStr);
$strVal = $email->header();

The complete MIME header of the email.

top
Language
# $strVal is a string
# $ckStr is a CkString
$email->get_Language($ckStr);
$strVal = $email->language();

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.

top
LastErrorHtml
# $strVal is a string
# $ckStr is a CkString
$email->get_LastErrorHtml($ckStr);
$strVal = $email->lastErrorHtml();

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.

top
LastErrorText
# $strVal is a string
# $ckStr is a CkString
$email->get_LastErrorText($ckStr);
$strVal = $email->lastErrorText();

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.

top
LastErrorXml
# $strVal is a string
# $ckStr is a CkString
$email->get_LastErrorXml($ckStr);
$strVal = $email->lastErrorXml();

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.

top
LastMethodSuccess
# $boolVal is a boolean
$boolVal = $email->get_LastMethodSuccess();
$email->put_LastMethodSuccess($boolVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LocalDateStr
# $strVal is a string
# $ckStr is a CkString
$email->get_LocalDateStr($ckStr);
$strVal = $email->localDateStr();
$email->put_LocalDateStr($strVal);

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

top
Mailer
# $strVal is a string
# $ckStr is a CkString
$email->get_Mailer($ckStr);
$strVal = $email->mailer();
$email->put_Mailer($strVal);

Identifies the email software that sent the email.

top
NumAlternatives
# $intVal is an integer
$intVal = $email->get_NumAlternatives();

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.

top
NumAttachedMessages
# $intVal is an integer
$intVal = $email->get_NumAttachedMessages();

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.

top
NumAttachments
# $intVal is an integer
$intVal = $email->get_NumAttachments();

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.

top
NumBcc
# $intVal is an integer
$intVal = $email->get_NumBcc();

The number of blind carbon-copy email recipients.

More Information and Examples
top
NumCC
# $intVal is an integer
$intVal = $email->get_NumCC();

The number of carbon-copy email recipients.

More Information and Examples
top
NumDaysOld
# $intVal is an integer
$intVal = $email->get_NumDaysOld();

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

top
NumDigests
# $intVal is an integer
$intVal = $email->get_NumDigests();
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.

More Information and Examples
top
NumHeaderFields
# $intVal is an integer
$intVal = $email->get_NumHeaderFields();

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

top
NumRelatedItems
# $intVal is an integer
$intVal = $email->get_NumRelatedItems();

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.

top
NumReplacePatterns
# $intVal is an integer
$intVal = $email->get_NumReplacePatterns();

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.

top
NumReports
# $intVal is an integer
$intVal = $email->get_NumReports();

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

top
NumTo
# $intVal is an integer
$intVal = $email->get_NumTo();

The number of direct email recipients.

More Information and Examples
top
OaepHash
# $strVal is a string
# $ckStr is a CkString
$email->get_OaepHash($ckStr);
$strVal = $email->oaepHash();
$email->put_OaepHash($strVal);
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",

top
OaepMgfHash
# $strVal is a string
# $ckStr is a CkString
$email->get_OaepMgfHash($ckStr);
$strVal = $email->oaepMgfHash();
$email->put_OaepMgfHash($strVal);
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",

top
OaepPadding
# $boolVal is a boolean
$boolVal = $email->get_OaepPadding();
$email->put_OaepPadding($boolVal);
Introduced in version 9.5.0.67

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

top
OverwriteExisting
# $boolVal is a boolean
$boolVal = $email->get_OverwriteExisting();
$email->put_OverwriteExisting($boolVal);

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

top
Pkcs7CryptAlg
# $strVal is a string
# $ckStr is a CkString
$email->get_Pkcs7CryptAlg($ckStr);
$strVal = $email->pkcs7CryptAlg();
$email->put_Pkcs7CryptAlg($strVal);

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

top
Pkcs7KeyLength
# $intVal is an integer
$intVal = $email->get_Pkcs7KeyLength();
$email->put_Pkcs7KeyLength($intVal);

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.

top
PreferredCharset
# $strVal is a string
# $ckStr is a CkString
$email->get_PreferredCharset($ckStr);
$strVal = $email->preferredCharset();
$email->put_PreferredCharset($strVal);

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.

More Information and Examples
top
PrependHeaders
# $boolVal is a boolean
$boolVal = $email->get_PrependHeaders();
$email->put_PrependHeaders($boolVal);

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

top
ReceivedEncrypted
# $boolVal is a boolean
$boolVal = $email->get_ReceivedEncrypted();

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

top
ReceivedSigned
# $boolVal is a boolean
$boolVal = $email->get_ReceivedSigned();

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

More Information and Examples
top
ReplyTo
# $strVal is a string
# $ckStr is a CkString
$email->get_ReplyTo($ckStr);
$strVal = $email->replyTo();
$email->put_ReplyTo($strVal);

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

top
ReturnReceipt
# $boolVal is a boolean
$boolVal = $email->get_ReturnReceipt();
$email->put_ReturnReceipt($boolVal);

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

top
SendEncrypted
# $boolVal is a boolean
$boolVal = $email->get_SendEncrypted();
$email->put_SendEncrypted($boolVal);

Set to 1 if this email should be sent encrypted.

top
Sender
# $strVal is a string
# $ckStr is a CkString
$email->get_Sender($ckStr);
$strVal = $email->sender();
$email->put_Sender($strVal);
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.

More Information and Examples
top
SendSigned
# $boolVal is a boolean
$boolVal = $email->get_SendSigned();
$email->put_SendSigned($boolVal);

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

top
SignaturesValid
# $boolVal is a boolean
$boolVal = $email->get_SignaturesValid();

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

More Information and Examples
top
SignedBy
# $strVal is a string
# $ckStr is a CkString
$email->get_SignedBy($ckStr);
$strVal = $email->signedBy();

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.

top
SigningAlg
# $strVal is a string
# $ckStr is a CkString
$email->get_SigningAlg($ckStr);
$strVal = $email->signingAlg();
$email->put_SigningAlg($strVal);
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.

top
SigningHashAlg
# $strVal is a string
# $ckStr is a CkString
$email->get_SigningHashAlg($ckStr);
$strVal = $email->signingHashAlg();
$email->put_SigningHashAlg($strVal);

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

top
Size
# $intVal is an integer
$intVal = $email->get_Size();

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

top
Subject
# $strVal is a string
# $ckStr is a CkString
$email->get_Subject($ckStr);
$strVal = $email->subject();
$email->put_Subject($strVal);

The email subject.

top
Uidl
# $strVal is a string
# $ckStr is a CkString
$email->get_Uidl($ckStr);
$strVal = $email->uidl();

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.

top
UnpackUseRelPaths
# $boolVal is a boolean
$boolVal = $email->get_UnpackUseRelPaths();
$email->put_UnpackUseRelPaths($boolVal);

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

top
Utf8
# $boolVal is a boolean
$boolVal = $email->get_Utf8();
$email->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top
VerboseLogging
# $boolVal is a boolean
$boolVal = $email->get_VerboseLogging();
$email->put_VerboseLogging($boolVal);

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

top
Version
# $strVal is a string
# $ckStr is a CkString
$email->get_Version($ckStr);
$strVal = $email->version();

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

top

Methods

AddAttachmentBd
# $filename is a string
# $binData is a CkBinData
# $contentType is a string
$status = $email->AddAttachmentBd($filename, $binData, $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 1 for success, 0 for failure.

More Information and Examples
top
AddAttachmentHeader
# $index is an integer
# $fieldName is a string
# $fieldValue is a string
$email->AddAttachmentHeader($index, $fieldName, $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.

top
AddBcc
# $friendlyName is a string
# $emailAddress is a string
$status = $email->AddBcc($friendlyName, $emailAddress);

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

Returns 1 for success, 0 for failure.

top
AddCC
# $friendlyName is a string
# $emailAddress is a string
$status = $email->AddCC($friendlyName, $emailAddress);

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

Returns 1 for success, 0 for failure.

top
AddDataAttachment
# $fileName is a string
# $content is a CkByteData
$status = $email->AddDataAttachment($fileName, $content);

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

Returns 1 for success, 0 for failure.

top
AddDataAttachment2
# $fileName is a string
# $content is a CkByteData
# $contentType is a string
$status = $email->AddDataAttachment2($fileName, $content, $contentType);

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

Returns 1 for success, 0 for failure.

top
AddEncryptCert
# $cert is a CkCert
$status = $email->AddEncryptCert($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 1 for success, 0 for failure.

top
AddFileAttachment
# $path is a string
# $outStrContentType is a CkString (output)
$status = $email->AddFileAttachment($path, $outStr);
$retStr = $email->addFileAttachment($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 1 for success, 0 for failure.

More Information and Examples
top
AddFileAttachment2
# $path is a string
# $contentType is a string
$status = $email->AddFileAttachment2($path, $contentType);

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
AddHeaderField
# $fieldName is a string
# $fieldValue is a string
$email->AddHeaderField($fieldName, $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).

top
AddHeaderField2
# $fieldName is a string
# $fieldValue is a string
$email->AddHeaderField2($fieldName, $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.

top
AddHtmlAlternativeBody
# $body is a string
$status = $email->AddHtmlAlternativeBody($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 1 for success, 0 for failure.

More Information and Examples
top
AddiCalendarAlternativeBody
# $icalContent is a string
# $methodName is a string
$status = $email->AddiCalendarAlternativeBody($icalContent, $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 1 for success, 0 for failure.

top
AddMultipleBcc
# $commaSeparatedAddresses is a string
$status = $email->AddMultipleBcc($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 1 for success, 0 for failure.

top
AddMultipleCC
# $commaSeparatedAddresses is a string
$status = $email->AddMultipleCC($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 1 for success, 0 for failure.

top
AddMultipleTo
# $commaSeparatedAddresses is a string
$status = $email->AddMultipleTo($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 1 for success, 0 for failure.

top
AddPfxSourceData
# $pfxBytes is a CkByteData
# $pfxPassword is a string
$status = $email->AddPfxSourceData($pfxBytes, $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 1 for success, 0 for failure.

top
AddPfxSourceFile
# $pfxFilePath is a string
# $pfxPassword is a string
$status = $email->AddPfxSourceFile($pfxFilePath, $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 1 for success, 0 for failure.

top
AddPlainTextAlternativeBody
# $body is a string
$status = $email->AddPlainTextAlternativeBody($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 1 for success, 0 for failure.

More Information and Examples
top
AddRelatedBd
# $filename is a string
# $binData is a CkBinData
# $outStr is a CkString (output)
$status = $email->AddRelatedBd($filename, $binData, $outStr);
$retStr = $email->addRelatedBd($filename, $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 1 for success, 0 for failure.

More Information and Examples
top
AddRelatedBd2
# $binData is a CkBinData
# $fileNameInHtml is a string
$status = $email->AddRelatedBd2($binData, $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 1 for success, 0 for failure.

top
AddRelatedData
# $fileName is a string
# $inData is a CkByteData
# $outStr is a CkString (output)
$status = $email->AddRelatedData($fileName, $inData, $outStr);
$retStr = $email->addRelatedData($fileName, $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 1 for success, 0 for failure.

top
AddRelatedData2
# $inData is a CkByteData
# $fileNameInHtml is a string
$email->AddRelatedData2($inData, $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.

top
AddRelatedFile
# $path is a string
# $outStrContentID is a CkString (output)
$status = $email->AddRelatedFile($path, $outStr);
$retStr = $email->addRelatedFile($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 1 for success, 0 for failure.

top
AddRelatedFile2
# $filenameOnDisk is a string
# $filenameInHtml is a string
$status = $email->AddRelatedFile2($filenameOnDisk, $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 1 for success, 0 for failure.

top
AddRelatedHeader
# $index is an integer
# $fieldName is a string
# $fieldValue is a string
$email->AddRelatedHeader($index, $fieldName, $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.

top
AddRelatedString
# $nameInHtml is a string
# $str is a string
# $charset is a string
# $outCid is a CkString (output)
$status = $email->AddRelatedString($nameInHtml, $str, $charset, $outStr);
$retStr = $email->addRelatedString($nameInHtml, $str, $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 1 for success, 0 for failure.

top
AddRelatedString2
# $fileNameInHtml is a string
# $content is a string
# $charset is a string
$email->AddRelatedString2($fileNameInHtml, $content, $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.

top
AddStringAttachment
# $path is a string
# $content is a string
$status = $email->AddStringAttachment($path, $content);

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
AddStringAttachment2
# $path is a string
# $content is a string
# $charset is a string
$status = $email->AddStringAttachment2($path, $content, $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 1 for success, 0 for failure.

top
AddTo
# $friendlyName is a string
# $emailAddress is a string
$status = $email->AddTo($friendlyName, $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 1 for success, 0 for failure.

top
AesDecrypt
# $password is a string
$status = $email->AesDecrypt($password);

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

Returns 1 for success, 0 for failure.

top
AesEncrypt
# $password is a string
$status = $email->AesEncrypt($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 1 for success, 0 for failure.

top
AppendToBody
# $str is a string
$email->AppendToBody($str);

Appends a string to the plain-text body.

top
ApplyFixups
# $fixups is a string
$status = $email->ApplyFixups($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 1 for success, 0 for failure.

    top
AspUnpack
# $prefix is a string
# $saveDir is a string
# $urlPath is a string
# $cleanFiles is a boolean
$status = $email->AspUnpack($prefix, $saveDir, $urlPath, $cleanFiles);

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

Returns 1 for success, 0 for failure.

top
AspUnpack2
# $prefix is a string
# $saveDir is a string
# $urlPath is a string
# $cleanFiles is a boolean
# $outHtml is a CkByteData (output)
$status = $email->AspUnpack2($prefix, $saveDir, $urlPath, $cleanFiles, $outData);

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

Returns 1 for success, 0 for failure.

top
AttachMessage
# $mimeBytes is a CkByteData
$status = $email->AttachMessage($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 1 for success, 0 for failure.

top
BEncodeBytes
# $inData is a CkByteData
# $charset is a string
# $outEncodedStr is a CkString (output)
$status = $email->BEncodeBytes($inData, $charset, $outStr);
$retStr = $email->bEncodeBytes($inData, $charset);

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

Returns 1 for success, 0 for failure.

top
BEncodeString
# $str is a string
# $charset is a string
# $outEncodedStr is a CkString (output)
$status = $email->BEncodeString($str, $charset, $outStr);
$retStr = $email->bEncodeString($str, $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 1 for success, 0 for failure.

top
ClearBcc
$email->ClearBcc();

Clears the list of blind carbon-copy recipients.

top
ClearCC
$email->ClearCC();

Clears the list of carbon-copy recipients.

top
ClearEncryptCerts
$email->ClearEncryptCerts();

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

top
ClearTo
$email->ClearTo();

Clears the list of "to" recipients.

top
Clone
# returns a CkEmail
$ret_email = $email->Clone();

Creates and returns an identical copy of the Email object.

Returns null on failure

top
ComputeGlobalKey2
# $encoding is a string
# $bFold is a boolean
# $outStr is a CkString (output)
$status = $email->ComputeGlobalKey2($encoding, $bFold, $outStr);
$retStr = $email->computeGlobalKey2($encoding, $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 1, then the 16-byte MD5 hash is folded to 8 bytes with an XOR to produce a shorter key.

Returns 1 for success, 0 for failure.

top
CreateDsn
# returns a CkEmail
# $humanReadableMessage is a string
# $xmlStatusFields is a string
# $bHeaderOnly is a boolean
$ret_email = $email->CreateDsn($humanReadableMessage, $xmlStatusFields, $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

top
CreateForward
# returns a CkEmail
$ret_email = $email->CreateForward();

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

top
CreateMdn
# returns a CkEmail
# $humanReadableMessage is a string
# $xmlStatusFields is a string
# $bHeaderOnly is a boolean
$ret_email = $email->CreateMdn($humanReadableMessage, $xmlStatusFields, $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

top
CreateReply
# returns a CkEmail
$ret_email = $email->CreateReply();

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

top
CreateTempMht
# $inFilename is a string
# $outPath is a CkString (output)
$status = $email->CreateTempMht($inFilename, $outStr);
$retStr = $email->createTempMht($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 1 for success, 0 for failure.

top
DropAttachments
$email->DropAttachments();

Removes all attachments from the email.

top
DropRelatedItem
# $index is an integer
$email->DropRelatedItem($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.

top
DropRelatedItems
$email->DropRelatedItems();

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

top
DropSingleAttachment
# $index is an integer
$status = $email->DropSingleAttachment($index);

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

Returns 1 for success, 0 for failure.

top
FindIssuer
# returns a CkCert
# $cert is a CkCert
$ret_cert = $email->FindIssuer($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

top
GenerateFilename
# $outStrFilename is a CkString (output)
$status = $email->GenerateFilename($outStr);
$retStr = $email->generateFilename();

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

Returns 1 for success, 0 for failure.

top
GetAlternativeBody
# $index is an integer
# $outStrBody is a CkString (output)
$status = $email->GetAlternativeBody($index, $outStr);
$retStr = $email->getAlternativeBody($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 1 for success, 0 for failure.

top
GetAlternativeBodyBd
# $index is an integer
# $binData is a CkBinData
$status = $email->GetAlternativeBodyBd($index, $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 1 for success, 0 for failure.

top
GetAlternativeBodyByContentType
# $contentType is a string
# $outStr is a CkString (output)
$status = $email->GetAlternativeBodyByContentType($contentType, $outStr);
$retStr = $email->getAlternativeBodyByContentType($contentType);

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

Returns 1 for success, 0 for failure.

top
GetAlternativeContentType
# $index is an integer
# $outStrContentType is a CkString (output)
$status = $email->GetAlternativeContentType($index, $outStr);
$retStr = $email->getAlternativeContentType($index);

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

Returns 1 for success, 0 for failure.

top
GetAltHeaderField
# $index is an integer
# $fieldName is a string
# $outStr is a CkString (output)
$status = $email->GetAltHeaderField($index, $fieldName, $outStr);
$retStr = $email->getAltHeaderField($index, $fieldName);

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

Returns 1 for success, 0 for failure.

top
GetAttachedMessage
# returns a CkEmail
# $index is an integer
$ret_email = $email->GetAttachedMessage($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

top
GetAttachedMessageAttr
# $index is an integer
# $fieldName is a string
# $attrName is a string
# $outStr is a CkString (output)
$status = $email->GetAttachedMessageAttr($index, $fieldName, $attrName, $outStr);
$retStr = $email->getAttachedMessageAttr($index, $fieldName, $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 1 for success, 0 for failure.

top
GetAttachedMessageFilename
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetAttachedMessageFilename($index, $outStr);
$retStr = $email->getAttachedMessageFilename($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 1 for success, 0 for failure.

top
GetAttachmentAttr
# $index is an integer
# $fieldName is a string
# $attrName is a string
# $outStr is a CkString (output)
$status = $email->GetAttachmentAttr($index, $fieldName, $attrName, $outStr);
$retStr = $email->getAttachmentAttr($index, $fieldName, $attrName);
Introduced in version 9.5.0.41

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

Returns 1 for success, 0 for failure.

top
GetAttachmentBd
# $index is an integer
# $binData is a CkBinData
$status = $email->GetAttachmentBd($index, $binData);
Introduced in version 9.5.0.67

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

Returns 1 for success, 0 for failure.

top
GetAttachmentContentID
# $index is an integer
# $outStrContentID is a CkString (output)
$status = $email->GetAttachmentContentID($index, $outStr);
$retStr = $email->getAttachmentContentID($index);

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

Returns 1 for success, 0 for failure.

top
GetAttachmentContentType
# $index is an integer
# $outStrContentType is a CkString (output)
$status = $email->GetAttachmentContentType($index, $outStr);
$retStr = $email->getAttachmentContentType($index);

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

Returns 1 for success, 0 for failure.

top
GetAttachmentData
# $index is an integer
# $outData is a CkByteData (output)
$status = $email->GetAttachmentData($index, $outData);

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

Returns 1 for success, 0 for failure.

top
GetAttachmentFilename
# $index is an integer
# $outStrFilename is a CkString (output)
$status = $email->GetAttachmentFilename($index, $outStr);
$retStr = $email->getAttachmentFilename($index);

Retrieves an attachment's filename.

Returns 1 for success, 0 for failure.

top
GetAttachmentHeader
# $attachIndex is an integer
# $fieldName is a string
# $outFieldValue is a CkString (output)
$status = $email->GetAttachmentHeader($attachIndex, $fieldName, $outStr);
$retStr = $email->getAttachmentHeader($attachIndex, $fieldName);

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

Returns 1 for success, 0 for failure.

top
GetAttachmentSize
# $index is an integer
$retInt = $email->GetAttachmentSize($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.

top
GetAttachmentString
# $index is an integer
# $charset is a string
# $outStr is a CkString (output)
$status = $email->GetAttachmentString($index, $charset, $outStr);
$retStr = $email->getAttachmentString($index, $charset);

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

Returns 1 for success, 0 for failure.

top
GetAttachmentStringCrLf
# $index is an integer
# $charset is a string
# $outStrData is a CkString (output)
$status = $email->GetAttachmentStringCrLf($index, $charset, $outStr);
$retStr = $email->getAttachmentStringCrLf($index, $charset);

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

Returns 1 for success, 0 for failure.

top
GetBcc
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetBcc($index, $outStr);
$retStr = $email->getBcc($index);

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

Returns 1 for success, 0 for failure.

top
GetBccAddr
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetBccAddr($index, $outStr);
$retStr = $email->getBccAddr($index);

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

Returns 1 for success, 0 for failure.

top
GetBccName
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetBccName($index, $outStr);
$retStr = $email->getBccName($index);

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

Returns 1 for success, 0 for failure.

top
GetCC
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetCC($index, $outStr);
$retStr = $email->getCC($index);

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
GetCcAddr
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetCcAddr($index, $outStr);
$retStr = $email->getCcAddr($index);

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

Returns 1 for success, 0 for failure.

top
GetCcName
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetCcName($index, $outStr);
$retStr = $email->getCcName($index);

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

Returns 1 for success, 0 for failure.

top
GetDeliveryStatusInfo
# $fieldName is a string
# $outFieldValue is a CkString (output)
$status = $email->GetDeliveryStatusInfo($fieldName, $outStr);
$retStr = $email->getDeliveryStatusInfo($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 1.

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

Reporting-MTA: dns; XYZ.abc.nl

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

Returns 1 for success, 0 for failure.

top
GetDigest
# returns a CkEmail
# $index is an integer
$ret_email = $email->GetDigest($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

More Information and Examples
top
GetDsnFinalRecipients
# returns a CkStringArray
$ret_stringArray = $email->GetDsnFinalRecipients();

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

Returns null on failure

top
GetDt
# returns a CkDateTime
$ret_ckDateTime = $email->GetDt();

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

Returns null on failure

More Information and Examples
top
GetEncryptCert
# returns a CkCert
$ret_cert = $email->GetEncryptCert();

Returns the certificate that was previously set by SetEncryptCert.

Returns null on failure

top
GetEncryptedByCert
# returns a CkCert
$ret_cert = $email->GetEncryptedByCert();

Returns the certificate associated with a received encrypted email.

Returns null on failure

top
GetFileContent
# $path is a string
# $outData is a CkByteData (output)
$status = $email->GetFileContent($path, $outData);

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

Returns 1 for success, 0 for failure.

top
GetHeaderField
# $fieldName is a string
# $outStrFieldData is a CkString (output)
$status = $email->GetHeaderField($fieldName, $outStr);
$retStr = $email->getHeaderField($fieldName);

Returns the value of a header field.

Returns 1 for success, 0 for failure.

top
GetHeaderFieldName
# $index is an integer
# $outStrFieldName is a CkString (output)
$status = $email->GetHeaderFieldName($index, $outStr);
$retStr = $email->getHeaderFieldName($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 1 for success, 0 for failure.

More Information and Examples
top
GetHeaderFieldValue
# $index is an integer
# $outStrFieldValue is a CkString (output)
$status = $email->GetHeaderFieldValue($index, $outStr);
$retStr = $email->getHeaderFieldValue($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 1 for success, 0 for failure.

top
GetHtmlBody
# $outStrBody is a CkString (output)
$status = $email->GetHtmlBody($outStr);
$retStr = $email->getHtmlBody();

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

Returns 1 for success, 0 for failure.

top
GetImapUid
$retInt = $email->GetImapUid();

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.

top
GetLinkedDomains
# returns a CkStringArray
$ret_stringArray = $email->GetLinkedDomains();

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

Returns null on failure

top
GetMbHeaderField
# $fieldName is a string
# $charset is a string
# $outBytes is a CkByteData (output)
$status = $email->GetMbHeaderField($fieldName, $charset, $outData);

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

top
GetMbHtmlBody
# $charset is a string
# $outData is a CkByteData (output)
$status = $email->GetMbHtmlBody($charset, $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 1 for success, 0 for failure.

top
GetMbPlainTextBody
# $charset is a string
# $outData is a CkByteData (output)
$status = $email->GetMbPlainTextBody($charset, $outData);

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

Returns 1 for success, 0 for failure.

top
GetMime
# $outStrMime is a CkString (output)
$status = $email->GetMime($outStr);
$retStr = $email->getMime();

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

Returns 1 for success, 0 for failure.

top
GetMimeBd
# $bindat is a CkBinData
$status = $email->GetMimeBd($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 1 for success, 0 for failure.

top
GetMimeBinary
# $outBytes is a CkByteData (output)
$status = $email->GetMimeBinary($outData);

Returns the full MIME of an email.

Returns 1 for success, 0 for failure.

top
GetMimeSb
# $sb is a CkStringBuilder
$status = $email->GetMimeSb($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 1 for success, 0 for failure.

More Information and Examples
top
GetNthBinaryPartOfType
# $index is an integer
# $contentType is a string
# $inlineOnly is a boolean
# $excludeAttachments is a boolean
# $outBytes is a CkByteData (output)
$status = $email->GetNthBinaryPartOfType($index, $contentType, $inlineOnly, $excludeAttachments, $outData);
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 1, then only MIME sub-parts having a content-disposition of "inline" are included. If excludeAttachments is 1, 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 1 for success, 0 for failure.

top
GetNthTextPartOfType
# $index is an integer
# $contentType is a string
# $inlineOnly is a boolean
# $excludeAttachments is a boolean
# $outStr is a CkString (output)
$status = $email->GetNthTextPartOfType($index, $contentType, $inlineOnly, $excludeAttachments, $outStr);
$retStr = $email->getNthTextPartOfType($index, $contentType, $inlineOnly, $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 1, then only MIME sub-parts having a content-disposition of "inline" are included. If excludeAttachments is 1, 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 1 for success, 0 for failure.

top
GetNumPartsOfType
# $contentType is a string
# $inlineOnly is a boolean
# $excludeAttachments is a boolean
$retInt = $email->GetNumPartsOfType($contentType, $inlineOnly, $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 1, then only MIME sub-parts having a content-disposition of "inline" are included. If excludeAttachments is 1, 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.

top
GetPlainTextBody
# $outStrBody is a CkString (output)
$status = $email->GetPlainTextBody($outStr);
$retStr = $email->getPlainTextBody();

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

Returns 1 for success, 0 for failure.

top
GetRelatedAttr
# $index is an integer
# $fieldName is a string
# $attrName is a string
# $outStr is a CkString (output)
$status = $email->GetRelatedAttr($index, $fieldName, $attrName, $outStr);
$retStr = $email->getRelatedAttr($index, $fieldName, $attrName);
Introduced in version 9.5.0.41

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

Returns 1 for success, 0 for failure.

top
GetRelatedContentID
# $index is an integer
# $outStrContentID is a CkString (output)
$status = $email->GetRelatedContentID($index, $outStr);
$retStr = $email->getRelatedContentID($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 1 for success, 0 for failure.

top
GetRelatedContentLocation
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetRelatedContentLocation($index, $outStr);
$retStr = $email->getRelatedContentLocation($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 1 for success, 0 for failure.

top
GetRelatedContentType
# $index is an integer
# $outStrContentType is a CkString (output)
$status = $email->GetRelatedContentType($index, $outStr);
$retStr = $email->getRelatedContentType($index);

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

Returns 1 for success, 0 for failure.

top
GetRelatedData
# $index is an integer
# $outBuffer is a CkByteData (output)
$status = $email->GetRelatedData($index, $outData);

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

Returns 1 for success, 0 for failure.

top
GetRelatedFilename
# $index is an integer
# $outStrFilename is a CkString (output)
$status = $email->GetRelatedFilename($index, $outStr);
$retStr = $email->getRelatedFilename($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 1 for success, 0 for failure.

top
GetRelatedString
# $index is an integer
# $charset is a string
# $outStrData is a CkString (output)
$status = $email->GetRelatedString($index, $charset, $outStr);
$retStr = $email->getRelatedString($index, $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 1 for success, 0 for failure.

top
GetRelatedStringCrLf
# $index is an integer
# $charset is a string
# $outStr is a CkString (output)
$status = $email->GetRelatedStringCrLf($index, $charset, $outStr);
$retStr = $email->getRelatedStringCrLf($index, $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 1 for success, 0 for failure.

top
GetReplacePattern
# $index is an integer
# $outStrPattern is a CkString (output)
$status = $email->GetReplacePattern($index, $outStr);
$retStr = $email->getReplacePattern($index);

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

Returns 1 for success, 0 for failure.

top
GetReplaceString
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetReplaceString($index, $outStr);
$retStr = $email->getReplaceString($index);

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

Returns 1 for success, 0 for failure.

top
GetReplaceString2
# $pattern is a string
# $outStr is a CkString (output)
$status = $email->GetReplaceString2($pattern, $outStr);
$retStr = $email->getReplaceString2($pattern);

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

Returns 1 for success, 0 for failure.

top
GetReport
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetReport($index, $outStr);
$retStr = $email->getReport($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 1 for success, 0 for failure.

top
GetSignedByCert
# returns a CkCert
$ret_cert = $email->GetSignedByCert();

Return the certificate used to digitally sign this email.

Returns null on failure

More Information and Examples
top
GetSignedByCertChain
# returns a CkCertChain
$ret_certChain = $email->GetSignedByCertChain();
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

top
GetSigningCert
# returns a CkCert
$ret_cert = $email->GetSigningCert();

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

top
GetTo
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetTo($index, $outStr);
$retStr = $email->getTo($index);

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
GetToAddr
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetToAddr($index, $outStr);
$retStr = $email->getToAddr($index);

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

Returns 1 for success, 0 for failure.

top
GetToName
# $index is an integer
# $outStr is a CkString (output)
$status = $email->GetToName($index, $outStr);
$retStr = $email->getToName($index);

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

Returns 1 for success, 0 for failure.

top
GetXml
# $outStrXml is a CkString (output)
$status = $email->GetXml($outStr);
$retStr = $email->getXml();

Convert the email object to an XML document in memory

Returns 1 for success, 0 for failure.

top
HasHeaderMatching
# $fieldName is a string
# $valuePattern is a string
# $caseSensitive is a boolean
$retBool = $email->HasHeaderMatching($fieldName, $valuePattern, $caseSensitive);

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

top
HasHtmlBody
$retBool = $email->HasHtmlBody();

Returns true if the email has an HTML body.

top
HasPlainTextBody
$retBool = $email->HasPlainTextBody();

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

top
IsMultipartReport
$retBool = $email->IsMultipartReport();

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

top
LoadEml
# $mimePath is a string
$status = $email->LoadEml($mimePath);

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

Returns 1 for success, 0 for failure.

top
LoadTaskResult
# $task is a CkTask
$status = $email->LoadTaskResult($task);
Introduced in version 9.5.0.52

Loads the email object from a completed asynchronous task.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LoadXml
# $xmlPath is a string
$status = $email->LoadXml($xmlPath);

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

Returns 1 for success, 0 for failure.

top
LoadXmlString
# $xmlStr is a string
$status = $email->LoadXmlString($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 1 for success, 0 for failure.

top
QEncodeBytes
# $inData is a CkByteData
# $charset is a string
# $outEncodedStr is a CkString (output)
$status = $email->QEncodeBytes($inData, $charset, $outStr);
$retStr = $email->qEncodeBytes($inData, $charset);

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

Returns 1 for success, 0 for failure.

top
QEncodeString
# $str is a string
# $charset is a string
# $outEncodedStr is a CkString (output)
$status = $email->QEncodeString($str, $charset, $outStr);
$retStr = $email->qEncodeString($str, $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 1 for success, 0 for failure.

top
RemoveAttachedMessage
# $idx is an integer
$email->RemoveAttachedMessage($idx);

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

top
RemoveAttachedMessages
$email->RemoveAttachedMessages();

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

top
RemoveAttachmentPaths
$email->RemoveAttachmentPaths();

Removes path information from all attachment filenames.

top
RemoveHeaderField
# $fieldName is a string
$email->RemoveHeaderField($fieldName);

Removes by name all occurrences of a header field.

top
RemoveHtmlAlternative
$email->RemoveHtmlAlternative();

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

top
RemovePlainTextAlternative
$email->RemovePlainTextAlternative();

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

top
SaveAllAttachments
# $dirPath is a string
$status = $email->SaveAllAttachments($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 1 for success, 0 for failure.

top
SaveAttachedFile
# $index is an integer
# $dirPath is a string
$status = $email->SaveAttachedFile($index, $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 1 for success, 0 for failure.

top
SaveEml
# $emlFilePath is a string
$status = $email->SaveEml($emlFilePath);

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

Returns 1 for success, 0 for failure.

top
SaveLastError
# $path is a string
$status = $email->SaveLastError($path);

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

Returns 1 for success, 0 for failure.

top
SaveRelatedItem
# $index is an integer
# $dirPath is a string
$status = $email->SaveRelatedItem($index, $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 1 for success, 0 for failure.

top
SaveXml
# $path is a string
$status = $email->SaveXml($path);

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

Returns 1 for success, 0 for failure.

top
SetAttachmentCharset
# $index is an integer
# $charset is a string
$status = $email->SetAttachmentCharset($index, $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 1 for success, 0 for failure.

top
SetAttachmentDisposition
# $index is an integer
# $disposition is a string
$status = $email->SetAttachmentDisposition($index, $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 1 for success, 0 for failure.

top
SetAttachmentFilename
# $index is an integer
# $filename is a string
$status = $email->SetAttachmentFilename($index, $filename);

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

Returns 1 for success, 0 for failure.

top
SetBinaryBody
# $byteData is a CkByteData
# $contentType is a string
# $disposition is a string
# $filename is a string
$status = $email->SetBinaryBody($byteData, $contentType, $disposition, $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 1 for success, 0 for failure.

top
SetCSP
# $csp is a CkCsp
$status = $email->SetCSP($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 1 for success, 0 for failure.

top
SetDecryptCert
# $cert is a CkCert
$status = $email->SetDecryptCert($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 1 for success, 0 for failure.

top
SetDecryptCert2
# $cert is a CkCert
# $key is a CkPrivateKey
$status = $email->SetDecryptCert2($cert, $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 1 for success, 0 for failure.

More Information and Examples
top
SetDt
# $dt is a CkDateTime
$status = $email->SetDt($dt);

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

Returns 1 for success, 0 for failure.

top
SetEdifactBody
# $message is a string
# $name is a string
# $filename is a string
# $charset is a string
$email->SetEdifactBody($message, $name, $filename, $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.

top
SetEncryptCert
# $cert is a CkCert
$status = $email->SetEncryptCert($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 1 for success, 0 for failure.

top
SetFromMimeBd
# $bindat is a CkBinData
$status = $email->SetFromMimeBd($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 1 for success, 0 for failure.

top
SetFromMimeBytes
# $mimeBytes is a CkByteData
$status = $email->SetFromMimeBytes($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 1 for success, 0 for failure.

top
SetFromMimeBytes2
# $mimeBytes is a CkByteData
# $charset is a string
$status = $email->SetFromMimeBytes2($mimeBytes, $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 1 for success, 0 for failure.

top
SetFromMimeSb
# $sb is a CkStringBuilder
$status = $email->SetFromMimeSb($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 1 for success, 0 for failure.

top
SetFromMimeText
# $mimeText is a string
$status = $email->SetFromMimeText($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 1 for success, 0 for failure.

top
SetFromXmlText
# $xmlStr is a string
$status = $email->SetFromXmlText($xmlStr);

Loads an email from an XML string.

Returns 1 for success, 0 for failure.

top
SetHtmlBody
# $html is a string
$email->SetHtmlBody($html);

Sets the HTML body of an email.

More Information and Examples
top
SetMbHtmlBody
# $charset is a string
# $inData is a CkByteData
$status = $email->SetMbHtmlBody($charset, $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 1 for success, 0 for failure.

top
SetMbPlainTextBody
# $charset is a string
# $inData is a CkByteData
$status = $email->SetMbPlainTextBody($charset, $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 1 for success, 0 for failure.

top
SetRelatedFilename
# $index is an integer
# $path is a string
$status = $email->SetRelatedFilename($index, $path);

Sets the filename for a related item within the email.

Returns 1 for success, 0 for failure.

top
SetReplacePattern
# $pattern is a string
# $replaceString is a string
$status = $email->SetReplacePattern($pattern, $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 1 for success, 0 for failure.

top
SetSigningCert
# $cert is a CkCert
$status = $email->SetSigningCert($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 1 for success, 0 for failure.

More Information and Examples
top
SetSigningCert2
# $cert is a CkCert
# $key is a CkPrivateKey
$status = $email->SetSigningCert2($cert, $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 1 for success, 0 for failure.

top
SetTextBody
# $bodyText is a string
# $contentType is a string
$email->SetTextBody($bodyText, $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.

top
UidlEquals
# $e is a CkEmail
$retBool = $email->UidlEquals($e);

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

top
UnpackHtml
# $unpackDir is a string
# $htmlFilename is a string
# $partsSubdir is a string
$status = $email->UnpackHtml($unpackDir, $htmlFilename, $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 1 for success, 0 for failure.

top
UnSpamify
$email->UnSpamify();

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

top
UnzipAttachments
$status = $email->UnzipAttachments();

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

Returns 1 for success, 0 for failure.

top
UseCertVault
# $vault is a CkXmlCertVault
$status = $email->UseCertVault($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 1 for success, 0 for failure.

top
ZipAttachments
# $zipFilename is a string
$status = $email->ZipAttachments($zipFilename);

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

Returns 1 for success, 0 for failure.

top