PureBasic

Outlook -- Create a Mail Folder

See more Outlook Examples

Creates a new mail folder as a child of an existing mail folder. PureBasic

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHashtable.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Use your previously obtained access token here:
    CkHttp::setCkAuthToken(http, "MICROSOFT_GRAPH_ACCESS_TOKEN")

    ; This example will create a new mail folder as a child of /Inbox/abc

    ; Get the existing folder ID from the folder map created by this example 
    htFolderMap.i = CkHashtable::ckCreate()
    If htFolderMap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    sbMap.i = CkStringBuilder::ckCreate()
    If sbMap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckLoadFile(sbMap,"qa_data/outlook/folderMap.xml","utf-8")
    CkHashtable::ckAddFromXmlSb(htFolderMap,sbMap)

    existingFolderId.s = CkHashtable::ckLookupStr(htFolderMap,"/Inbox/abc")
    If CkHashtable::ckLastMethodSuccess(htFolderMap) <> 1
        Debug "Folder ID not found"
        CkHttp::ckDispose(http)
        CkHashtable::ckDispose(htFolderMap)
        CkStringBuilder::ckDispose(sbMap)
        ProcedureReturn
    EndIf

    ; Create a JSON request body with this content:
    ; 
    ; 	{
    ; 	  "displayName": "displayName-value",
    ; 	}

    ; This example will create /Inbox/abc/subFolderC
    jsonRequestBody.i = CkJsonObject::ckCreate()
    If jsonRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(jsonRequestBody,"displayName","subFolderC")

    CkHttp::ckSetUrlVar(http,"folder_id",existingFolderId)

    ; Create the folder "subFolderC" at the specified location.
    resp.i = CkHttpResponse::ckCreate()
    If resp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckHttpJson(http,"POST","https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/childFolders",jsonRequestBody,"application/json",resp)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkHashtable::ckDispose(htFolderMap)
        CkStringBuilder::ckDispose(sbMap)
        CkJsonObject::ckDispose(jsonRequestBody)
        CkHttpResponse::ckDispose(resp)
        ProcedureReturn
    EndIf

    ; A 201 response indicates success.
    If CkHttp::ckLastStatus(http) = 201
        Debug "Folder created."
    Else
        Debug "Response status code = " + Str(CkHttpResponse::ckStatusCode(resp))
        Debug "Error: Folder not created."
    EndIf

    ; Show the response in both cases..
    jsonResponse.i = CkJsonObject::ckCreate()
    If jsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(jsonResponse, 0)
    CkJsonObject::ckLoad(jsonResponse,CkHttpResponse::ckBodyStr(resp))
    Debug CkJsonObject::ckEmit(jsonResponse)

    ; A sample successful JSON response looks like this:

    ; 	{
    ; 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA%3D')/childFolders/$entity",
    ; 	  "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAM6JqMIAAAA=",
    ; 	  "displayName": "subFolderC",
    ; 	  "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
    ; 	  "childFolderCount": 0,
    ; 	  "unreadItemCount": 0,
    ; 	  "totalItemCount": 0
    ; 	}


    CkHttp::ckDispose(http)
    CkHashtable::ckDispose(htFolderMap)
    CkStringBuilder::ckDispose(sbMap)
    CkJsonObject::ckDispose(jsonRequestBody)
    CkHttpResponse::ckDispose(resp)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure