Mailboxes ActiveX Reference Documentation

Mailboxes

Current Version: 11.0.0
Requires Chilkat Bundle License

Represents a collection of IMAP mailboxes.

Object Creation

Note:
For versions of Chilkat < 10.0.0, use "Chilkat_9_5_0.Mailboxes" instead of "Chilkat.Mailboxes"
For a specific major version, use "Chilkat.Mailboxes.<major_version>", such as "Chilkat.Mailboxes.10" for Chilkat v10.*.*
See Chilkat ActiveX Object Creation

(ASP)
set obj = Server.CreateObject("Chilkat.Mailboxes")

(AutoIt)
$obj = ObjCreate("Chilkat.Mailboxes")

(Visual Basic 6.0)
Dim obj As New Mailboxes

(VBScript)
set obj = CreateObject("Chilkat.Mailboxes")

(VBA, such as Excel)
Dim obj As New Mailboxes
See How to Use ActiveX in Excel

(Delphi)
obj := TMailboxes.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat.Mailboxes')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat.Mailboxes")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Mailboxes', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat.Mailboxes");

Properties

Count
Count As Long (read-only)

The number of mailboxes in the collection.

Note: The Mailboxes class is for use with the Chilkat IMAP component.

top
DebugLogFilePath
DebugLogFilePath As 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
(AutoIt) Example showing how to use DebugLogFilePath.(Classic ASP) Example showing how to use DebugLogFilePath.(PowerBuilder) Example showing how to use DebugLogFilePath.(SQL Server) Example showing how to use DebugLogFilePath.(VBScript) Example showing how to use DebugLogFilePath.(Visual Basic 6.0) Example showing how to use DebugLogFilePath.(Visual FoxPro) Example showing how to use DebugLogFilePath.
top
LastBinaryResult
LastBinaryResult As Variant (read-only)

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.

top
LastErrorHtml
LastErrorHtml As 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.

top
LastErrorText
LastErrorText As 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 LastErrorTextLastErrorText Standard Information
top
LastErrorXml
LastErrorXml As 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.

top
LastMethodSuccess
LastMethodSuccess As Long

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.

top
LastStringResult
LastStringResult As String (read-only)

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.

More Information and Examples
Long Strings Returned by ActiveX Methods in SQL Server
top
LastStringResultLen
LastStringResultLen As Long (read-only)

The length, in characters, of the string contained in the LastStringResult property.

top
VerboseLogging
VerboseLogging As Long

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
Version As String (read-only)

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

More Information and Examples
(AutoIt) How to get the Chilkat version at runtime.(Classic ASP) How to get the Chilkat version at runtime.(PowerBuilder) How to get the Chilkat version at runtime.(SQL Server) How to get the Chilkat version at runtime.(VBScript) How to get the Chilkat version at runtime.(Visual Basic 6.0) How to get the Chilkat version at runtime.(Visual FoxPro) How to get the Chilkat version at runtime.
top

Methods

GetFlags
GetFlags(ByVal index As Long) As String

Returns a comma-separated list of flags for the Nth mailbox. For example, "\HasNoChildren,\Important".

Returns Nothing on failure

top
GetMailboxIndex
GetMailboxIndex(mbxName As String) As Long

Returns the index of the mailbox having the specified name.

top
GetName
GetName(ByVal index As Long) As String

The name of the Nth mailbox in this collection. Indexing begins at 0.

Returns Nothing on failure

top
GetNthFlag
GetNthFlag(ByVal index As Long, ByVal flagIndex As Long) As String

Returns the name of the Nth flag for the Mth mailbox. The index is the index of the mailbox. The flagIndex is the index of the flag.

Returns Nothing on failure

top
GetNumFlags
GetNumFlags(ByVal index As Long) As Long

Returns the number of flags for the Nth mailbox. Returns -1 if the index is out of range.

top
HasFlag
HasFlag(ByVal index As Long, flagName As String) As Long

Returns 1 if the Nth mailbox has the specified flag set. The flag name is case insensitive and should begin with a backslash character, such as "\Flagged". The index is the index of the Nth mailbox.

More Information and Examples
(AutoIt) Find the "Sent" IMAP Mailbox(Classic ASP) Find the "Sent" IMAP Mailbox(PowerBuilder) Find the "Sent" IMAP Mailbox(SQL Server) Find the "Sent" IMAP Mailbox(VBScript) Find the "Sent" IMAP Mailbox(Visual Basic 6.0) Find the "Sent" IMAP Mailbox(Visual FoxPro) Find the "Sent" IMAP Mailbox
top
HasInferiors
HasInferiors(ByVal index As Long) As Long

Returns 1 if the Nth mailbox has inferiors (i.e. sub-mailboxes), or if it is possible to create child mailboxes in the future.

Note: the HasNoChildren attribute/flag should not be confused with the IMAP4 [RFC-2060] defined attribute Noinferiors which indicates that no child mailboxes exist now AND none can be created in the future.

More Information and Examples
HasInferiors always True? (Why HasInferiors is Often Misunderstood)
top
IsMarked
IsMarked(ByVal index As Long) As Long

Returns 1 if the Nth mailbox is marked.

top
IsSelectable
IsSelectable(ByVal index As Long) As Long

Returns 1 if the Nth mailbox is selectable.

top
LoadTaskResult
LoadTaskResult(task As ChilkatTask) As Long
Introduced in version 9.5.0.52

Loads the mailboxes object from a completed asynchronous task.

Returns 1 for success, 0 for failure.

top