EmailBundle ActiveX Reference Documentation

EmailBundle

Represents a collection of Email objects.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatEmailBundle2
(ASP)
set obj = Server.CreateObject("Chilkat.EmailBundle")
(VBScript)
set obj = CreateObject("Chilkat.EmailBundle")
(Delphi)
obj := TChilkatEmailBundle2.Create(Self);
(FoxPro)
loObject = CreateObject('Chilkat.EmailBundle')
(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.EmailBundle', @obj OUT
(Javascript)
var obj = new ActiveXObject("Chilkat.EmailBundle");

Properties

DebugLogFilePath As String

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.

LastErrorHtml As String (read-only)

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.

LastErrorText As String (read-only)

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.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (read-only)

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.

MessageCount As Long (read-only)

The number of emails in this bundle.

VerboseLogging As Long

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 As String (read-only)

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

Methods

AddEmail(email As ChilkatEmail2) As Long

Adds an email object to the bundle.

Returns 1 for success, 0 for failure.

AddMimeBytes(mimeBytesOrText As Chilkat) As Long

Adds an email to the bundle object. The mimeBytesOrText is the email in MIME format.

Returns 1 for success, 0 for failure.

FindByHeader(headerFieldName As String, headerFieldValue As String) As ChilkatEmail2

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

GetEmail(index As Long) As ChilkatEmail2

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.

GetUidls() As CkStringArray

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.

GetXml() As String

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

Returns 1 for success, 0 for failure.

LoadXml(filename As String) As Long

Loads an email bundle from an XML file.

Returns 1 for success, 0 for failure.

LoadXmlString(xmlStr As String) As Long

Loads an email bundle from an XML string.

Returns 1 for success, 0 for failure.

RemoveEmail(email As ChilkatEmail2) As Long

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 As Long) As Long

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

Returns 1 for success, 0 for failure.

SaveXml(filename As String) As Long

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 As Long)

Sorts emails in the bundle by date.

SortByRecipient(ascending As Long)

Sorts emails in the bundle by recipient.

SortBySender(ascending As Long)

Sorts emails in the bundle by sender.

SortBySubject(ascending As Long)

Sorts emails in the bundle by subject.