Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

Perl Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
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
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA Encryption
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(Perl) Outlook -- Search Multiple Folders

I don't yet see how it's possible to do a recursive search of Outlook folders using the Microsoft Graph API. My best guess is to somehow use OData v4.0's $expand query option, but the hierarchical structure of the "mailFolder" and "messages" Microsoft Graph resources don't quite fit. Suggestions are welcome and can be sent to support@chilkatsoft.com.

This example will iterate over a list of folder previously obtained by a recursive traversal of the Outlook mail folders. (See the link in the example code below.)

A separate search is performed on each desired folder, and the results are combined into a single result set.

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 Perl Downloads

Perl Module for Windows, Linux, Alpine Linux,
MAC OS X, Solaris, FreeBSD, OpenBSD,
Raspberry Pi and other single board computers

use chilkat();

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

$http = chilkat::CkHttp->new();

# 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->put_AuthToken("MICROSOFT_GRAPH_ACCESS_TOKEN");

# This example will iterate over the folders previously discovered by recursively traversing the Outlook folders
# as shown in this example:  Outlook Recursive Folder Traversal)

# The XML map produced by the recursive traversal looks like this:

# 	<?xml version="1.0" encoding="utf-8"?>
# 	<hashtable>
# 	<e><k>/Sent Items</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA</v></e>
# 	<e><k>/Inbox</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA</v></e>
# 	<e><k>/Junk Email</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA</v></e>
# 	<e><k>/Inbox/xyz</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwEAAAA=</v></e>
# 	<e><k>/Inbox/abc/subFolderA/a</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAAA=</v></e>
# 	<e><k>/Inbox/abc</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=</v></e>
# 	<e><k>/Outbox</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA</v></e>
# 	<e><k>/Inbox/abc/subFolderA</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwAAAQ==</v></e>
# 	<e><k>/Inbox/abc/subFolderB</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAAA=</v></e>
# 	<e><k>/Archive</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=</v></e>
# 	<e><k>/Deleted Items</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA</v></e>
# 	<e><k>/Drafts</k><v>AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA</v></e>
# 	</hashtable>

# We'll iterate over the folders, and search all folders beginning with "/Inbox" (effectively, we're recursively searching
# everything under Inbox)
$xmlMap = chilkat::CkXml->new();
$success = $xmlMap->LoadXmlFile("qa_data/outlook/folderMap.xml");
if ($success != 1) {
    print "Failed to load XML folder map." . "\r\n";
    exit;
}

# We're going to return just the message id, subject, and FROM name/address.
$http->SetUrlVar("select","id,subject,from");

# Our search will be for emails with the word "sample" in the subject.
$http->SetUrlVar("filter","contains(subject,'sample')");

$json = chilkat::CkJsonObject->new();
$json->put_EmitCompact(0);

$jsonCombined = chilkat::CkJsonObject->new();
$jsonCombined->put_EmitCompact(0);

$sbResponse = chilkat::CkStringBuilder->new();
$sbPath = chilkat::CkStringBuilder->new();
$numFolders = $xmlMap->get_NumChildren();
$i = 0;
$j = 0;
$k = 0;
while ($i < $numFolders) {
    $xmlMap->put_I($i);
    $sbPath->SetString($xmlMap->getChildContent("e[i]|k"));

    if ($sbPath->StartsWith("/Inbox",1) == 1) {

        print "------------------------------------------------------------------" . "\r\n";
        print "Searching " . $sbPath->getAsString() . "\r\n";

        # Search this mail folder..
        $http->SetUrlVar("folder_id",$xmlMap->getChildContent("e[i]|v"));

        $sbResponse->Clear();
        $success = $http->QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",$sbResponse);
        if (($success != 1) and ($http->get_LastStatus() == 0)) {
            print $http->lastErrorText() . "\r\n";
            exit;
        }

        $json->LoadSb($sbResponse);

        if ($http->get_LastStatus() != 200) {
            print "HTTP response status = " . $http->get_LastStatus() . "\r\n";
            print $json->emit() . "\r\n";
            print "Failed." . "\r\n";
            exit;
        }

        print $json->emit() . "\r\n";

        # Each mail folder search will return JSON with a value array, which is non-empty if any matching messages were found:

        # 			{
        # 			  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA')/messages(id,subject,from)",
        # 			  "value": [
        # 				Individual messages, if any, are listed here.
        # 			  ]
        # 			}

        $numMessages = $json->SizeOfArray("value");
        $j = 0;
        while ($j < $numMessages) {
            $json->put_J($j);

            # Add this message to the final result set.
            $jsonCombined->put_K($k);
            $jsonCombined->UpdateString("value[k].folderPath",$sbPath->getAsString());
            $jsonCombined->UpdateString("value[k].id",$json->stringOf("value[j].id"));
            $jsonCombined->UpdateString("value[k].subject",$json->stringOf("value[j].subject"));
            $jsonCombined->UpdateString("value[k].from.emailAddress.name",$json->stringOf("value[j].from.emailAddress.name"));
            $jsonCombined->UpdateString("value[k].from.emailAddress.address",$json->stringOf("value[j].from.emailAddress.address"));
            $k = $k + 1;

            $j = $j + 1;
        }

    }

    $i = $i + 1;
}

# Show the final combined JSON search result.
print "------------------------------------------------------------------" . "\r\n";
print "Combined Search Results:" . "\r\n";
print $jsonCombined->emit() . "\r\n";

# Sample output for the above program:

# ------------------------------------------------------------------
# Searching /Inbox
# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA')/messages(id,subject,from)",
#   "value": [
#     {
#       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfr\"",
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj10AAAA=",
#       "subject": "A sample email with Amazon in the body",
#       "from": {
#         "emailAddress": {
#           "name": "Chilkat Software",
#           "address": "support@chilkatsoft.com"
#         }
#       }
#     }
#   ]
# }
# 
# ------------------------------------------------------------------
# Searching /Inbox/xyz
# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwEAAAA%3D')/messages(id,subject,from)",
#   "value": [
#   ]
# }
# 
# ------------------------------------------------------------------
# Searching /Inbox/abc/subFolderA/a
# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAAA%3D')/messages(id,subject,from)",
#   "value": [
#     {
#       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpzfb\"",
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAADn68XtMop0TpsYJGpfKXY9AAAAzombFQAAAA==",
#       "subject": "Sample email from admin@chilkat.io",
#       "from": {
#         "emailAddress": {
#           "name": "Chilkat Software",
#           "address": "admin@chilkat.io"
#         }
#       }
#     }
#   ]
# }
# 
# ------------------------------------------------------------------
# Searching /Inbox/abc
# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA%3D')/messages(id,subject,from)",
#   "value": [
#   ]
# }
# 
# ------------------------------------------------------------------
# Searching /Inbox/abc/subFolderA
# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwAAAQ%3D%3D')/messages(id,subject,from)",
#   "value": [
#   ]
# }
# 
# ------------------------------------------------------------------
# Searching /Inbox/abc/subFolderB
# {
#   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwMAAAA%3D')/messages(id,subject,from)",
#   "value": [
#   ]
# }
# 
# ------------------------------------------------------------------
# Combined Search Results:
# {
#   "value": [
#     {
#       "folderPath": "/Inbox",
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj10AAAA=",
#       "subject": "A sample email with Amazon in the body",
#       "from": {
#         "emailAddress": {
#           "name": "Chilkat Software",
#           "address": "support@chilkatsoft.com"
#         }
#       }
#     },
#     {
#       "folderPath": "/Inbox/abc/subFolderA/a",
#       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huwIAAADn68XtMop0TpsYJGpfKXY9AAAAzombFQAAAA==",
#       "subject": "Sample email from admin@chilkat.io",
#       "from": {
#         "emailAddress": {
#           "name": "Chilkat Software",
#           "address": "admin@chilkat.io"
#         }
#       }
#     }
#   ]
# }
# 

 

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