EmailBundle ActiveX Reference Documentation

EmailBundle

Current Version: 10.1.2

Requires Chilkat Bundle License

Represents a collection of Email objects.

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.EmailBundle" instead of "Chilkat.EmailBundle"
For a specific major version, use "Chilkat.EmailBundle.<major_version>", such as "Chilkat.EmailBundle.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

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

(AutoIt)
$obj = ObjCreate("Chilkat.EmailBundle")

(Visual Basic 6.0)
Dim obj As New ChilkatEmailBundle

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

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

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

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

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

(Javascript)
var obj = new ActiveXObject("Chilkat.EmailBundle");

Properties

DebugLogFilePath

DebugLogFilePath As String

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

(AutoIt) Example showing how to use DebugLogFilePath.(Classic ASP) Example showing how to use DebugLogFilePath.(PowerBuilder) Example showing how to use DebugLogFilePath.(SQL Server) Example showing how to use DebugLogFilePath.(VBScript) Example showing how to use DebugLogFilePath.(Visual Basic 6.0) Example showing how to use DebugLogFilePath.(Visual FoxPro) Example showing how to use DebugLogFilePath.

LastBinaryResult

LastBinaryResult As Variant (read-only)

This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.

LastErrorHtml

LastErrorHtml As String (read-only)

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

LastErrorText As String (read-only)

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

LastErrorXml As String (read-only)

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

LastMethodSuccess As Long

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.

LastStringResult

LastStringResult As String (read-only)

In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

LastStringResultLen As Long (read-only)

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

MessageCount

MessageCount As Long (read-only)

The number of emails in this bundle.

VerboseLogging

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

Version As String (read-only)

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

More Information and Examples

(AutoIt) How to get the Chilkat version at runtime.(Classic ASP) How to get the Chilkat version at runtime.(PowerBuilder) How to get the Chilkat version at runtime.(SQL Server) How to get the Chilkat version at runtime.(VBScript) How to get the Chilkat version at runtime.(Visual Basic 6.0) How to get the Chilkat version at runtime.(Visual FoxPro) How to get the Chilkat version at runtime.

Methods

AddEmail

AddEmail(email As ChilkatEmail) As Long

Adds an email object to the bundle.

Returns 1 for success, 0 for failure.

AddMimeBytes

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

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

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

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

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

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

LoadXml(filename As String) As Long

Loads an email bundle from an XML file.

Returns 1 for success, 0 for failure.

LoadXmlString

LoadXmlString(xmlStr As String) As Long

Loads an email bundle from an XML string.

Returns 1 for success, 0 for failure.

RemoveEmail

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

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

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

SortByDate(ByVal ascending As Long)

Sorts emails in the bundle by date.

SortByRecipient

SortByRecipient(ByVal ascending As Long)

Sorts emails in the bundle by recipient.

SortBySender

SortBySender(ByVal ascending As Long)

Sorts emails in the bundle by sender.

SortBySubject

SortBySubject(ByVal ascending As Long)

Sorts emails in the bundle by subject.