(VBScript) List IMAP Mailboxes with Reference

Demonstrates how to list all sub-mailboxes within a specified context. In this case, we list all mailboxes under "INBOX.vendors".

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Imap")
set imap = CreateObject("Chilkat.Imap")

' Connect to an IMAP server.
' Use TLS
imap.Ssl = 1
imap.Port = 993
success = imap.Connect("imap.someMailServer.com")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' Login
success = imap.Login("admin@chilkatsoft.com","myPassword")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' The ListMailboxes method returns a Mailboxes object
' that contains the collection of mailboxes.
' It accepts two arguments: a refName and a wildcardedMailbox.

' List all mailboxes under INBOX.vendors
refName = "INBOX.vendors"

' Select all mailboxes matching this pattern:
wildcardedMailbox = "*"

' mboxes is a Chilkat.Mailboxes
Set mboxes = imap.ListMailboxes(refName,wildcardedMailbox)
If (imap.LastMethodSuccess = 0) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

i = 0
Do While i < mboxes.Count
    outFile.WriteLine(mboxes.GetName(i))
    i = i + 1
Loop

' Sample output looks like this:
' INBOX.vendors.shareit
' INBOX.vendors.paypal
' INBOX.vendors.dell
' INBOX.vendors.inMotion
' INBOX.vendors.myhosting
' INBOX.vendors.peer1

' Disconnect from the IMAP server.
success = imap.Disconnect()


outFile.Close