EmailBundle C Reference Documentation

EmailBundle

Current Version: 9.5.0.73

Represents a collection of Email objects.

Create/Dispose

HCkEmailBundle instance = CkEmailBundle_Create();
// ...
CkEmailBundle_Dispose(instance);
HCkEmailBundle CkEmailBundle_Create(void);

Creates an instance of the HCkEmailBundle object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkEmailBundle_Dispose(HCkEmailBundle handle);

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. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkEmailBundle_Dispose.

Properties

DebugLogFilePath
void CkEmailBundle_getDebugLogFilePath(HCkEmailBundle cHandle, HCkString retval);
void CkEmailBundle_putDebugLogFilePath(HCkEmailBundle cHandle, const char *newVal);
const char *CkEmailBundle_debugLogFilePath(HCkEmailBundle cHandle);

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.

top
LastErrorHtml
void CkEmailBundle_getLastErrorHtml(HCkEmailBundle cHandle, HCkString retval);
const char *CkEmailBundle_lastErrorHtml(HCkEmailBundle cHandle);

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.

top
LastErrorText
void CkEmailBundle_getLastErrorText(HCkEmailBundle cHandle, HCkString retval);
const char *CkEmailBundle_lastErrorText(HCkEmailBundle cHandle);

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.

top
LastErrorXml
void CkEmailBundle_getLastErrorXml(HCkEmailBundle cHandle, HCkString retval);
const char *CkEmailBundle_lastErrorXml(HCkEmailBundle cHandle);

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.

top
LastMethodSuccess
BOOL CkEmailBundle_getLastMethodSuccess(HCkEmailBundle cHandle);
void CkEmailBundle_putLastMethodSuccess(HCkEmailBundle cHandle, BOOL newVal);
Introduced in version 9.5.0.52

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.

top
MessageCount
int CkEmailBundle_getMessageCount(HCkEmailBundle cHandle);

The number of emails in this bundle.

top
Utf8
BOOL CkEmailBundle_getUtf8(HCkEmailBundle cHandle);
void CkEmailBundle_putUtf8(HCkEmailBundle cHandle, BOOL newVal);

When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.

top
VerboseLogging
BOOL CkEmailBundle_getVerboseLogging(HCkEmailBundle cHandle);
void CkEmailBundle_putVerboseLogging(HCkEmailBundle cHandle, BOOL newVal);

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.

top
Version
void CkEmailBundle_getVersion(HCkEmailBundle cHandle, HCkString retval);
const char *CkEmailBundle_version(HCkEmailBundle cHandle);

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

top

Methods

AddEmail
BOOL CkEmailBundle_AddEmail(HCkEmailBundle cHandle, HCkEmail email);

Adds an email object to the bundle.

Returns TRUE for success, FALSE for failure.

top
FindByHeader
HCkEmail CkEmailBundle_FindByHeader(HCkEmailBundle cHandle, const char *headerFieldName, const char *headerFieldValue);

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

Returns NULL on failure

top
GetEmail
HCkEmail CkEmailBundle_GetEmail(HCkEmailBundle cHandle, int index);

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

top
GetUidls
HCkStringArray CkEmailBundle_GetUidls(HCkEmailBundle cHandle);

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

top
GetXml
BOOL CkEmailBundle_GetXml(HCkEmailBundle cHandle, HCkString outXml);
const char *CkEmailBundle_getXml(HCkEmailBundle cHandle);

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

Returns TRUE for success, FALSE for failure.

top
LoadTaskResult
BOOL CkEmailBundle_LoadTaskResult(HCkEmailBundle cHandle, HCkTask task);
Introduced in version 9.5.0.52

Loads the email bundle from a completed asynchronous task.

Returns TRUE for success, FALSE for failure.

top
LoadXml
BOOL CkEmailBundle_LoadXml(HCkEmailBundle cHandle, const char *filename);

Loads an email bundle from an XML file.

Returns TRUE for success, FALSE for failure.

top
LoadXmlString
BOOL CkEmailBundle_LoadXmlString(HCkEmailBundle cHandle, const char *xmlStr);

Loads an email bundle from an XML string.

Returns TRUE for success, FALSE for failure.

top
RemoveEmail
BOOL CkEmailBundle_RemoveEmail(HCkEmailBundle cHandle, HCkEmail email);

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

Returns TRUE for success, FALSE for failure.

top
RemoveEmailByIndex
BOOL CkEmailBundle_RemoveEmailByIndex(HCkEmailBundle cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

top
SaveLastError
BOOL CkEmailBundle_SaveLastError(HCkEmailBundle cHandle, const char *path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns TRUE for success, FALSE for failure.

top
SaveXml
BOOL CkEmailBundle_SaveXml(HCkEmailBundle cHandle, const char *filename);

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.

top
SortByDate
void CkEmailBundle_SortByDate(HCkEmailBundle cHandle, BOOL ascending);

Sorts emails in the bundle by date.

top
SortByRecipient
void CkEmailBundle_SortByRecipient(HCkEmailBundle cHandle, BOOL ascending);

Sorts emails in the bundle by recipient.

top
SortBySender
void CkEmailBundle_SortBySender(HCkEmailBundle cHandle, BOOL ascending);

Sorts emails in the bundle by sender.

top
SortBySubject
void CkEmailBundle_SortBySubject(HCkEmailBundle cHandle, BOOL ascending);

Sorts emails in the bundle by subject.

top