Chilkat Online Reference Documentation

ChilkatEmailBundle
Represents a collection of email objects.

See Also: ChilkatMailMan, ChilkatEmail

Properties

ErrorLogHtml As String read-only

Error information for the last method call formatted as HTML with "<br>" line endings.

ErrorLogText As String read-only

Error information for the last method call formatted as plain-text with CRLF line endings.

ErrorLogXml As String read-only

Error information for the last method call formatted as XML.

MessageCount As Long read-only

The number of emails in this bundle. The first email is at index 0. (BACK)

Methods

AddEmail(email As ChilkatEmail) As Boolean

Append an email to the end of the bundle. Return True if successful. (BACK)

GetEmail(index As Long) As ChilkatEmail

Retrieve an individual email from the bundle. Indexing begins at 0. (BACK)

GetUidls() As CkStringArray

Returns a CkStringArray object that contains a UIDL for each email in the bundle. (BACK)

GetXml() As String

Returns an XML formatted representation of the entire email bundle. (BACK)

RemoveEmail(email As ChilkatEmail) As Boolean

Remove an email from the bundle. Return True if successful. (BACK)

SaveXml(filename As String)

Saves the email bundle to an XML formatted file. (BACK)

SortByDate(ascending As Long)

Sorts emails in the bundle by date. If ascending = 1, it sorts ascending, otherwise descending.. (BACK)

SortByRecipient(ascending As Long)

Sorts emails in the bundle by the To header field. If ascending = 1, it sorts ascending, otherwise descending.. (BACK)

SortBySender(ascending As Long)

Sorts emails in the bundle by the From header field. If ascending = 1, it sorts ascending, otherwise descending.. (BACK)

SortBySubject(ascending As Long)

Sorts emails in the bundle by the subject. If ascending = 1, it sorts ascending, otherwise descending.. (BACK)