SQL Server
SQL Server
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 SQL Server Downloads
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
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).
EXEC sp_OASetProperty @http, 'AuthToken', 'MICROSOFT_GRAPH_ACCESS_TOKEN'
DECLARE @sbResponse int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponse OUT
-- 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)
DECLARE @htFolderMap int
EXEC @hr = sp_OACreate 'Chilkat.Hashtable', @htFolderMap OUT
DECLARE @sbMap int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbMap OUT
EXEC sp_OAMethod @sbMap, 'LoadFile', @success OUT, 'qa_data/outlook/folderMap.xml', 'utf-8'
EXEC sp_OAMethod @htFolderMap, 'AddFromXmlSb', @success OUT, @sbMap
-- Get the ID for the "/Inbox" folder:
DECLARE @folderId nvarchar(4000)
EXEC sp_OAMethod @htFolderMap, 'LookupStr', @folderId OUT, '/Inbox'
EXEC sp_OAGetProperty @htFolderMap, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 <> 1
BEGIN
PRINT 'Folder ID not found'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponse
EXEC @hr = sp_OADestroy @htFolderMap
EXEC @hr = sp_OADestroy @sbMap
RETURN
END
EXEC sp_OAMethod @http, 'SetUrlVar', @success OUT, 'folder_id', @folderId
-- Send the request to list the messages, returning only the subject and from address.
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$select=subject,from', @sbResponse
EXEC sp_OAGetProperty @http, 'LastStatus', @iTmp0 OUT
IF (@success <> 1) and (@iTmp0 = 0)
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponse
EXEC @hr = sp_OADestroy @htFolderMap
EXEC @hr = sp_OADestroy @sbMap
RETURN
END
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'LoadSb', @success OUT, @sbResponse
EXEC sp_OASetProperty @json, 'EmitCompact', 0
EXEC sp_OAGetProperty @http, 'LastStatus', @iTmp0 OUT
PRINT 'Status code = ' + @iTmp0
EXEC sp_OAGetProperty @http, 'LastStatus', @iTmp0 OUT
IF @iTmp0 <> 200
BEGIN
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
END
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
PRINT @sTmp0
-- In my test case, the raw JSON returned is shown below.
-- Iterate over the messages to get information about each..
DECLARE @i int
SELECT @i = 0
DECLARE @numMessages int
EXEC sp_OAMethod @json, 'SizeOfArray', @numMessages OUT, 'value'
WHILE @i < @numMessages
BEGIN
EXEC sp_OASetProperty @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..
DECLARE @messageId nvarchar(4000)
EXEC sp_OAMethod @json, 'StringOf', @messageId OUT, 'value[i].id'
PRINT 'id: ' + @messageId
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'value[i].from.emailAddress.name'
PRINT 'From Name: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'value[i].from.emailAddress.address'
PRINT 'From Addr: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'value[i].subject'
PRINT 'Subject: ' + @sTmp0
PRINT '--'
SELECT @i = @i + 1
END
-- 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"
-- }
-- }
-- }
-- ]
-- }
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponse
EXEC @hr = sp_OADestroy @htFolderMap
EXEC @hr = sp_OADestroy @sbMap
EXEC @hr = sp_OADestroy @json
END
GO