Chilkat Examples

ChilkatHOME.NET Core C#Android™AutoItCC#C++Chilkat2-PythonCkPythonClassic ASPDataFlexDelphi ActiveXDelphi DLLGoJavaLianjaMono C#Node.jsObjective-CPHP ActiveXPHP ExtensionPerlPowerBuilderPowerShellPureBasicRubySQL ServerSwift 2Swift 3,4,5...TclUnicode CUnicode C++VB.NETVBScriptVisual Basic 6.0Visual FoxProXojo Plugin

Xojo Plugin Examples

Web API Categories

ASN.1
AWS KMS
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Key Vault
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Cloud Signature CSC
Code Signing
Compression
DKIM / DomainKey
DNS
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
EBICS
ECC
Ed25519
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
GMail SMTP/IMAP/POP
Geolocation
Google APIs
Google Calendar
Google Cloud SQL
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text
HTTP

HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
MS Storage Providers
Microsoft Graph
Misc
NTLM
OAuth1
OAuth2
OIDC
Office365
OneDrive
OpenSSL
Outlook
Outlook Calendar
Outlook Contact
PDF Signatures
PEM
PFX/P12
PKCS11
POP3
PRNG
REST
REST Misc
RSA
SCP
SCard
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
ScMinidriver
SharePoint
SharePoint Online
Signing in the Cloud
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl
uncategorized

 

 

 

(Xojo Plugin) Outlook -- List Messages in a Specified Folder

Demonstrates how to list the messages in a particular Outlook mailbox folder.

Note: This example requires Chilkat v9.5.0.67 or greater.

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

Chilkat Xojo Plugin Download

Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim http As New Chilkat.Http

// 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).

http.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

Dim sbResponse As New Chilkat.StringBuilder

// Sends:  GET /users/{user_id | userPrincipalName}/mailFolders/{folder_id}/messages
// Note: It is also possible to use the literal string "me" for the current logged-on user.
// For example: GET /me/mailFolders/{folder_id}/messages

http.ClearUrlVars 
success = http.SetUrlVar("userPrincipalName","chilkatsoft@outlook.com")

// In this example, we'd like to get the messages in the folder "/Inbox/abc",
// 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)
Dim htFolderMap As New Chilkat.Hashtable
Dim sbMap As New Chilkat.StringBuilder
success = sbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
success = htFolderMap.AddFromXmlSb(sbMap)

// Get the ID for the "/Inbox/abc" folder:
Dim folderId As String
folderId = htFolderMap.LookupStr("/Inbox/abc")
If (htFolderMap.LastMethodSuccess <> True) Then
    System.DebugLog("Folder ID not found")
    Return
End If

success = http.SetUrlVar("folder_id",folderId)

// Send the request to list the messages.
Dim success As Boolean
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$folder_id}/messages",sbResponse)
If ((success <> True) And (http.LastStatus = 0)) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim json As New Chilkat.JsonObject
success = json.LoadSb(sbResponse)
json.EmitCompact = False

System.DebugLog("Status code = " + Str(http.LastStatus))
If (http.LastStatus <> 200) Then
    System.DebugLog(json.Emit())
    System.DebugLog("Failed.")
End If

// In my test case, the raw JSON returned is shown below.
// Iterate over the messages to get information about each..

Dim i As Int32
i = 0
Dim numMessages As Int32
numMessages = json.SizeOfArray("value")
While i < numMessages
    json.I = 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..
    Dim messageId As String
    messageId = json.StringOf("value[i].id")
    System.DebugLog("id: " + messageId)

    System.DebugLog("From Name: " + json.StringOf("value[i].from.emailAddress.name"))
    System.DebugLog("From Addr: " + json.StringOf("value[i].from.emailAddress.address"))

    Dim numRecipients As Int32
    numRecipients = json.SizeOfArray("value[i].toRecipients")
    Dim j As Int32
    j = 0
    While j < numRecipients
        json.J = j
        System.DebugLog("To Name: " + json.StringOf("value[i].toRecipients[j].emailAddress.name"))
        System.DebugLog("To Addr: " + json.StringOf("value[i].toRecipients[j].emailAddress.address"))
        j = j + 1
    Wend

    System.DebugLog("Subject: " + json.StringOf("value[i].subject"))
    System.DebugLog("Has Attachments:" + Str(json.BoolOf("value[i].hasAttachments")))

    System.DebugLog("Body Content-Type:" + json.StringOf("value[i].body.contentType"))
    Dim bodyContent As String
    bodyContent = json.StringOf("value[i].body.content")
    // ...

    System.DebugLog("----")

    i = i + 1
Wend

// The output of the above loop:

// id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA==
// From Name: Chilkat Software
// From Addr: support@chilkatsoft.com
// To Name: Chilkat Software
// To Addr: chilkatsoft@outlook.com
// Subject: email with attachments
// Has Attachments:True
// Body Content-Type:html
// ----
// id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2gAAAA==
// From Name: Chilkat Software
// From Addr: support@chilkatsoft.com
// To Name: Chilkat Software
// To Addr: chilkatsoft@outlook.com
// To Name: admin@chilkat.io
// To Addr: admin@chilkat.io
// Subject: Re: Test HTML email with embedded images.
// Has Attachments:False
// Body Content-Type:html
// ----
// id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA==
// From Name: Chilkat Software
// From Addr: support@chilkatsoft.com
// To Name: chilkatsoft@outlook.com
// To Addr: chilkatsoft@outlook.com
// To Name: admin@chilkat.io
// To Addr: admin@chilkat.io
// Subject: Test HTML email with embedded images.
// Has Attachments:False
// Body Content-Type:html
// ----

// ------------------------------------------------------
// This is the raw JSON response:

// {
//   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('chilkatsoft%40outlook.com')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA%3D')/messages",
//   "value": [
//     {
//       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bb\"",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA==",
//       "createdDateTime": "2017-05-10T00:27:40Z",
//       "lastModifiedDateTime": "2017-05-10T00:30:51Z",
//       "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bb",
//       "categories": [
//       ],
//       "receivedDateTime": "2017-05-10T00:27:41Z",
//       "sentDateTime": "2017-05-10T00:27:12Z",
//       "hasAttachments": true,
//       "internetMessageId": "<9a65d233-0882-d346-f405-202a8b1a3acd@chilkatsoft.com>",
//       "subject": "email with attachments",
//       "bodyPreview": "This email has attachments...",
//       "importance": "normal",
//       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
//       "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQABQcNI8CG1xKpGjzxJTpoOE=",
//       "isDeliveryReceiptRequested": null,
//       "isReadReceiptRequested": false,
//       "isRead": true,
//       "isDraft": false,
//       "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
//       "inferenceClassification": "focused",
//       "body": {
//         "contentType": "html",
//         "content": "<html>...</html>\r\n"
//       },
//       "sender": {
//         "emailAddress": {
//           "name": "Chilkat Software",
//           "address": "support@chilkatsoft.com"
//         }
//       },
//       "from": {
//         "emailAddress": {
//           "name": "Chilkat Software",
//           "address": "support@chilkatsoft.com"
//         }
//       },
//       "toRecipients": [
//         {
//           "emailAddress": {
//             "name": "Chilkat Software",
//             "address": "chilkatsoft@outlook.com"
//           }
//         }
//       ],
//       "ccRecipients": [
//       ],
//       "bccRecipients": [
//       ],
//       "replyTo": [
//       ]
//     },
//     {
//       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bZ\"",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2gAAAA==",
//       "createdDateTime": "2017-05-10T00:25:28Z",
//       "lastModifiedDateTime": "2017-05-10T00:25:44Z",
//       "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bZ",
//       "categories": [
//       ],
//       "receivedDateTime": "2017-05-10T00:25:28Z",
//       "sentDateTime": "2017-05-10T00:25:10Z",
//       "hasAttachments": false,
//       "internetMessageId": "<707ff357-28ea-7ebd-9409-f46d752e871f@chilkatsoft.com>",
//       "subject": "Re: Test HTML email with embedded images.",
//       "bodyPreview": "My reply...",
//       "importance": "normal",
//       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
//       "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQACYVrc_6yptKn9tuOqBiUMQ=",
//       "isDeliveryReceiptRequested": null,
//       "isReadReceiptRequested": false,
//       "isRead": true,
//       "isDraft": false,
//       "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2gAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
//       "inferenceClassification": "focused",
//       "body": {
//         "contentType": "html",
//         "content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body bgcolor=\"#FFFFFF\">...</body>\r\n</html>\r\n"
//       },
//       "sender": {
//         "emailAddress": {
//           "name": "Chilkat Software",
// 
//           "address": "support@chilkatsoft.com"
//         }
//       },
//       "from": {
//         "emailAddress": {
//           "name": "Chilkat Software",
//           "address": "support@chilkatsoft.com"
//         }
//       },
//       "toRecipients": [
//         {
//           "emailAddress": {
//             "name": "Chilkat Software",
//             "address": "chilkatsoft@outlook.com"
//           }
//         },
//         {
//           "emailAddress": {
//             "name": "admin@chilkat.io",
//             "address": "admin@chilkat.io"
//           }
//         }
//       ],
//       "ccRecipients": [
//         {
//           "emailAddress": {
//             "name": "Matt Smith",
//             "address": "chilkat.support@gmail.com"
//           }
//         }
//       ],
//       "bccRecipients": [
//       ],
//       "replyTo": [
//       ]
//     },
//     {
//       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bY\"",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA==",
//       "createdDateTime": "2017-05-10T00:22:23Z",
//       "lastModifiedDateTime": "2017-05-10T00:22:45Z",
//       "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bY",
//       "categories": [
//       ],
//       "receivedDateTime": "2017-05-10T00:22:23Z",
//       "sentDateTime": "2017-05-10T00:22:03Z",
//       "hasAttachments": false,
//       "internetMessageId": "<4da724c6-fa94-5516-81d5-9cdf152eddc5@chilkatsoft.com>",
//       "subject": "Test HTML email with embedded images.",
//       "bodyPreview": "This is a test email with images...",
//       "importance": "normal",
//       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
//       "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQACYVrc_6yptKn9tuOqBiUMQ=",
//       "isDeliveryReceiptRequested": null,
//       "isReadReceiptRequested": false,
//       "isRead": true,
//       "isDraft": false,
//       "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
//       "inferenceClassification": "focused",
//       "body": {
//         "contentType": "html",
//         "content": "<html>...</html>\r\n"
//       },
//       "sender": {
//         "emailAddress": {
//           "name": "Chilkat Software",
//           "address": "support@chilkatsoft.com"
//         }
//       },
//       "from": {
//         "emailAddress": {
//           "name": "Chilkat Software",
//           "address": "support@chilkatsoft.com"
//         }
//       },
//       "toRecipients": [
//         {
//           "emailAddress": {
//             "name": "chilkatsoft@outlook.com",
//             "address": "chilkatsoft@outlook.com"
//           }
//         },
//         {
//           "emailAddress": {
//             "name": "admin@chilkat.io",
//             "address": "admin@chilkat.io"
//           }
//         }
//       ],
//       "ccRecipients": [
//         {
//           "emailAddress": {
//             "name": "Matt Smith",
//             "address": "chilkat.support@gmail.com"
//           }
//         }
//       ],
//       "bccRecipients": [
//       ],
//       "replyTo": [
//       ]
//     }
//   ]
// 
// }

 

© 2000-2024 Chilkat Software, Inc. All Rights Reserved.