EmailBundle Perl Reference Documentation

CkEmailBundle

Current Version: 10.1.2

Requires Chilkat Bundle License

Represents a collection of Email objects.

Object Creation

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

Properties

DebugLogFilePath

# $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, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

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

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

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

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

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

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

# $boolVal is a boolean
$boolVal = $emailBundle->get_LastMethodSuccess();
$emailBundle->put_LastMethodSuccess($boolVal);

Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

MessageCount

# $intVal is an integer
$intVal = $emailBundle->get_MessageCount();

The number of emails in this bundle.

Utf8

# $boolVal is a boolean
$boolVal = $emailBundle->get_Utf8();
$emailBundle->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.

VerboseLogging

# $boolVal is a boolean
$boolVal = $emailBundle->get_VerboseLogging();
$emailBundle->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.

Version

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

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddEmail

# $email is a CkEmail
$status = $emailBundle->AddEmail($email);

Adds an email object to the bundle.

Returns 1 for success, 0 for failure.

FindByHeader

# 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 null.

Returns null on failure

GetEmail

# 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 null on failure

GetUidls

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

Returns null on failure

GetXml

# $outXml is a CkString (output)
$status = $emailBundle->GetXml($outStr);
$retStr = $emailBundle->getXml();

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

Returns 1 for success, 0 for failure.

LoadTaskResult

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

LoadXml

# $filename is a string
$status = $emailBundle->LoadXml($filename);

Loads an email bundle from an XML file.

Returns 1 for success, 0 for failure.

LoadXmlString

# $xmlStr is a string
$status = $emailBundle->LoadXmlString($xmlStr);

Loads an email bundle from an XML string.

Returns 1 for success, 0 for failure.

RemoveEmail

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

RemoveEmailByIndex

# $index is an integer
$status = $emailBundle->RemoveEmailByIndex($index);

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

Returns 1 for success, 0 for failure.

SaveXml

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

SortByDate

# $ascending is a boolean
$emailBundle->SortByDate($ascending);

Sorts emails in the bundle by date.

SortByRecipient

# $ascending is a boolean
$emailBundle->SortByRecipient($ascending);

Sorts emails in the bundle by recipient.

SortBySender

# $ascending is a boolean
$emailBundle->SortBySender($ascending);

Sorts emails in the bundle by sender.

SortBySubject

# $ascending is a boolean
$emailBundle->SortBySubject($ascending);

Sorts emails in the bundle by subject.