(DataFlex) List Yahoo Mail IMAP Mailboxes

See more Yahoo Mail Examples

List Yahoo Mail mailboxes.

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

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoJson
    Boolean iSuccess
    String sAccessToken
    Handle hoImap
    String sRefName
    String sWildcardedMailbox
    Variant vMboxes
    Handle hoMboxes
    Integer i
    String sTemp1
    Boolean bTemp1

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

    // See Get Yahoo Mail OAuth2 Access Token for Desktop App 
    // for sample code showing how to obtain a Yahoo Mail access token.

    // In this example, our access token was previously saved to the following file which contains JSON like this:
    // {
    //   "access_token": "kCVQdnOdul...LHucA--",
    //   "refresh_token": "AIenVXETSo0jklFBVkPS8vVm8E.Ej9ToRG.xDbDYmZ65WIs5t6CZhDrD",
    //   "expires_in": 3600,
    //   "token_type": "bearer",
    //   "xoauth_yahoo_guid": "HGDQCVF5JB4YDOWHITQJFBHCWA"
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComLoadFile Of hoJson "qa_data/tokens/yahooMail.json" To iSuccess
    If (iSuccess <> True) Begin
        Showln "Failed to load Yahoo Mail access token file."
        Procedure_Return
    End

    Get ComStringOf Of hoJson "access_token" To sAccessToken

    // Do OAuth2 authentication by using the access token as the password in the Login method below...
    Get Create (RefClass(cComChilkatImap)) To hoImap
    If (Not(IsComObjectCreated(hoImap))) Begin
        Send CreateComObject of hoImap
    End

    Set ComSsl Of hoImap To True
    Set ComPort Of hoImap To 993

    // Connect to the Yahoo IMAP server.
    Get ComConnect Of hoImap "imap.mail.yahoo.com" To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Indicate that XOAUTH2 authentication is to be used:
    Set ComAuthMethod Of hoImap To "XOAUTH2"

    // Login
    // Use the email address of the Yahoo Mail account that granted authorization.
    Get ComLogin Of hoImap "user@yahoo.com" sAccessToken To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
    End
    Else Begin
        Showln "Successfully authenticated with Yahoo IMAP using XOAUTH2!"
    End

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

    Move "" To sRefName
    // refName is usually set to an empty string.
    // A non-empty reference name argument is the name of a mailbox or a level of
    // mailbox hierarchy, and indicates the context in which the mailbox
    // name is interpreted.

    // Select all mailboxes matching this pattern:
    Move "*" To sWildcardedMailbox

    Get ComListMailboxes Of hoImap sRefName sWildcardedMailbox To vMboxes
    If (IsComObject(vMboxes)) Begin
        Get Create (RefClass(cComChilkatMailboxes)) To hoMboxes
        Set pvComObject Of hoMboxes To vMboxes
    End
    Get ComLastMethodSuccess Of hoImap To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Move 0 To i
    While (i < (ComCount(hoMboxes)))
        Get ComGetName Of hoMboxes i To sTemp1
        Showln sTemp1
        Move (i + 1) To i
    Loop

    // Sample output looks like this:

    // Archive
    // Bulk Mail
    // Draft
    // Inbox
    // Inbox/emailsWithAttach
    // Inbox/test
    // Sent
    // Trash

    // Disconnect from the IMAP server.
    Get ComDisconnect Of hoImap To iSuccess

    Send Destroy of hoMboxes


End_Procedure