EmailBundle Chilkat2 PHP Reference Documentation
EmailBundle
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
EmailBundle
Store multiple
Use the message count and indexed access methods to retrieve individual
emails for inspection, processing, saving, or sending.
Locate a specific email in the collection when application logic needs
to find a matching message.
Sort the bundle by date, sender, recipient, or subject to organize
messages before processing or display.
Remove individual messages by object or index, or clear the entire
bundle when the collection is no longer needed.
Serialize the bundle to XML and reload it later, or load task results
that return an email bundle.
For an extended overview, see
EmailBundle Class Overview.
Hold, search, sort, remove, save, and reload groups of email messages.
EmailBundle is a container for multiple
Email objects. It is commonly returned by mail-related
operations and can also be built manually by adding individual email
messages. The class provides a simple way to work with groups of messages:
retrieve emails by index, search for a matching email, sort by common email
fields, remove messages, clear the bundle, and serialize or reload the
collection as XML.
Email collection
Email objects together after
receiving, loading, filtering, or manually building a message set.
Retrieve messages
Search within the bundle
Sort messages
Remove or clear emails
Save and reload
Email objects, loop from
0 to MessageCount - 1, retrieve each message with
EmailAt, and then inspect, save, sort, remove, or process each
email as needed. Use EmailBundle for the group and
Email for the individual message contents.
Object Creation
use Chilkat2\EmailBundle;
try {
$emailBundle = new EmailBundle();
// ... use $emailBundle ...
} catch (\Chilkat2\Exception $e) {
echo $e->getClass(), '::', $e->getMethod(), " failed\n";
echo $e->getMessage(), "\n"; // the LastErrorText of the failed call
}Creates the object. The optional array sets properties in order, as if assigned one by one (new EmailBundle(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include.
There is no close(): PHP frees the object when its last reference goes (unset($emailBundle), $emailBundle = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyEmailBundle extends \Chilkat2\EmailBundle); objects cannot be cloned or serialized.
When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.
Errors
Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\EmailBundle') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.
Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.
Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.
Properties
DebugLogFilePath
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.
LastErrorHtml
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.
topLastErrorText
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.
LastErrorXml
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.
topLastMethodSuccess
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. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
MessageCount
Returns the number of Email objects currently contained in the bundle.
Valid zero-based indexes range from 0 through MessageCount - 1.
VerboseLogging
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
Methods
AddEmail
Adds an independent copy of the Email object in $email to the end of this in-memory bundle.
The bundle does not retain a reference to $email and does not take ownership of the supplied object. Changes made to $email after this method returns do not affect the copy stored in the bundle, and changes to the stored copy do not affect $email.
The same Email object may be added more than once. Each call adds another independent copy and increases the MessageCount property by one.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
Clear
Removes and discards all emails from this in-memory bundle.
After this method returns, MessageCount is 0. No messages are deleted from any mail server.
EmailAt
Copies the email at the zero-based index in $index into the Email object in $email.
Valid indexes range from 0 through MessageCount - 1. The first email is at index 0.
$email receives an independent copy. Changes made to $email do not modify the email stored in the bundle.
Note: This is an in-memory operation and does not communicate with a mail server.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
FindEmail
Finds the first email in the bundle whose MIME header field matches the search criteria specified by the JsonObject in $json.
At this time, a search may specify only one MIME header field. Use the following JSON format:
{
"header": {
"name": "Subject",
"value": "Dinner on Wednesday?",
"caseInsensitive": true
}
}
header.name specifies the MIME header field name, and header.value specifies the complete field value to match. The field value must match exactly; this is not a substring, wildcard, or regular-expression search. Set header.caseInsensitive to true for a case-insensitive comparison or false for a case-sensitive comparison.
When a match is found, $email receives the first matching email.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetXml
Serializes the entire email bundle to Chilkat XML and returns the XML document as a string.
The XML contains the bundle and its individual Email objects. It can be loaded into another EmailBundle by calling LoadXmlString.
This is Chilkat's XML representation of an email bundle; it is not an RFC 822/MIME message.
On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns null). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
LoadXml
Loads an email bundle from the local filesystem path specified by $path. The path may be absolute or relative; a filename alone refers to a file in the current working directory.
The file should contain Chilkat email-bundle XML previously produced by SaveXml or GetXml.
The emails loaded from $path are appended to the emails already in the bundle. Existing emails are not removed or replaced.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
LoadXmlString
Loads an email bundle from the Chilkat XML string in $xmlStr.
The XML is typically obtained from GetXml or read from a file created by SaveXml.
The emails loaded from $xmlStr are appended to the emails already in the bundle. Existing emails are not removed or replaced.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
RemoveEmail
Removes the first email in this in-memory bundle that matches $email.
Chilkat first searches for an email having the same UIDL as $email. If no email with a matching UIDL is found, it searches for the first email having the same Message-ID header field value. Only the first matching email is removed.
$email may be an independent copy obtained from EmailAt.
Note: This method changes only the local bundle. It does not delete a message from a POP3 or IMAP server.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
RemoveEmailByIndex
Removes the email at the zero-based index in $index.
Valid indexes range from 0 through MessageCount - 1.
Note: This method changes only the local bundle. It does not delete a message from a mail server.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
SaveXml
Serializes the bundle and each contained Email to Chilkat XML, then writes the XML document to the local filesystem path specified by $path. The path may be absolute or relative; a filename alone writes to the current working directory.
Reload the saved bundle by calling LoadXml. Use GetXml when the XML is needed in memory rather than in a file.
The saved file is a Chilkat email-bundle serialization, not an RFC 822/MIME message file.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
SortByDate
Sorts the emails in this bundle by each Email object's EmailDate property.
Set $ascending to true to sort in ascending order, from oldest to newest. Set $ascending to false to sort in descending order, from newest to oldest.
The operation changes the order of the emails in the in-memory collection.
topSortByRecipient
Sorts the emails in this bundle by the full value of each email's To header field.
The comparisons are case-sensitive. Set $ascending to true for ascending order or false for descending order. The operation changes the order of the emails in the in-memory collection.
SortBySender
Sorts the emails in this bundle by the full content of each email's From header field.
Set $ascending to true for ascending order or false for descending order. The operation changes the order of the emails in the in-memory collection.
SortBySubject
Sorts the emails in this bundle by subject.
Set $ascending to true for ascending order or false for descending order. The operation changes the order of the emails in the in-memory collection.