MessageSet Chilkat2 PHP Reference Documentation
MessageSet
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Object Creation
use Chilkat2\MessageSet;
try {
$messageSet = new MessageSet();
// ... use $messageSet ...
} 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 MessageSet(['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($messageSet), $messageSet = 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 MyMessageSet extends \Chilkat2\MessageSet); 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\MessageSet') 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
Count
Returns the number of unique message identifiers currently stored in the set. A newly created MessageSet has a count of 0.
The identifiers are maintained in ascending numeric order. They are interpreted as UIDs when HasUids is truefalse
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.
HasUids
Indicates how the numeric identifiers in this message set are interpreted:
truefalse
Changing this property only changes how the existing numeric values are interpreted. It does not convert, validate, reorder, or clear the identifiers.
An IMAP UID is stable only within its mailbox and while that mailbox's UIDVALIDITY remains unchanged. Sequence numbers are temporary and can change when messages are added or expunged.
Set this property consistently before passing a manually constructed message set to an Imap method. The string formats produced by ToCommaSeparatedStr and ToCompactString contain only the numeric values and do not include this setting.
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.
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
ContainsId
Returns true$msgId is present in the message set; otherwise, returns false
The comparison is numeric only. The HasUids setting does not participate in the comparison.
Never throws: false is an answer, not a failure.
FromCompactString
Clears the identifiers currently stored in this object and loads the compact message-set representation in $str. The existing HasUids setting is preserved.
$str is parsed. If parsing fails, the message set remains empty.An empty string succeeds and leaves the set empty. Valid identifiers are unsigned 32-bit decimal values from 1 through 4294967295. The value 0 is not accepted. Values too large for an unsigned 32-bit integer cause the method to fail.
The syntax uses commas to separate values or ranges, and a colon to specify an inclusive ascending range. A single range may contain at most 500,001 identifiers; equivalently, the ending value minus the starting value cannot exceed 500000.
Whitespace is accepted around values, commas, and colons. This includes spaces, tabs, carriage returns, and line feeds. Empty comma-separated elements and unrecognized non-numeric elements are intentionally ignored. If $str is nonempty and no valid identifier is loaded, the method returns false
Descending ranges, ranges containing 0, wildcard ranges such as 1:*, malformed range syntax, oversized ranges, and numeric overflow cause the method to return false
On success, duplicate identifiers are removed and the resulting identifiers are stored in ascending numeric order. The serialized form contains only the numbers and does not indicate whether they are UIDs or sequence numbers.
Use ToCompactString to generate the canonical compact representation.
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.
GetId
Returns the message identifier at the zero-based index specified by $index. Identifiers are returned in ascending numeric order.
If $index is negative or is greater than or equal to Count, this method returns 0xFFFFFFFF.
0xFFFFFFFF can also be stored in the set. Check $index against Count before calling this method when that value could be present.InsertId
Adds $id to the message set and maintains the identifiers in ascending numeric order.
- If
$idis already present, no duplicate is added. - If
$idis0, the set is unchanged. - The value
0xFFFFFFFFis accepted.
The HasUids setting determines whether the stored values are interpreted as UIDs or sequence numbers.
RemoveId
Removes the identifier whose raw numeric value equals $id. If the value is not present, the set is unchanged.
The comparison is numeric only and does not depend on HasUids. The remaining identifiers stay in ascending numeric order.
Subtract
Removes from this message set every identifier whose raw numeric value is present in $msgSet. Values not present in this set are ignored.
The comparison is numeric only; the HasUids values of the two objects are not compared. This object's HasUids value is preserved, and the remaining identifiers stay in ascending numeric order.
Passing the same object as $msgSet clears the set. Passing an empty set leaves this set unchanged.
For meaningful IMAP results, both objects should represent identifiers of the same type and from the same mailbox.
ToCommaSeparatedStr
Returns the unique identifiers as a comma-separated string in ascending numeric order. An empty set returns an empty string.
For example, a set containing the identifiers 1 through 5 returns 1,2,3,4,5.
The returned string contains only the numeric values; it does not include the HasUids setting.
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.
ToCompactString
Returns the unique identifiers in ascending numeric order using compact IMAP message-set syntax. Consecutive identifiers are represented as an inclusive range. An empty set returns an empty string.
The returned string is canonical for the current set: identifiers are unique, sorted, and consecutive runs are compacted. It contains only the numeric values and does not include the HasUids setting.
Use FromCompactString to load this format.
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.