(Ruby) Outlook -- Delete Email

Demonstrates how to delete email using the Microsoft Graph API.

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

Chilkat Ruby Downloads

install from rubygems.org
gem install chilkat
or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require '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:
http.put_AuthToken("MICROSOFT_GRAPH_ACCESS_TOKEN")

# This example will search /Inbox for a message we want to delete.
# First we need to get the folder ID for /Inbox.
# Then we'll search for messages based on some criteria, and delete the matching messages.

# Get the folder ID for /Inbox from the folder map created by this example 
htFolderMap = Chilkat::CkHashtable.new()
sbMap = Chilkat::CkStringBuilder.new()
sbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
htFolderMap.AddFromXmlSb(sbMap)

# Get the ID for the "/Inbox" folder:
folderId = htFolderMap.lookupStr("/Inbox")
if (htFolderMap.get_LastMethodSuccess() != true)
    print "Folder ID not found" + "\n";
    exit
end

success = true
json = Chilkat::CkJsonObject.new()
json.put_EmitCompact(false)

# Search for emails in this folder with the phrase "Amazon SES" in the subject, and return only the id and subject.
http.SetUrlVar("folder_id",folderId)
http.SetUrlVar("select","id,subject")
http.SetUrlVar("filter","contains(subject,'Amazon SES')")

sbResponse = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$filter={$filter}&$select={$select}",sbResponse)
if (success != true)
    print http.lastErrorText() + "\n";
    exit
end

json.LoadSb(sbResponse)
# Show the results..
print json.emit() + "\n";

# Sample results:

# 	{
# 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA')/messages(id,subject)",
# 	  "value": [
# 	    {
# 	      "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAA1jyl6\"",
# 	      "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_AAAAA=",
# 	      "subject": "Amazon SES Address Verification Request in region US West (Oregon)"
# 	    },
# 	    {
# 	      "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAA1jyl7\"",
# 	      "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_EAAAA=",
# 	      "subject": "Amazon SES Address Verification Request in region US West (Oregon)"
# 	    }
# 	  ]
# 	}
# 

# ------------
# Proceed to delete each of the above emails...

i = 0
numEmails = json.SizeOfArray("value")
while i < numEmails
    json.put_I(i)

    messageId = json.stringOf("value[i].id")
    http.SetUrlVar("message_id",messageId)
    print "Deleting " + messageId + "\n";
    resp = http.quickDeleteStr("https://graph.microsoft.com/v1.0/me/messages/{$message_id}")
    if (http.get_LastMethodSuccess() != true)
        print http.lastErrorText() + "\n";
        exit
    end

    # A 204 response indicates success.
    if (http.get_LastStatus() == 204)
        print "Message deleted." + "\n";
    else
        print "Message not deleted." + "\n";
        print resp + "\n";
    end

    i = i + 1
end

# Sample output:

# Deleting AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_AAAAA=
# Message deleted.
# Deleting AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_EAAAA=
# Message deleted.
#