EmailBundle Delphi DLL Reference Documentation

EmailBundle

Current Version: 10.1.0

Requires Chilkat Bundle License

Represents a collection of Email objects.

Create/Dispose

var
myObject: HCkEmailBundle;

begin
myObject := CkEmailBundle_Create();

// ...

CkEmailBundle_Dispose(myObject);
end;

function CkEmailBundle_Create: HCkEmailBundle; stdcall;

Creates an instance of the HCkEmailBundle object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkEmailBundle_Dispose(handle: HCkEmailBundle); stdcall;

Objects created by calling CkEmailBundle_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

DebugLogFilePath

procedure CkEmailBundle_getDebugLogFilePath(objHandle: HCkEmailBundle; outPropVal: HCkString); stdcall;
procedure CkEmailBundle_putDebugLogFilePath(objHandle: HCkEmailBundle; newPropVal: PWideChar); stdcall;
function CkEmailBundle__debugLogFilePath(objHandle: HCkEmailBundle): PWideChar; stdcall;

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:

a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
there is an internal problem (bug) in the Chilkat code that causes the hang.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

procedure CkEmailBundle_getLastErrorHtml(objHandle: HCkEmailBundle; outPropVal: HCkString); stdcall;
function CkEmailBundle__lastErrorHtml(objHandle: HCkEmailBundle): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkEmailBundle_getLastErrorText(objHandle: HCkEmailBundle; outPropVal: HCkString); stdcall;
function CkEmailBundle__lastErrorText(objHandle: HCkEmailBundle): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkEmailBundle_getLastErrorXml(objHandle: HCkEmailBundle; outPropVal: HCkString); stdcall;
function CkEmailBundle__lastErrorXml(objHandle: HCkEmailBundle): PWideChar; stdcall;

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.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkEmailBundle_getLastMethodSuccess(objHandle: HCkEmailBundle): wordbool; stdcall;
procedure CkEmailBundle_putLastMethodSuccess(objHandle: HCkEmailBundle; newPropVal: wordbool); stdcall;

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

MessageCount

function CkEmailBundle_getMessageCount(objHandle: HCkEmailBundle): Integer; stdcall;

The number of emails in this bundle.

VerboseLogging

function CkEmailBundle_getVerboseLogging(objHandle: HCkEmailBundle): wordbool; stdcall;
procedure CkEmailBundle_putVerboseLogging(objHandle: HCkEmailBundle; newPropVal: wordbool); stdcall;

If set to True, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is False. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

procedure CkEmailBundle_getVersion(objHandle: HCkEmailBundle; outPropVal: HCkString); stdcall;
function CkEmailBundle__version(objHandle: HCkEmailBundle): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddEmail

function CkEmailBundle_AddEmail(objHandle: HCkEmailBundle;
email: HCkEmail): wordbool; stdcall;

Adds an email object to the bundle.

Returns True for success, False for failure.

FindByHeader

function CkEmailBundle_FindByHeader(objHandle: HCkEmailBundle;
headerFieldName: PWideChar;
headerFieldValue: PWideChar): HCkEmail; stdcall;

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

Returns nil on failure

GetEmail

function CkEmailBundle_GetEmail(objHandle: HCkEmailBundle;
index: Integer): HCkEmail; stdcall;

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

GetUidls

function CkEmailBundle_GetUidls(objHandle: HCkEmailBundle): HCkStringArray; stdcall;

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

GetXml

function CkEmailBundle_GetXml(objHandle: HCkEmailBundle;
outXml: HCkString): wordbool; stdcall;
function CkEmailBundle__getXml(objHandle: HCkEmailBundle): PWideChar; stdcall;

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

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

LoadTaskResult

function CkEmailBundle_LoadTaskResult(objHandle: HCkEmailBundle;
task: HCkTask): wordbool; stdcall;

Introduced in version 9.5.0.52

Loads the email bundle from a completed asynchronous task.

Returns True for success, False for failure.

LoadXml

function CkEmailBundle_LoadXml(objHandle: HCkEmailBundle;
filename: PWideChar): wordbool; stdcall;

Loads an email bundle from an XML file.

Returns True for success, False for failure.

LoadXmlString

function CkEmailBundle_LoadXmlString(objHandle: HCkEmailBundle;
xmlStr: PWideChar): wordbool; stdcall;

Loads an email bundle from an XML string.

Returns True for success, False for failure.

RemoveEmail

function CkEmailBundle_RemoveEmail(objHandle: HCkEmailBundle;
email: HCkEmail): wordbool; stdcall;

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

Returns True for success, False for failure.

RemoveEmailByIndex

function CkEmailBundle_RemoveEmailByIndex(objHandle: HCkEmailBundle;
index: Integer): wordbool; stdcall;

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

Returns True for success, False for failure.

SaveXml

function CkEmailBundle_SaveXml(objHandle: HCkEmailBundle;
filename: PWideChar): wordbool; stdcall;

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 True for success, False for failure.

SortByDate

procedure CkEmailBundle_SortByDate(objHandle: HCkEmailBundle;
ascending: wordbool) stdcall;

Sorts emails in the bundle by date.

SortByRecipient

procedure CkEmailBundle_SortByRecipient(objHandle: HCkEmailBundle;
ascending: wordbool) stdcall;

Sorts emails in the bundle by recipient.

SortBySender

procedure CkEmailBundle_SortBySender(objHandle: HCkEmailBundle;
ascending: wordbool) stdcall;

Sorts emails in the bundle by sender.

SortBySubject

procedure CkEmailBundle_SortBySubject(objHandle: HCkEmailBundle;
ascending: wordbool) stdcall;

Sorts emails in the bundle by subject.