DataFlex
DataFlex
Outlook -- List Selected Fields in Messages
See more Outlook Examples
Demonstrates how to list the messages in a particular Outlook mailbox folder, but selects particular fields to be returned.This uses the OData $select system query option. See OData System Query Option $select for general information.
Also see OData URL Conventions for information about $select and other query options.
Note: This example requires Chilkat v9.5.0.68 or greater.
This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoHttp
Variant vSbResponse
Handle hoSbResponse
Handle hoHtFolderMap
Variant vSbMap
Handle hoSbMap
String sFolderId
Handle hoJson
Integer i
Integer iNumMessages
String sMessageId
String sTemp1
Integer iTemp1
Boolean bTemp1
Move False To iSuccess
// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Use your previously obtained access token here:
// See the following examples for getting an access token:
// Get Microsoft Graph OAuth2 Access Token (Azure AD v2.0 Endpoint).
// Get Microsoft Graph OAuth2 Access Token (Azure AD Endpoint).
// Refresh Access Token (Azure AD v2.0 Endpoint).
// Refresh Access Token (Azure AD Endpoint).
Set ComAuthToken Of hoHttp To "MICROSOFT_GRAPH_ACCESS_TOKEN"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponse
If (Not(IsComObjectCreated(hoSbResponse))) Begin
Send CreateComObject of hoSbResponse
End
// In this example, we'd like to get the messages in the folder "/Inbox",
// but we must specify the corresponding folder_id. The best way to do this is to create
// a local map of folderPaths-to-folderIds.
// This example does it: Create Outlook Folder Map)
Get Create (RefClass(cComChilkatHashtable)) To hoHtFolderMap
If (Not(IsComObjectCreated(hoHtFolderMap))) Begin
Send CreateComObject of hoHtFolderMap
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbMap
If (Not(IsComObjectCreated(hoSbMap))) Begin
Send CreateComObject of hoSbMap
End
Get ComLoadFile Of hoSbMap "qa_data/outlook/folderMap.xml" "utf-8" To iSuccess
Get pvComObject of hoSbMap to vSbMap
Get ComAddFromXmlSb Of hoHtFolderMap vSbMap To iSuccess
// Get the ID for the "/Inbox" folder:
Get ComLookupStr Of hoHtFolderMap "/Inbox" To sFolderId
Get ComLastMethodSuccess Of hoHtFolderMap To bTemp1
If (bTemp1 <> True) Begin
Showln "Folder ID not found"
Procedure_Return
End
Get ComSetUrlVar Of hoHttp "folder_id" sFolderId To iSuccess
// Send the request to list the messages, returning only the subject and from address.
Get pvComObject of hoSbResponse to vSbResponse
Get ComQuickGetSb Of hoHttp "https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$select=subject,from" vSbResponse To iSuccess
Get ComLastStatus Of hoHttp To iTemp1
If ((iSuccess <> True) And (iTemp1 = 0)) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get pvComObject of hoSbResponse to vSbResponse
Get ComLoadSb Of hoJson vSbResponse To iSuccess
Set ComEmitCompact Of hoJson To False
Get ComLastStatus Of hoHttp To iTemp1
Showln "Status code = " iTemp1
Get ComLastStatus Of hoHttp To iTemp1
If (iTemp1 <> 200) Begin
Get ComEmit Of hoJson To sTemp1
Showln sTemp1
Showln "Failed."
End
Get ComEmit Of hoJson To sTemp1
Showln sTemp1
// In my test case, the raw JSON returned is shown below.
// Iterate over the messages to get information about each..
Move 0 To i
Get ComSizeOfArray Of hoJson "value" To iNumMessages
While (i < iNumMessages)
Set ComI Of hoJson To i
// This is the id for the email message.
// For REST API calls that require particular email message id, this is what should be used..
Get ComStringOf Of hoJson "value[i].id" To sMessageId
Showln "id: " sMessageId
Get ComStringOf Of hoJson "value[i].from.emailAddress.name" To sTemp1
Showln "From Name: " sTemp1
Get ComStringOf Of hoJson "value[i].from.emailAddress.address" To sTemp1
Showln "From Addr: " sTemp1
Get ComStringOf Of hoJson "value[i].subject" To sTemp1
Showln "Subject: " sTemp1
Showln "--"
Move (i + 1) To i
Loop
// The output of the above loop:
//
// id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1oAAAA=
// From Name: Chilkat Software
// From Addr: admin@chilkat.io
// Subject: This is an example email from chilkat.io
// --
// id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1kAAAA=
// From Name: Chilkat Support
// From Addr: chilkat.support@gmail.com
// Subject: Hello from GMail
// --
// id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAHrLra8AAAA=
// From Name: Microsoft Office 365
// From Addr: MicrosoftOffice365@email.office.com
// Subject: The latest for you in Office 365
// --
// id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_EAAAA=
// From Name: Amazon Web Services
// From Addr: no-reply-aws@amazon.com
// Subject: Amazon SES Address Verification Request in region US West (Oregon)
// --
// id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_AAAAA=
// From Name: Amazon Web Services
// From Addr: no-reply-aws@amazon.com
// Subject: Amazon SES Address Verification Request in region US West (Oregon)
// --
// id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAAG6l8UAAAA=
// From Name: Microsoft
// From Addr: msa@communication.microsoft.com
// Subject: Updates to our terms of use and privacy statement
// --
//
// ------------------------------------------------------
// This is the raw JSON response:
// {
// "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA')/messages(subject,from)",
// "value": [
// {
// "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfo\"",
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1oAAAA=",
// "subject": "This is an example email from chilkat.io",
// "from": {
// "emailAddress": {
// "name": "Chilkat Software",
// "address": "admin@chilkat.io"
// }
// }
// },
// {
// "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfn\"",
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1kAAAA=",
// "subject": "Hello from GMail",
// "from": {
// "emailAddress": {
// "name": "Chilkat Support",
// "address": "chilkat.support@gmail.com"
// }
// }
// },
// {
// "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAB63d8O\"",
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAHrLra8AAAA=",
// "subject": "The latest for you in Office 365",
// "from": {
// "emailAddress": {
// "name": "Microsoft Office 365",
// "address": "MicrosoftOffice365@email.office.com"
// }
// }
// },
// {
// "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAA1jyl7\"",
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_EAAAA=",
// "subject": "Amazon SES Address Verification Request in region US West (Oregon)",
// "from": {
// "emailAddress": {
// "name": "Amazon Web Services",
// "address": "no-reply-aws@amazon.com"
// }
// }
// },
// {
// "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAA1jyl6\"",
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_AAAAA=",
// "subject": "Amazon SES Address Verification Request in region US West (Oregon)",
// "from": {
// "emailAddress": {
// "name": "Amazon Web Services",
// "address": "no-reply-aws@amazon.com"
// }
// }
// },
// {
// "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAAGt5YG\"",
// "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAAG6l8UAAAA=",
// "subject": "Updates to our terms of use and privacy statement",
// "from": {
// "emailAddress": {
// "name": "Microsoft",
// "address": "msa@communication.microsoft.com"
// }
// }
// }
// ]
// }
End_Procedure