EmailBundle Swift Reference Documentation

CkoEmailBundle

Current Version: 10.1.0

Requires Chilkat Bundle License

Represents a collection of Email objects.

Object Creation

let obj = CkoEmailBundle()!

Properties

DebugLogFilePath

debugLogFilePath: 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

Example showing how to use DebugLogFilePath.

LastErrorHtml

lastErrorHtml: 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: 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: 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: Bool

Indicates the success or failure of the most recent method call: true means success, false 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.

MessageCount

messageCount: Int (read-only)

The number of emails in this bundle.

VerboseLogging

verboseLogging: Bool

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

version: String! (read-only)

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddEmail

add(email: CkoEmail) -> Bool

Adds an email object to the bundle.

Returns true for success, false for failure.

FindByHeader

find(byHeader: String, value: String) -> CkoEmail

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

getEmail(index: Int) -> CkoEmail

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

getUidls() -> CkoStringArray

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

getXml() -> String

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

Returns nil on failure

LoadTaskResult

loadTaskResult(task: CkoTask) -> Bool

Introduced in version 9.5.0.52

Loads the email bundle from a completed asynchronous task.

Returns true for success, false for failure.

LoadXml

loadXml(path: String) -> Bool

Loads an email bundle from an XML file.

Returns true for success, false for failure.

LoadXmlString

loadXmlString(xmlStr: String) -> Bool

Loads an email bundle from an XML string.

Returns true for success, false for failure.

RemoveEmail

remove(email: CkoEmail) -> Bool

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

Returns true for success, false for failure.

RemoveEmailByIndex

removeEmail(byIndex: Int) -> Bool

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

Returns true for success, false for failure.

SaveXml

saveXml(path: String) -> Bool

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

sort(byDate: Bool)

Sorts emails in the bundle by date.

SortByRecipient

sort(byRecipient: Bool)

Sorts emails in the bundle by recipient.

SortBySender

sort(bySender: Bool)

Sorts emails in the bundle by sender.

SortBySubject

sort(bySubject: Bool)

Sorts emails in the bundle by subject.