CkEmail Ruby Programming
Reference Documentation

CkEmail

Represents a complete Email object.

Object Creation

obj = Chilkat::CkEmail.new()

Properties

# str is a CkString object (output)
get_Body( str )

# str is a string (input)
put_Body( str )

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.

# str is a CkString object (output)
get_BounceAddress( str )

# str is a string (input)
put_BounceAddress( str )

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

# str is a CkString object (output)
get_Charset( str )

# str is a string (input)
put_Charset( str )

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.

# Returns a boolean value
get_Decrypted( )

true if the email arrived encrypted and was successfully decrypted, otherwise false.

# sysTime is a SYSTEMTIME object (output)
get_EmailDate( sysTime )

# sysTime is a SYSTEMTIME object (output)
put_EmailDate( sysTime )

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

# str is a CkString object (output)
get_EncryptedBy( str )

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

# str is a CkString object (output)
get_FileDistList( str )

# str is a string (input)
put_FileDistList( str )

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

# str is a CkString object (output)
get_From( str )

# str is a string (input)
put_From( str )

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

# str is a CkString object (output)
get_FromAddress( str )

# str is a string (input)
put_FromAddress( str )

The email address of the sender.

# str is a CkString object (output)
get_FromName( str )

# str is a string (input)
put_FromName( str )

The name of the sender.

# str is a CkString object (output)
get_Header( str )

The complete MIME header of the email.

# str is a CkString object (output)
get_Language( str )

(PreRelease) 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"
"baltic"
"thai"
"vietnamese"
"chinese"
"japanese"
"korean"
"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".

# str is a CkString object (output)
LastErrorHtml( str )

Error information in HTML format for the last method called.

# str is a CkString object (output)
LastErrorText( str )

To be documented soon.Error information in plain-text format for the last method called.

# str is a CkString object (output)
LastErrorXml( str )

Error information in XML format for the last method called.

# sysTime is a SYSTEMTIME object (output)
get_LocalDate( sysTime )

# sysTime is a SYSTEMTIME object (output)
put_LocalDate( sysTime )

The local date and time of when the email was sent or created.

# str is a CkString object (output)
get_Mailer( str )

# str is a string (input)
put_Mailer( str )

Identifies the email software that sent the email.

# Returns an integer value
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.

# Returns an integer value
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.
More about Attached Email Messages

# Returns an integer value
get_NumAttachments( )

The number of attachments contained in the email.

# Returns an integer value
get_NumBcc( )

The number of blind carbon-copy email recipients.

# Returns an integer value
get_NumCC( )

The number of carbon-copy email recipients.

# Returns an integer value
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.)

# Returns an integer value
get_NumHeaderFields( )

The number of header fields.

# Returns an integer value
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.

# Returns an integer value
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.

# Returns an integer value
get_NumTo( )

The number of direct email recipients.

# Returns a boolean value
get_OverwriteExisting( )

# newVal is a boolean (input)
put_OverwriteExisting( newVal )

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

# str is a CkString object (output)
get_PreferredCharset( str )

# newVal is a string (input)
put_PreferredCharset( newVal )

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.

# Returns a boolean value
get_ReceivedEncrypted( )

true if this email was originally received with encryption, otherwise false.

# Returns a boolean value
get_ReceivedSigned( )

true if this email was originally received with a digital signature, otherwise false.

# str is a CkString object (output)
get_ReplyTo( str )

# str is a string (input)
put_ReplyTo( str )

The email address to be used when a recipient replies.

# Returns a boolean value
get_ReturnReceipt( )

# newVal is a boolean (input)
put_ReturnReceipt( newVal )

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

# Returns a boolean value
get_SendEncrypted( )

# newVal is a boolean (input)
put_SendEncrypted( newVal )

Set to true if this email should be sent encrypted.
Auto-Select Cert and Send Encrypted Email
Using a .cer Certificate File for Encrypted Email
Select Cert for Encrypted Email

# Returns a boolean value
get_SendSigned( )

# newVal is a boolean (input)
put_SendSigned( newVal )

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

# Returns a boolean value
get_SignaturesValid( )

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

# str is a CkString object (output)
get_SignedBy( str )

If the email was received digitally signed, this property contains the details of the signer.

# Returns an integer value
get_Size( )

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

# str is a CkString object (output)
get_Subject( str )

# str is a string (input)
put_Subject( str )

The email subject.

# str is a CkString object (output)
get_Uidl( str )

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

# Returns a boolean value
get_Utf8( )

# b is a boolean (input)
put_Utf8( b )

When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.

# Returns a boolean value
get_VerboseLogging( )

# newVal is a boolean (input)
put_VerboseLogging( newVal )

To be documented soon...

Methods

# index is an integer (input)
# fieldName is a string (input)
# fieldValue is a string (input)
AddAttachmentHeader( index, fieldName, fieldValue )

Adds a MIME header field to one of the attachments.

# friendlyName is a string (input)
# emailAddress is a string (input)
# Returns a boolean value
AddBcc( friendlyName, emailAddress )

Adds a recipient to the blind carbon-copy list. address is required, but name may be empty. Returns True if successful.
Why BCC email addresses do not appear in the email header.

# friendlyName is a string (input)
# emailAddress is a string (input)
# Returns a boolean value
AddCC( friendlyName, emailAddress )

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

# fileName is a string (input)
# data is a string (input)
# dataLen is an integer (input)
# Returns a boolean value
AddDataAttachment( fileName, data, dataLen )

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

# fileName is a string (input)
# content is a CkByteData object (output)
# contentType is a string (input)
# Returns a boolean value
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 a boolean value
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. The Chilkat email component will automatically search the registry-based Current-User and Local-Machine certificate stores for certs matching each of the recipients (To, CC, and BCC recipients).
Note: The SentEncryptCert method is equivalent to calling ClearEncryptCerts followed by AddEncryptCert.
Returns true for success, false for failure.

# fileName is a string (input)
# Returns a boolean value
AddFileAttachment( fileName, strContentType )

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.

# fileName is a string (input)
# contentType is a string (input)
# Returns a boolean value
AddFileAttachment2( fileName, contentType )

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

# fieldName is a string (input)
# fieldValue is a string (input)
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.

# body is a string (input)
# Returns a boolean value
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.

# commaSeparatedAddresses is a string (input)
# Returns a boolean value
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.
Why BCC email addresses do not appear in the email header.

# commaSeparatedAddresses is a string (input)
# Returns a boolean value
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.

# commaSeparatedAddresses is a string (input)
# Returns a boolean value
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.

# body is a string (input)
# Returns a boolean value
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.

# fileName is a string (input)
# data is a string (input)
# dataLen is an integer (input)
# Returns a boolean value
AddRelatedData( fileName, data, dataLen, strContentId )

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

# data is a string (input)
# dataLen is an integer (input)
# filenameInHtml is a string (input)
AddRelatedData2( data, dataLen, 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.

# fileName is a string (input)
# Returns a boolean value
AddRelatedFile( fileName, strContentID )

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

# filenameOnDisk is a string (input)
# filenameInHtml is a string (input)
# Returns a boolean value
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.

# index is an integer (input)
# fieldName is a string (input)
# fieldValue is a string (input)
AddRelatedHeader( index, fieldName, fieldValue )

To be documented soon...

# nameInHtml is a string (input)
# str is a string (input)
# charset is a string (input)
# Returns a boolean value
AddRelatedString( nameInHtml, str, charset, cid )

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.

# str is a string (input)
# charset is a string (input)
# filenameInHtml is a string (input)
AddRelatedString2( str, charset, filenameInHtml )

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.

# fileName is a string (input)
# str is a string (input)
# Returns a boolean value
AddStringAttachment( fileName, str )

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

# fileName is a string (input)
# str is a string (input)
# charset is a string (input)
# Returns a boolean value
AddStringAttachment2( fileName, str, charset )

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

# friendlyName is a string (input)
# emailAddress is a string (input)
# Returns a boolean value
AddTo( friendlyName, emailAddress )

Adds a recipient to the "to" list. address is required, but name may be empty. Returns True if successful. Emails that have no "To" recipients will be sent to .

# password is a string (input)
# Returns a boolean value
AesDecrypt( password )

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

# password is a string (input)
# Returns a boolean value
AesEncrypt( password )

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

# str is a string (input)
AppendToBody( str )

Appends a string to the plain-text body.

# prefix is a string (input)
# saveDir is a string (input)
# urlPath is a string (input)
# cleanFiles is a boolean (input)
# Returns a boolean value
AspUnpack( prefix, saveDir, urlPath, cleanFiles )

Please see the examples at the following pages for detailed information:
Returns true for success, false for failure.
Display HTML Email in Web Page
Display HTML Email in IFrame (or Frame)

# prefix is a string (input)
# saveDir is a string (input)
# urlPath is a string (input)
# cleanFiles is a boolean (input)
# outBytes is a CkByteData object (output)
# Returns a boolean value
AspUnpack2( prefix, saveDir, urlPath, cleanFiles, outBytes )

Please see the examples at the following pages for detailed information:
Display HTML Email in Web Page
Display HTML Email in IFrame (or Frame)

# mimeBytes is a CkByteData object (output)
# Returns a boolean value
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 true for success, false for failure.

# data is a string (input)
# dataLen is an integer (input)
# charset is a string (input)
# encodedStr is a CkString object (output)
# Returns a boolean value
BEncodeBytes( data, dataLen, charset, encodedStr )

Takes a byte array of multibyte (non-Unicode) data and returns a Unicode B-Encoded string.
Returns true for success, false for failure.

# str is a string (input)
# charset is a string (input)
# encodedStr is a CkString object (output)
# Returns a boolean value
BEncodeString( str, charset, encodedStr )

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

ClearBcc( )

Clears the list of blind carbon-copy recipients.

ClearCC( )

Clears the list of carbon-copy recipients.

ClearEncryptCerts( )

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

ClearTo( )

Clears the list of "to" recipients.

# Returns a CkEmail object
Clone( )

Creates and returns an identical copy of the Email object.
Returns a null reference on failure

# encoding is a string (input)
# bFold is a boolean (input)
# outStr is a CkString object (output)
# Returns a boolean value
ComputeGlobalKey( encoding, bFold, outStr )

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

# Returns a CkEmail object
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 a null reference on failure

# Returns a CkEmail object
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.
Returns a null reference on failure

# inFilename is a string (input)
# tempMhtFilename is a CkString object (output)
# Returns a boolean value
CreateTempMht( inFilename, tempMhtFilename )

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

DropAttachments( )

Removes all attachments from the email.

# index is an integer (input)
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.

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.

# index is an integer (input)
# Returns a boolean value
DropSingleAttachment( index )

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

# strFilename is a CkString object (output)
GenerateFilename( strFilename )

Generates a unique filename for this email. The filename will be different each time the method is called.
Returns true for success, false for failure.

# index is an integer (input)
# fieldName is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
GetAltHeaderField( index, fieldName, outStr )

Returns the value of a header field within the Nth alternative body's MIME sub-part.
Returns true for success, false for failure.

# index is an integer (input)
# strBody is a CkString object (output)
# Returns a boolean value
GetAlternativeBody( index, strBody )

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

# index is an integer (input)
# strContentType is a CkString object (output)
# Returns a boolean value
GetAlternativeContentType( index, strContentType )

Returns the content type of the Nth alternative body. The NumAlternatives property tells the number of alternative bodies present.
Returns true for success, false for failure.

# index is an integer (input)
# Returns a CkEmail object
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 a null reference on failure

# index is an integer (input)
# outStr is a CkString object (output)
# Returns a boolean value
GetAttachedMessageFilename( index, outStr )

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

# index is an integer (input)
# strContentID is a CkString object (output)
# Returns a boolean value
GetAttachmentContentID( index, strContentID )

Returns the ContentID header field for the Nth attachment. The first attachment is at index 0.
Returns true for success, false for failure.

# index is an integer (input)
# strContentType is a CkString object (output)
# Returns a boolean value
GetAttachmentContentType( index, strContentType )

Returns the Content-Type header field for the Nth attachment. Indexing of attachments begins at 0.
Returns true for success, false for failure.

# index is an integer (input)
# buffer is a CkByteData object (output)
# Returns a boolean value
GetAttachmentData( index, buffer )

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

# index is an integer (input)
# strFilename is a CkString object (output)
# Returns a boolean value
GetAttachmentFilename( index, strFilename )

Retrieves an attachment's filename.
Returns true for success, false for failure.

# index is an integer (input)
# fieldName is a string (input)
# fieldValue is a CkString object (output)
# Returns a boolean value
GetAttachmentHeader( index, fieldName, fieldValue )

Returns the value of a header field (by name) of an attachment.
Returns true for success, false for failure.

# index is an integer (input)
# Returns an integer value
GetAttachmentSize( index )

Returns the size (in bytes) of the Nth attachment.

# index is an integer (input)
# charset is a string (input)
# str is a CkString object (output)
# Returns a boolean value
GetAttachmentString( index, charset, str )

Retrieves an attachment's data as a String. All CRLF sequences will be translated to single newline characters.
Returns true for success, false for failure.

# index is an integer (input)
# charset is a string (input)
# strData is a CkString object (output)
# Returns a boolean value
GetAttachmentStringCrLf( index, charset, strData )

Retrieves an attachment's data as a String. All end-of-lines will be translated to CRLF sequences.
Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetBcc( index, str )

Returns a blind carbon-copy recipient's full email address.
Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetBccAddr( index, str )

Returns the Nth BCC address (only the address part, not the friendly-name part).
Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetBccName( index, str )

Returns the Nth BCC name (only the friendly-name part, not the address part).
Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetCC( index, str )

Returns a carbon-copy recipient's full email address.
Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetCcAddr( index, str )

Returns the Nth CC address (only the address part, not the friendly-name part).
Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetCcName( index, str )

Returns the Nth CC name (only the friendly-name part, not the address part).
Returns true for success, false for failure.

# fieldName is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
GetDeliveryStatusInfo( fieldName, outStr )

If the email is a multipart/report, then it is a delivery status notification. This method can be used to get individual pieces of information from the message/delivery-status part of the email. This method should only be called if the IsMultipartReport method returns true.
The fieldName should be set a string such as "Final-Recipient", "Status", "Action", "Reporting-MTA", etc.
Reporting-MTA: dns; XYZ.abc.nl

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

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 true.
Returns a null reference on failure

# Returns a CkCert object
GetEncryptCert( )

Returns the certificate that was previously set by SetEncryptCert.

# Returns a CkCert object
GetEncryptedByCert( )

Returns the certificate associated with a received encrypted email.

# filename is a string (input)
# bData is a CkByteData object (output)
# Returns a boolean value
GetFileContent( filename, bData )

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

# fieldName is a string (input)
# strFieldData is a CkString object (output)
# Returns a boolean value
GetHeaderField( fieldName, strFieldData )

Returns the value of a header field.
Returns true for success, false for failure.

# index is an integer (input)
# strFieldName is a CkString object (output)
# Returns a boolean value
GetHeaderFieldName( index, strFieldName )

Return the name of the Nth header field. The NumHeaderFields() method can be used to get the number of header fields. The GetHeaderField() method can be used to get the value of the field given the field name.
Returns true for success, false for failure.

# index is an integer (input)
# strFieldValue is a CkString object (output)
# Returns a boolean value
GetHeaderFieldValue( index, strFieldValue )

Returns the value of the Nth header field. (Indexing begins at 0) The number of header fields can be obtained from the NumHeaderFields property.
Returns true for success, false for failure.

# strBody is a CkString object (output)
# Returns a boolean value
GetHtmlBody( strBody )

Returns the body having the "text/html" content type.
Returns true for success, false for failure.

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

# array is a CkStringArray object (output)
GetLinkedDomains( array )

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

# fieldName is a string (input)
# fieldData is a CkByteData object (output)
# Returns a boolean value
GetMbHeaderField( fieldName, fieldData )

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.

# charset is a string (input)
# fieldName is a string (input)
# fieldData is a CkByteData object (output)
# Returns a boolean value
GetMbHeaderField2( charset, fieldName, fieldData )

Returns the value of a header field converted to a specified charset.

# charset is a string (input)
# data is a CkByteData object (output)
# Returns a boolean value
GetMbHtmlBody( charset, data )

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.

# charset is a string (input)
# data is a CkByteData object (output)
# Returns a boolean value
GetMbPlainTextBody( charset, data )

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

# strMime is a CkString object (output)
GetMime( strMime )

Return the email as MIME text containing the email header, body (or bodies), related items (if any), and all attachments
Returns true for success, false for failure.

# outBytes is a CkByteData object (output)
GetMimeBinary( outBytes )

Returns the full MIME of an email.

# Returns a CkMime object
GetMimeObject( )

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

# strBody is a CkString object (output)
# Returns a boolean value
GetPlainTextBody( strBody )

Returns the email body having the "text/plain" content type.
Returns true for success, false for failure.

# index is an integer (input)
# strContentID is a CkString object (output)
# Returns a boolean value
GetRelatedContentID( index, strContentID )

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

# index is an integer (input)
# outStr is a CkString object (output)
# Returns a boolean value
GetRelatedContentLocation( index, outStr )

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

# index is an integer (input)
# strContentType is a CkString object (output)
# Returns a boolean value
GetRelatedContentType( index, strContentType )

Returns the content-type of the Nth related content item in an email message.
Returns true for success, false for failure.

# index is an integer (input)
# buffer is a CkByteData object (output)
# Returns a boolean value
GetRelatedData( index, buffer )

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

# index is an integer (input)
# strFilename is a CkString object (output)
# Returns a boolean value
GetRelatedFilename( index, strFilename )

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

# index is an integer (input)
# charset is a string (input)
# strData is a CkString object (output)
# Returns a boolean value
GetRelatedString( index, charset, strData )

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

# index is an integer (input)
# charset is a string (input)
# str is a CkString object (output)
# Returns a boolean value
GetRelatedStringCrLf( index, charset, str )

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

# index is an integer (input)
# strPattern is a CkString object (output)
# Returns a boolean value
GetReplacePattern( index, strPattern )

Returns a replacement pattern previously defined for mail-merge operations.
Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetReplaceString( index, str )

Returns a replacement string for a previously defined pattern/replacement string pair. (This is a mail-merge feature.)
Returns true for success, false for failure.

# pattern is a string (input)
# str is a CkString object (output)
# Returns a boolean value
GetReplaceString2( pattern, str )

Returns a replacement string for a previously defined pattern/replacement string pair. (This is a mail-merge feature.)
Returns true for success, false for failure.

# Returns a CkCert object
GetSignedByCert( )

Return the certificate used to digitally sign this email.

# Returns a CkCert object
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.

# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetTo( index, str )

Returns a "to" recipient's full email address.
Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetToAddr( index, str )

Returns the Nth To address (only the address part, not the friendly-name part).
Returns true for success, false for failure.

# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetToName( index, str )

Returns the Nth To name (only the friendly-name part, not the address part).
Returns true for success, false for failure.

# strXml is a CkString object (output)
GetXml( strXml )

Convert the email object to an XML document in memory
Returns true for success, false for failure.

# fieldName is a string (input)
# valuePattern is a string (input)
# caseSensitive is a boolean (input)
# Returns a boolean value
HasHeaderMatching( fieldName, valuePattern, caseSensitive )

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

# Returns a boolean value
HasHtmlBody( )

Returns true if the email has an HTML body.

# Returns a boolean value
HasPlainTextBody( )

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

# Returns a boolean value
IsMultipartReport( )

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

# mimeFilename is a string (input)
# Returns a boolean value
LoadEml( mimeFilename )

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

# xmlFilename is a string (input)
# Returns a boolean value
LoadXml( xmlFilename )

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

# xmlStr is a string (input)
# Returns a boolean value
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 true for success, false for failure.

# data is a string (input)
# dataLen is an integer (input)
# charset is a string (input)
# encodedStr is a CkString object (output)
# Returns a boolean value
QEncodeBytes( data, dataLen, charset, encodedStr )

Takes a byte array of multibyte (non-Unicode) data and returns a Unicode Q-Encoded string.
Returns true for success, false for failure.

# str is a string (input)
# charset is a string (input)
# encodedStr is a CkString object (output)
# Returns a boolean value
QEncodeString( str, charset, encodedStr )

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

# index is an integer (input)
RemoveAttachedMessage( index )

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

RemoveAttachedMessages( )

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

RemoveAttachmentPaths( )

Removes path information from all attachment filenames.

# fieldName is a string (input)
RemoveHeaderField( fieldName )

Removes by name all occurances of a header field.

# directory is a string (input)
# Returns a boolean value
SaveAllAttachments( directory )

Save all the attachments of an email to a file
Example: Download and Save Email Attachments (POP3)

# index is an integer (input)
# directory is a string (input)
# Returns a boolean value
SaveAttachedFile( index, directory )

Save a specific email attachment to a file
Example: Download and Save Email Attachments (POP3)

# filename is a string (input)
# Returns a boolean value
SaveEml( filename )

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

# filename is a string (input)
# Returns a boolean value
SaveLastError( filename )

Saves the last error information to an XML formatted file.

# index is an integer (input)
# directory is a string (input)
# Returns a boolean value
SaveRelatedItem( index, directory )

Save a related item to a file. Related content items are typically image or style-sheets embedded within an HTML email.

# filename is a string (input)
# Returns a boolean value
SaveXml( filename )

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

# index is an integer (input)
# charset is a string (input)
# Returns a boolean value
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 true for success, false for failure.

# index is an integer (input)
# disposition is a string (input)
# Returns a boolean value
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 ARG1 0.
Returns true for success, false for failure.

# index is an integer (input)
# filename is a string (input)
# Returns a boolean value
SetAttachmentFilename( index, filename )

Renames a email attachment's filename. The 1st attachment is at index 0.
Returns true for success, false for failure.

# csp is a CkCSP object (input)
# Returns a boolean value
SetCSP( csp )

Set the Cryptographic Service Provider (CSP) to be used for encryption or digital signing this email. You do not usually need to call this because the default is usually appropriate. One example of where this might be used is for applications using Smart Cards that need to use the CSP of a Smart Card vendor.

# cert is a CkCert object (input)
# Returns a boolean value
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.
Using a .cer Certificate File for Encrypted Email

# mimeBytes is a CkByteData object (output)
# Returns a boolean value
SetFromMimeBytes( mimeBytes )

To be documented soon.
Returns true for success, false for failure.

# Returns a boolean value
SetFromMimeObject( mime )

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

# mimeText is a string (input)
# Returns a boolean value
SetFromMimeText( mimeText )

Replace the contents of this email object with that found in the MIME text

# mimeText is a string (input)
# numBytes is an integer (input)
# Returns a boolean value
SetFromMimeText2( mimeText, numBytes )

Same as SetFromMimeText, but accepts two arguments: a pointer to the byte data containing the MIME text and a size (in bytes). This is helpful for MIME text that may contain binary data, including NULL bytes.
Returns true for success, false for failure.

# xmlStr is a string (input)
# Returns a boolean value
SetFromXmlText( xmlStr )

Loads an email from an XML string.

# html is a string (input)
SetHtmlBody( html )

Sets the HTML body of an email.

# charset is a string (input)
# data is a string (input)
# dataLen is an integer (input)
# Returns a boolean value
SetMbHtmlBody( charset, data, dataLen )

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.

# charset is a string (input)
# data is a string (input)
# dataLen is an integer (input)
# Returns a boolean value
SetMbPlainTextBody( charset, data, dataLen )

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.

# pattern is a string (input)
# replaceString is a string (input)
# Returns a boolean value
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.

# cert is a CkCert object (input)
# Returns a boolean value
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 true for success, false for failure.

# Returns a boolean value
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 true for success, false for failure.

# bodyText is a string (input)
# contentType is a string (input)
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.

# e is a CkEmail object (input)
# Returns a boolean value
UidlEquals( e )

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

UnSpamify( )

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

# unlockCode is a string (input)
# Returns a boolean value
UnlockComponent( unlockCode )

Added as a convenience so that Chilkat Email.NET can be unlocked without necessarily having to create a MailMan object and calling MailMan.UnlockComponent. Either one of MailMan.UnlockComponent or Email.UnlockComponent can be called once at the beginning of your program to unlock the entire Chilkat Email.NET component.

# unpackDir is a string (input)
# htmlFilename is a string (input)
# partsSubdir is a string (input)
# Returns a boolean value
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 true for success, false for failure.

# Returns a boolean value
UnwrapSecurity( )

To be documented soon...

# Returns a boolean value
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.

# zipFilename is a string (input)
# Returns a boolean value
ZipAttachments( zipFilename )

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

# fileName is a string (input)
# Returns a string
addFileAttachment( fileName )

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.

# fileName is a string (input)
# Returns a string
addRelatedFile( fileName )

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

# nameInHtml is a string (input)
# str is a string (input)
# charset is a string (input)
# Returns a string
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.

# data is a string (input)
# dataLen is an integer (input)
# charset is a string (input)
# Returns a string
bEncodeBytes( data, dataLen, charset )

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

# str is a string (input)
# charset is a string (input)
# Returns a string
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 a string
body( )

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.

# Returns a string
bounceAddress( )

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

# Returns a string
charset( )

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.

# Returns a string
ck_from( )

To be documented soon...

# encoding is a string (input)
# bFold is a boolean (input)
# Returns a string
computeGlobalKey( encoding, bFold )

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

# inFilename is a string (input)
# Returns a string
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 a string
encryptedBy( )

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

# Returns a string
fileDistList( )

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

# Returns a string
fromAddress( )

The email address of the sender.

# Returns a string
fromName( )

The name of the sender.

# Returns a string
generateFilename( )

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

# index is an integer (input)
# fieldName is a string (input)
# Returns a string
getAltHeaderField( index, fieldName )

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

# index is an integer (input)
# Returns a string
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.

# index is an integer (input)
# Returns a string
getAlternativeContentType( index )

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

# index is an integer (input)
# Returns a string
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.

# index is an integer (input)
# Returns a string
getAttachmentContentID( index )

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

# index is an integer (input)
# Returns a string
getAttachmentContentType( index )

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

# index is an integer (input)
# Returns a string
getAttachmentFilename( index )

Retrieves an attachment's filename.

# index is an integer (input)
# fieldName is a string (input)
# Returns a string
getAttachmentHeader( index, fieldName )

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

# index is an integer (input)
# charset is a string (input)
# Returns a string
getAttachmentString( index, charset )

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

# index is an integer (input)
# charset is a string (input)
# Returns a string
getAttachmentStringCrLf( index, charset )

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

# index is an integer (input)
# Returns a string
getBcc( index )

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

# index is an integer (input)
# Returns a string
getBccAddr( index )

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

# index is an integer (input)
# Returns a string
getBccName( index )

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

# index is an integer (input)
# Returns a string
getCC( index )

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

# index is an integer (input)
# Returns a string
getCcAddr( index )

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

# index is an integer (input)
# Returns a string
getCcName( index )

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

# fieldName is a string (input)
# Returns a string
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 true.
The fieldName should be set a string such as "Final-Recipient", "Status", "Action", "Reporting-MTA", etc.
Reporting-MTA: dns; XYZ.abc.nl

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

# fieldName is a string (input)
# Returns a string
getHeaderField( fieldName )

Returns the value of a header field.

# index is an integer (input)
# Returns a string
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.

# index is an integer (input)
# Returns a string
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.

# Returns a string
getHtmlBody( )

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

# Returns a string
getMime( )

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

# Returns a string
getPlainTextBody( )

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

# index is an integer (input)
# Returns a string
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.

# index is an integer (input)
# Returns a string
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.

# index is an integer (input)
# Returns a string
getRelatedContentType( index )

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

# index is an integer (input)
# Returns a string
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.

# index is an integer (input)
# charset is a string (input)
# Returns a string
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.

# index is an integer (input)
# charset is a string (input)
# Returns a string
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.

# index is an integer (input)
# Returns a string
getReplacePattern( index )

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

# index is an integer (input)
# Returns a string
getReplaceString( index )

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

# pattern is a string (input)
# Returns a string
getReplaceString2( pattern )

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

# index is an integer (input)
# Returns a string
getTo( index )

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

# index is an integer (input)
# Returns a string
getToAddr( index )

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

# index is an integer (input)
# Returns a string
getToName( index )

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

# Returns a string
getXml( )

Convert the email object to an XML document in memory

# Returns a string
header( )

The complete MIME header of the email.

# Returns a string
language( )

(PreRelease) 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"
"baltic"
"thai"
"vietnamese"
"chinese"
"japanese"
"korean"
"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".

# Returns a string
lastErrorHtml( )

Error information in HTML format for the last method called.

# Returns a string
lastErrorText( )

Error information in plain-text format for the last method called.

# Returns a string
lastErrorXml( )

Error information in XML format for the last method called.

# Returns a string
mailer( )

Identifies the email software that sent the email.

# Returns a string
preferredCharset( )

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.

# data is a string (input)
# dataLen is an integer (input)
# charset is a string (input)
# Returns a string
qEncodeBytes( data, dataLen, charset )

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

# str is a string (input)
# charset is a string (input)
# Returns a string
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 a string
replyTo( )

The email address to be used when a recipient replies.

# Returns a string
signedBy( )

If the email was received digitally signed, this property contains the details of the signer.

# Returns a string
subject( )

The email subject.

# Returns a string
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".

CkEmail Ruby ProgrammingReference Documentation

CkEmail

CkEmail Ruby Programming
Reference Documentation