Sample code for 30+ languages & platforms
PowerBuilder Requires Chilkat v11.0.0+

Subscribe to Mailboxes and List Subscribed Mailboxes

See more IMAP Examples

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

Chilkat PowerBuilder Downloads

PowerBuilder
integer li_rc
integer li_Success
oleobject loo_Imap
string ls_RefName
string ls_WildcardedMailbox
integer li_Subscribed
oleobject loo_Mboxes
integer i

li_Success = 0

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

loo_Imap = create oleobject
li_rc = loo_Imap.ConnectToNewObject("Chilkat.Imap")
if li_rc < 0 then
    destroy loo_Imap
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  Connect to an IMAP server.
//  Use TLS
loo_Imap.Ssl = 1
loo_Imap.Port = 993
li_Success = loo_Imap.Connect("imap.example.com")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

//  Login
li_Success = loo_Imap.Login("myLogin","myPassword")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    return
end if

//  First examine the already subscribed mailboxes.
ls_RefName = ""
ls_WildcardedMailbox = "*"
li_Subscribed = 1

loo_Mboxes = create oleobject
li_rc = loo_Mboxes.ConnectToNewObject("Chilkat.Mailboxes")

li_Success = loo_Imap.MbxList(li_Subscribed,ls_RefName,ls_WildcardedMailbox,loo_Mboxes)
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    destroy loo_Mboxes
    return
end if

i = 0
do while i < loo_Mboxes.Count
    Write-Debug loo_Mboxes.GetName(i)
    i = i + 1
loop
Write-Debug "----"

//  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".
li_Success = loo_Imap.Unsubscribe("INBOX/misc/solutions")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    destroy loo_Mboxes
    return
end if

//  Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
li_Success = loo_Imap.MbxList(li_Subscribed,"","INBOX/misc*",loo_Mboxes)
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    destroy loo_Mboxes
    return
end if

i = 0
do while i < loo_Mboxes.Count
    Write-Debug loo_Mboxes.GetName(i)
    i = i + 1
loop
Write-Debug "----"

//  Re-subscribe to "INBOX/misc/solutions".
li_Success = loo_Imap.Subscribe("INBOX/misc/solutions")
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    destroy loo_Mboxes
    return
end if

//  Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
li_Success = loo_Imap.MbxList(li_Subscribed,"","INBOX/misc*",loo_Mboxes)
if li_Success = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Imap
    destroy loo_Mboxes
    return
end if

i = 0
do while i < loo_Mboxes.Count
    Write-Debug loo_Mboxes.GetName(i)
    i = i + 1
loop
Write-Debug "----"

//  Disconnect from the IMAP server.
li_Success = loo_Imap.Disconnect()


destroy loo_Imap
destroy loo_Mboxes