EmailBundle Tcl Reference Documentation

EmailBundle

Current Version: 9.5.0.73

Represents a collection of Email objects.

Object Creation

set myEmailBundle [new CkEmailBundle]

Properties

DebugLogFilePath
string
# ckStr is a CkString
CkEmailBundle_get_DebugLogFilePath $myEmailBundle $ckStr
set strVal [CkEmailBundle_get_debugLogFilePath $myEmailBundle]
CkEmailBundle_put_DebugLogFilePath $myEmailBundle $strVal

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
string
# ckStr is a CkString
CkEmailBundle_get_LastErrorHtml $myEmailBundle $ckStr
set strVal [CkEmailBundle_get_lastErrorHtml $myEmailBundle]

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
string
# ckStr is a CkString
CkEmailBundle_get_LastErrorText $myEmailBundle $ckStr
set strVal [CkEmailBundle_get_lastErrorText $myEmailBundle]

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
string
# ckStr is a CkString
CkEmailBundle_get_LastErrorXml $myEmailBundle $ckStr
set strVal [CkEmailBundle_get_lastErrorXml $myEmailBundle]

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
boolean 1/0
set boolVal [CkEmailBundle_get_LastMethodSuccess $myEmailBundle]
CkEmailBundle_put_LastMethodSuccess $myEmailBundle $boolVal
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.

top
MessageCount
integer
set intVal [CkEmailBundle_get_MessageCount $myEmailBundle]

The number of emails in this bundle.

top
Utf8
boolean 1/0
set boolVal [CkEmailBundle_get_Utf8 $myEmailBundle]
CkEmailBundle_put_Utf8 $myEmailBundle $boolVal

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

top
VerboseLogging
boolean 1/0
set boolVal [CkEmailBundle_get_VerboseLogging $myEmailBundle]
CkEmailBundle_put_VerboseLogging $myEmailBundle $boolVal

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.

top
Version
string
# ckStr is a CkString
CkEmailBundle_get_Version $myEmailBundle $ckStr
set strVal [CkEmailBundle_get_version $myEmailBundle]

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

top

Methods

AddEmail
# email is a CkEmail
set status [CkEmailBundle_AddEmail $email]

Adds an email object to the bundle.

Returns 1 for success, 0 for failure.

top
FindByHeader
# returns a CkEmail
# headerFieldName is a string
# headerFieldValue is a string
set ret_email [CkEmailBundle_FindByHeader $headerFieldName $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
# returns a CkEmail
# index is an integer
set ret_email [CkEmailBundle_GetEmail $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
# returns a CkStringArray
set ret_stringArray [CkEmailBundle_GetUidls]

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
# outXml is a CkString (output)
set status [CkEmailBundle_GetXml $outStr]
set retStr [CkEmailBundle_getXml $myEmailBundle]

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

Returns 1 for success, 0 for failure.

top
LoadTaskResult
# task is a CkTask
set status [CkEmailBundle_LoadTaskResult $task]
Introduced in version 9.5.0.52

Loads the email bundle from a completed asynchronous task.

Returns 1 for success, 0 for failure.

top
LoadXml
# filename is a string
set status [CkEmailBundle_LoadXml $filename]

Loads an email bundle from an XML file.

Returns 1 for success, 0 for failure.

top
LoadXmlString
# xmlStr is a string
set status [CkEmailBundle_LoadXmlString $xmlStr]

Loads an email bundle from an XML string.

Returns 1 for success, 0 for failure.

top
RemoveEmail
# email is a CkEmail
set status [CkEmailBundle_RemoveEmail $email]

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

Returns 1 for success, 0 for failure.

top
RemoveEmailByIndex
# index is an integer
set status [CkEmailBundle_RemoveEmailByIndex $index]

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

Returns 1 for success, 0 for failure.

top
SaveLastError
# path is a string
set status [CkEmailBundle_SaveLastError $path]

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

Returns 1 for success, 0 for failure.

top
SaveXml
# filename is a string
set status [CkEmailBundle_SaveXml $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 1 for success, 0 for failure.

top
SortByDate
# ascending is a boolean
CkEmailBundle_SortByDate $ascending

Sorts emails in the bundle by date.

top
SortByRecipient
# ascending is a boolean
CkEmailBundle_SortByRecipient $ascending

Sorts emails in the bundle by recipient.

top
SortBySender
# ascending is a boolean
CkEmailBundle_SortBySender $ascending

Sorts emails in the bundle by sender.

top
SortBySubject
# ascending is a boolean
CkEmailBundle_SortBySubject $ascending

Sorts emails in the bundle by subject.

top