CkEmailBundle Ruby Reference Documentation

CkEmailBundle

Represents a collection of Email objects.

Object Creation

obj = Chilkat::CkEmailBundle.new()

Properties

# strVal is a string
# ckStr is a CkString
emailBundle.get_DebugLogFilePath(ckStr);
strVal = emailBundle.debugLogFilePath();
emailBundle.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.

# strVal is a string
# ckStr is a CkString
emailBundle.get_LastErrorHtml(ckStr);
strVal = emailBundle.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.

# strVal is a string
# ckStr is a CkString
emailBundle.get_LastErrorText(ckStr);
strVal = emailBundle.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.

# strVal is a string
# ckStr is a CkString
emailBundle.get_LastErrorXml(ckStr);
strVal = emailBundle.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.

# boolVal is a boolean
boolVal = emailBundle.get_LastMethodSuccess();
emailBundle.put_LastMethodSuccess(boolVal);

Introduced in version 9.5.0.52

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

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

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

# intVal is an integer
intVal = emailBundle.get_MessageCount();

The number of emails in this bundle.

# boolVal is a boolean
boolVal = emailBundle.get_Utf8();
emailBundle.put_Utf8(boolVal);

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

# boolVal is a boolean
boolVal = emailBundle.get_VerboseLogging();
emailBundle.put_VerboseLogging(boolVal);

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

# strVal is a string
# ckStr is a CkString
emailBundle.get_Version(ckStr);
strVal = emailBundle.version();

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

Methods

# email is a CkEmail
status = emailBundle.AddEmail(email);

Adds an email object to the bundle.

Returns true for success, false for failure.

# returns a CkEmail
# headerFieldName is a string
# headerFieldValue is a string
ret_email = emailBundle.FindByHeader(headerFieldName, headerFieldValue);

Returns the first email having a header field matching the headerFieldName and headerFieldValue exactly (case sensitive). If no matching email is found, returns nil.

# returns a CkEmail
# index is an integer
ret_email = emailBundle.GetEmail(index);

Returns the Nth Email in the bundle. The email returned is a copy of the email in the bundle. Updating the email object returned by GetEmail has no effect on the email within the bundle. To update/replace the email in the bundle, your program should call GetEmail to get a copy, make modifications, call RemoveEmailByIndex to remove the email (passing the same index used in the call to GetEmail), and then call AddEmail to insert the new/modified email into the bundle.

IMPORTANT: This method does NOT communicate with any mail server to download the email. It simply returns the Nth email object that exists within it's in-memory collection of email objects.

# returns a CkStringArray
ret_stringArray = emailBundle.GetUidls();

Returns a StringArray object containing UIDLs for all Email objects in the bundle. UIDLs are only valid for emails retrieved from POP3 servers. An email on a POP3 server has a "UIDL", an email on IMAP servers has a "UID". If the email was retrieved from an IMAP server, the UID will be accessible via the "ckx-imap-uid" header field.

# outXml is a CkString (output)
status = emailBundle.GetXml(outXml);
retStr = emailBundle.getXml();

Converts the email bundle to an XML document in memory. Returns the XML document as a string.

Returns true for success, false for failure.

# task is a CkTask
status = emailBundle.LoadTaskResult(task);

Introduced in version 9.5.0.52

Loads the email bundle from a completed asynchronous task.

Returns true for success, false for failure.

# filename is a string
status = emailBundle.LoadXml(filename);

Loads an email bundle from an XML file.

Returns true for success, false for failure.

# xmlStr is a string
status = emailBundle.LoadXmlString(xmlStr);

Loads an email bundle from an XML string.

Returns true for success, false for failure.

# email is a CkEmail
status = emailBundle.RemoveEmail(email);

Removes an email from the bundle. This does not remove the email from the mail server.

Returns true for success, false for failure.

# index is an integer
status = emailBundle.RemoveEmailByIndex(index);

Removes the Nth email in a bundle. (Indexing begins at 0.)

Returns true for success, false for failure.

# path is a string
status = emailBundle.SaveLastError(path);

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

Returns true for success, false for failure.

# filename is a string
status = emailBundle.SaveXml(filename);

Converts each email to XML and persists the bundle to an XML file. The email bundle can later be re-instantiated by calling MailMan.LoadXmlFile

Returns true for success, false for failure.

# ascending is a boolean
emailBundle.SortByDate(ascending);

Sorts emails in the bundle by date.

# ascending is a boolean
emailBundle.SortByRecipient(ascending);

Sorts emails in the bundle by recipient.

# ascending is a boolean
emailBundle.SortBySender(ascending);

Sorts emails in the bundle by sender.

# ascending is a boolean
emailBundle.SortBySubject(ascending);

Sorts emails in the bundle by subject.