(VBScript) Subscribe to Mailboxes and List Subscribed Mailboxes

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox.

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("myLogin","myPassword")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' First examine the already subscribed mailboxes.
refName = ""
wildcardedMailbox = "*"

' Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).
' mboxes is a Chilkat.Mailboxes
Set mboxes = imap.ListSubscribed(refName,wildcardedMailbox)
If (imap.LastMethodSuccess <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

For i = 0 To mboxes.Count - 1
    outFile.WriteLine(mboxes.GetName(i))
Next
outFile.WriteLine("----")

' Sample output.

' INBOX
' INBOX/recent
' INBOX/misc
' INBOX/misc/solutions
' ...
' Outbox
' Deleted Items
' Sent Items
' Drafts
' Junk E-mail
' Trash
' Sent
' Templates

' Let's unsubscribe to "INBOX/misc/solutions".
success = imap.Unsubscribe("INBOX/misc/solutions")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
' mboxes is a Chilkat.Mailboxes
Set mboxes = imap.ListSubscribed("","INBOX/misc*")
If (imap.LastMethodSuccess <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

For i = 0 To mboxes.Count - 1
    outFile.WriteLine(mboxes.GetName(i))
Next

outFile.WriteLine("----")

' Re-subscribe to "INBOX/misc/solutions".
success = imap.Subscribe("INBOX/misc/solutions")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
' mboxes is a Chilkat.Mailboxes
Set mboxes = imap.ListSubscribed("","INBOX/misc*")
If (imap.LastMethodSuccess <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

For i = 0 To mboxes.Count - 1
    outFile.WriteLine(mboxes.GetName(i))
Next

outFile.WriteLine("----")

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

outFile.Close