EmailBundle ActiveX Reference Documentation

EmailBundle

Represents a collection of Email objects.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatEmailBundle

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.EmailBundle")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.EmailBundle")

(Delphi)
obj := TChilkatEmailBundle.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.EmailBundle')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.EmailBundle")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.EmailBundle', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.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.

LastBinaryResult As Variant (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

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.

LastMethodSuccess As Long

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStringResult As String (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

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.5.0.63"

Methods

AddEmail(email As ChilkatEmail) As Long

Adds an email object to the bundle.

Returns 1 for success, 0 for failure.

AddMimeBytes(mimeBytesOrText As Variant) 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 ChilkatEmail

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

Returns Nothing on failure

GetEmail(ByVal index As Long) As ChilkatEmail

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 Nothing on failure

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.

Returns Nothing on failure

GetXml() As String

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

Returns Nothing on failure

LoadTaskResult(task As ChilkatTask) As Long

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 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 ChilkatEmail) 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(ByVal 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(ByVal ascending As Long)

Sorts emails in the bundle by date.

SortByRecipient(ByVal ascending As Long)

Sorts emails in the bundle by recipient.

SortBySender(ByVal ascending As Long)

Sorts emails in the bundle by sender.

SortBySubject(ByVal ascending As Long)

Sorts emails in the bundle by subject.