PureBasic

Outlook -- Copy Mail Folder and Contents to another Mail Folder

See more Outlook Examples

Copy a mailfolder and its contents to another mailfolder.

This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

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 copy /Inbox/abc/subFolderA and its contents to /Inbox/xyz
    ; We'll need the folder ids for both source and destination folders..

    ; Get the folder IDs 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)

    ; Get the IDs for the source and destination folders.
    srcFolderId.s = CkHashtable::ckLookupStr(htFolderMap,"/Inbox/abc/subFolderA")
    If CkHashtable::ckLastMethodSuccess(htFolderMap) <> 1
        Debug "Folder ID not found"
        CkHttp::ckDispose(http)
        CkHashtable::ckDispose(htFolderMap)
        CkStringBuilder::ckDispose(sbMap)
        ProcedureReturn
    EndIf

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

    ; Create a JSON request body with this content:
    ; 
    ; 		{
    ; 		  "DestinationId": "destinationId-value"
    ; 		}

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

    CkJsonObject::ckUpdateString(jsonRequestBody,"DestinationId",dstFolderId)

    CkHttp::ckSetUrlVar(http,"src_folder_id",srcFolderId)

    ; Copy the source folder to the new 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/{$src_folder_id}/copy",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 CkHttpResponse::ckStatusCode(resp) = 201
        Debug "Folder copied."
    Else
        Debug "Response status code = " + Str(CkHttpResponse::ckStatusCode(resp))
        Debug "Error: Folder not copied."
    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#mailFolder",
    ; 	  "@odata.type": "#microsoft.graph.mailFolder",
    ; 	  "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAM6JqMAAAAA=",
    ; 	  "displayName": "subFolderA",
    ; 	  "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwEAAAA=",
    ; 	  "childFolderCount": 1,
    ; 	  "unreadItemCount": 0,
    ; 	  "totalItemCount": 0
    ; 	}


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


    ProcedureReturn
EndProcedure