Chilkat.EmailBundle PHP Reference

Chilkat.EmailBundle

Represents a collection of Email objects.

Object Creation

$obj = new COM("Chilkat.EmailBundle");

Properties

string LastErrorHtml (read-only)

Error information in HTML format for the last method called.

string LastErrorText (read-only)

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

string LastErrorXml (read-only)

Error information in XML format for the last method called.

int MessageCount (read-only)

The number of emails in this bundle.

Methods

void AddEmail(Chilkat.Email email)

Adds an Email object to the bundle. Returns true if successful

bool AddMime(VARIANT mime)

To be documented soon...

Chilkat.Email FindByHeader(string name, string value)

To be documented soon...

Chilkat.Email GetEmail(int 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.

Returns a null reference on failure

Chilkat.StringArray 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 a null reference on failure

string GetXml()

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

Returns a null on failure

bool LoadXml(string filename)

Loads an email bundle from an XML file.

bool LoadXmlString(string str)

Loads an email bundle from an XML string.

bool RemoveEmail(Chilkat.Email email)

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

bool RemoveEmailByIndex(int index)

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

Returns 1 for success, 0 for failure.

bool SaveLastError(string filename)

Saves the last error information to an XML formatted file.

bool SaveXml(string 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

void SortByDate(int ascending)

Sorts emails in the bundle by date.

void SortByRecipient(int ascending)

Sorts emails in the bundle by recipient.

void SortBySender(int ascending)

Sorts emails in the bundle by sender.

void SortBySubject(int ascending)

Sorts emails in the bundle by subject.