EmailBundle Unicode C Reference Documentation

EmailBundle

Current Version: 9.5.0.73

Represents a collection of Email objects.

Create/Dispose

HCkEmailBundleW instance = CkEmailBundleW_Create();
// ...
CkEmailBundleW_Dispose(instance);
HCkEmailBundleW CkEmailBundleW_Create(void);

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

void CkEmailBundleW_Dispose(HCkEmailBundleW handle);

Objects created by calling CkEmailBundleW_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 CkEmailBundleW_Dispose.

Properties

DebugLogFilePath
void CkEmailBundleW_getDebugLogFilePath(HCkEmailBundleW cHandle, HCkString retval);
void CkEmailBundleW_putDebugLogFilePath(HCkEmailBundleW cHandle, const wchar_t *newVal);
const wchar_t *CkEmailBundleW_debugLogFilePath(HCkEmailBundleW 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 CkEmailBundleW_getLastErrorHtml(HCkEmailBundleW cHandle, HCkString retval);
const wchar_t *CkEmailBundleW_lastErrorHtml(HCkEmailBundleW 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 CkEmailBundleW_getLastErrorText(HCkEmailBundleW cHandle, HCkString retval);
const wchar_t *CkEmailBundleW_lastErrorText(HCkEmailBundleW 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 CkEmailBundleW_getLastErrorXml(HCkEmailBundleW cHandle, HCkString retval);
const wchar_t *CkEmailBundleW_lastErrorXml(HCkEmailBundleW 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 CkEmailBundleW_getLastMethodSuccess(HCkEmailBundleW cHandle);
void CkEmailBundleW_putLastMethodSuccess(HCkEmailBundleW 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 CkEmailBundleW_getMessageCount(HCkEmailBundleW cHandle);

The number of emails in this bundle.

top
VerboseLogging
BOOL CkEmailBundleW_getVerboseLogging(HCkEmailBundleW cHandle);
void CkEmailBundleW_putVerboseLogging(HCkEmailBundleW 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 CkEmailBundleW_getVersion(HCkEmailBundleW cHandle, HCkString retval);
const wchar_t *CkEmailBundleW_version(HCkEmailBundleW cHandle);

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

top

Methods

AddEmail
BOOL CkEmailBundleW_AddEmail(HCkEmailBundleW cHandle, HCkEmailW email);

Adds an email object to the bundle.

Returns TRUE for success, FALSE for failure.

top
FindByHeader
HCkEmailW CkEmailBundleW_FindByHeader(HCkEmailBundleW cHandle, const wchar_t *headerFieldName, const wchar_t *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
HCkEmailW CkEmailBundleW_GetEmail(HCkEmailBundleW 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
HCkStringArrayW CkEmailBundleW_GetUidls(HCkEmailBundleW 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 CkEmailBundleW_GetXml(HCkEmailBundleW cHandle, const wchar_t *outXml);
const wchar_t *CkEmailBundleW_getXml(HCkEmailBundleW 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 CkEmailBundleW_LoadTaskResult(HCkEmailBundleW cHandle, HCkTaskW 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 CkEmailBundleW_LoadXml(HCkEmailBundleW cHandle, const wchar_t *filename);

Loads an email bundle from an XML file.

Returns TRUE for success, FALSE for failure.

top
LoadXmlString
BOOL CkEmailBundleW_LoadXmlString(HCkEmailBundleW cHandle, const wchar_t *xmlStr);

Loads an email bundle from an XML string.

Returns TRUE for success, FALSE for failure.

top
RemoveEmail
BOOL CkEmailBundleW_RemoveEmail(HCkEmailBundleW cHandle, HCkEmailW 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 CkEmailBundleW_RemoveEmailByIndex(HCkEmailBundleW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

top
SaveLastError
BOOL CkEmailBundleW_SaveLastError(HCkEmailBundleW cHandle, const wchar_t *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 CkEmailBundleW_SaveXml(HCkEmailBundleW cHandle, const wchar_t *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 CkEmailBundleW_SortByDate(HCkEmailBundleW cHandle, BOOL ascending);

Sorts emails in the bundle by date.

top
SortByRecipient
void CkEmailBundleW_SortByRecipient(HCkEmailBundleW cHandle, BOOL ascending);

Sorts emails in the bundle by recipient.

top
SortBySender
void CkEmailBundleW_SortBySender(HCkEmailBundleW cHandle, BOOL ascending);

Sorts emails in the bundle by sender.

top
SortBySubject
void CkEmailBundleW_SortBySubject(HCkEmailBundleW cHandle, BOOL ascending);

Sorts emails in the bundle by subject.

top