Mailboxes SQL Server Reference Documentation
Mailboxes
Current Version: 11.6.0
Chilkat.Mailboxes
Receive the read-only list of IMAP mailboxes populated by
Use the mailbox count and index-based methods to retrieve each mailbox
name in the returned collection.
Inspect IMAP flags associated with each mailbox, including standard and
server-specific attributes.
Determine whether a mailbox can be selected and opened for message
access.
Check whether a mailbox has child mailboxes or whether children may be
created beneath it.
Detect whether a mailbox is marked or unmarked according to the
attributes returned by the IMAP server.
For an extended overview, see
Mailboxes Class Overview.
Inspect IMAP mailbox names and attributes returned by Chilkat.Imap.
Chilkat.Mailboxes is a read-only result collection populated by
Chilkat.Imap.MbxList. Applications inspect the returned mailbox
names and attributes but do not directly add, remove, or modify entries. The
class provides indexed access to mailbox flags, selectable status, marked
status, whether child mailboxes exist, and whether child mailboxes may be
created.
Mailbox collection
Chilkat.Imap.MbxList.
Indexed mailbox access
Mailbox flags
Selectable status
Hierarchy information
Marked status
Chilkat.Imap.MbxList to populate a
Mailboxes object, loop from 0 to
Count - 1, retrieve each mailbox name, and inspect its flags or
selectable status. Mailbox names are exposed as normal Unicode text; Chilkat
automatically handles modified UTF-7 or IMAP UTF-8 at the protocol level.
Object Creation
DECLARE @hr int
DECLARE @mailboxes int
EXEC @hr = sp_OACreate 'Chilkat.Mailboxes', @mailboxes OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
-- ... use @mailboxes ...
EXEC @hr = sp_OADestroy @mailboxesT-SQL uses the Chilkat ActiveX through the OLE Automation stored procedures. They must be enabled once on the server (EXEC sp_configure 'Ole Automation Procedures', 1; RECONFIGURE;), and the Chilkat ActiveX registered must match the bitness of the SQL Server instance (64-bit for a 64-bit SQL Server). To bind to a specific major version of Chilkat, append the major version number to the ProgID, such as sp_OACreate 'Chilkat.Mailboxes.11' for Chilkat v11.*.*.
sp_OACreate returns an object token (an int) that is passed as the first argument of every sp_OAMethod, sp_OAGetProperty and sp_OASetProperty call, and released with sp_OADestroy. Objects returned by methods (such as an HttpResponse or JsonObject) are also tokens received through an int OUT parameter; they must likewise be destroyed, and the OUT parameter is NULL when the method fails to return an object. Objects passed as arguments are passed by their token. When an OLE Automation procedure itself fails (non-zero @hr), sp_OAGetErrorInfo describes the error.
Data types: strings are nvarchar(4000); integers, booleans (1 or 0) and object tokens are int; dates are datetime. In the signatures on this page, @success, @iResult, @sResult and the like are the OUT variables receiving a method's return value, @iValue / @sValue receive or supply a property value, and the remaining @ variables are the method's arguments in order.
A string returned through an OUT parameter is limited to 4000 characters. For longer values, retrieve the result as a result set into a table variable instead of an OUT parameter, for example DECLARE @tmp TABLE (outputLine ntext) followed by INSERT INTO @tmp EXEC sp_OAGetProperty @mailboxes, 'LastErrorText'. See string length limitations for strings returned by sp_OAMethod calls.
Methods that pass or return raw byte arrays are not shown on this page, because varbinary(max) values cannot be exchanged through sp_OAMethod (see varbinary(max) limitation). Use the BinData-based alternatives (methods ending in Bd) or the base64 / hex string-encoded variants instead. Binary properties (such as LastBinaryResult) can be retrieved as a result set into a table variable, as shown in their signatures. Asynchronous (*Async) methods and event callbacks are not available from SQL Server.
Properties
Count
Returns the number of mailboxes in this collection. An empty collection has a count of 0.
Mailboxes is a read-only result container populated by Imap.MbxList. Applications inspect the returned entries but do not directly add, remove, or modify mailboxes in this object.
DebugLogFilePath
EXEC sp_OASetProperty @mailboxes, 'DebugLogFilePath', @sValue
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.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to 1. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
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
EXEC sp_OASetProperty @mailboxes, 'LastMethodSuccess', @iValue
Indicates the success or failure of the most recent method call: 1 means success, 0 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.
LastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topVerboseLogging
EXEC sp_OASetProperty @mailboxes, 'VerboseLogging', @iValue
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.
Version
Methods
GetFlags
Returns a comma-separated list of flags for the mailbox at the zero-based index specified by index.
For example:
\HasNoChildren,\Important
To inspect the flags individually, use GetNumFlags and GetNthFlag.
Returns NULL on failure
GetMailboxIndex
Returns the zero-based index of the mailbox whose name matches mbxName.
Pass mbxName as a normal Unicode mailbox name. Chilkat automatically handles the protocol-level modified UTF-7 or IMAP UTF-8 representation; the application should not encode the mailbox name manually.
The returned index can be used with methods such as GetName, GetFlags, and IsSelectable.
GetName
Returns the name of the mailbox at the zero-based index specified by index.
The name is returned as normal Unicode text. Chilkat automatically decodes modified UTF-7 or IMAP UTF-8 mailbox names received from the server and automatically performs the corresponding encoding when the name is passed to an Imap method.
The returned name can therefore be passed directly to methods that select, examine, create, rename, delete, copy to, or otherwise operate on a mailbox. Do not manually encode or decode the mailbox name.
Returns NULL on failure
GetNthFlag
Returns one flag from a mailbox in the collection.
indexis the zero-based mailbox index.flagIndexis the zero-based flag index within that mailbox.
Call GetNumFlags to determine the number of flags available for the mailbox.
Returns NULL on failure
GetNumFlags
Returns the number of flags associated with the mailbox at the zero-based index specified by index.
Returns -1 if index is outside the valid mailbox-index range. Use GetNthFlag to retrieve the individual flags.
HasFlag
Returns 1 if the mailbox at the zero-based index specified by index contains the flag named by flagName.
Flag-name comparison is case-insensitive. Include the leading backslash when checking an IMAP system flag or mailbox attribute, for example \Marked, \Noselect, or \HasChildren.
HasInferiors
Returns 1 if the mailbox at the zero-based index specified by index either has child mailboxes or permits child mailboxes to be created beneath it.
\HasNoChildren means that no child mailboxes currently exist. It does not mean that children cannot be created. The IMAP \Noinferiors attribute means that child mailboxes cannot be created.
IsMarked
Returns 1 if the mailbox at the zero-based index specified by index has the IMAP \Marked attribute.
\Marked is a server-provided hint that the mailbox may contain messages added since it was last selected. It is advisory information returned by the mailbox-listing operation.
IsSelectable
Returns 1 if the mailbox at the zero-based index specified by index can be selected or examined for message access.
A mailbox having the IMAP \Noselect attribute is not selectable, even though it may appear in the mailbox hierarchy and may contain selectable child mailboxes.