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

Tcl Examples

Web API Categories

ASN.1
AWS Misc
Amazon EC2
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Azure Table Service
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
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
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
Socket/SSL/TLS
Spider
Stream
Tar Archive
ULID/UUID
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Tcl) 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 Tcl Extension Downloads

Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

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

CkHttp_put_AuthToken $http "MICROSOFT_GRAPH_ACCESS_TOKEN"

set sbResponse [new_CkStringBuilder]

# 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

CkHttp_ClearUrlVars $http
CkHttp_SetUrlVar $http "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)
set htFolderMap [new_CkHashtable]

set sbMap [new_CkStringBuilder]

CkStringBuilder_LoadFile $sbMap "qa_data/outlook/folderMap.xml" "utf-8"
CkHashtable_AddFromXmlSb $htFolderMap $sbMap

# Get the ID for the "/Inbox/abc" folder:
set folderId [CkHashtable_lookupStr $htFolderMap "/Inbox/abc"]
if {[CkHashtable_get_LastMethodSuccess $htFolderMap] != 1} then {
    puts "Folder ID not found"
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    exit
}

CkHttp_SetUrlVar $http "folder_id" $folderId

# Send the request to list the messages.
set success [CkHttp_QuickGetSb $http "https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$folder_id}/messages" $sbResponse]
if {expr [$success != 1]  &&  [[CkHttp_get_LastStatus $http] == 0]} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponse
    delete_CkHashtable $htFolderMap
    delete_CkStringBuilder $sbMap
    exit
}

set json [new_CkJsonObject]

CkJsonObject_LoadSb $json $sbResponse
CkJsonObject_put_EmitCompact $json 0

puts "Status code = [CkHttp_get_LastStatus $http]"
if {[CkHttp_get_LastStatus $http] != 200} then {
    puts [CkJsonObject_emit $json]
    puts "Failed."
}

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

set i 0
set numMessages [CkJsonObject_SizeOfArray $json "value"]
while {$i < $numMessages} {
    CkJsonObject_put_I $json $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..
    set messageId [CkJsonObject_stringOf $json "value[i].id"]
    puts "id: $messageId"

    puts "From Name: [CkJsonObject_stringOf $json {value[i].from.emailAddress.name}]"
    puts "From Addr: [CkJsonObject_stringOf $json {value[i].from.emailAddress.address}]"

    set numRecipients [CkJsonObject_SizeOfArray $json "value[i].toRecipients"]
    set j 0
    while {$j < $numRecipients} {
        CkJsonObject_put_J $json $j
        puts "To Name: [CkJsonObject_stringOf $json {value[i].toRecipients[j].emailAddress.name}]"
        puts "To Addr: [CkJsonObject_stringOf $json {value[i].toRecipients[j].emailAddress.address}]"
        set j [expr $j + 1]
    }

    puts "Subject: [CkJsonObject_stringOf $json {value[i].subject}]"
    puts "Has Attachments:[CkJsonObject_BoolOf $json {value[i].hasAttachments}]"

    puts "Body Content-Type:[CkJsonObject_stringOf $json {value[i].body.contentType}]"
    set bodyContent [CkJsonObject_stringOf $json "value[i].body.content"]
    # ...

    puts "----"

    set i [expr $i + 1]
}

# 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": [
#       ]
#     }
#   ]
# 
# }

delete_CkHttp $http
delete_CkStringBuilder $sbResponse
delete_CkHashtable $htFolderMap
delete_CkStringBuilder $sbMap
delete_CkJsonObject $json

 

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