Download a Gmail attachment by filename
See more GMail REST API Examples
Start with a Gmail message ID and the exact filename. Walk the root MIME payload and all nested parts. A unique matching part can contain base64url data directly or an attachment ID for a second request. Duplicate filenames are reported so the application can choose a particular MIME part.
The output path is chosen locally. The example saves to downloaded-attachment.bin and verifies the decoded size. Use an appropriate application-chosen filename or extension when adapting it. Gmail’s filename is treated as a matching value.
Authorize the application with https://www.googleapis.com/auth/gmail.readonly. The example reads the access token from gmail-token.json in a private working directory. Authorize a desktop application.
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
DECLARE @iTmp1 int
DECLARE @sTmp0 nvarchar(4000)
DECLARE @sTmp1 nvarchar(4000)
DECLARE @success int
SELECT @success = 0
-- Assumes Chilkat is unlocked. See Global Unlock Sample.
DECLARE @token int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @token OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
EXEC sp_OAMethod @token, 'LoadFile', @success OUT, 'gmail-token.json'
IF @success <> 1
BEGIN
PRINT 'Could not read gmail-token.json from the private working directory.'
EXEC @hr = sp_OADestroy @token
RETURN
END
EXEC sp_OAMethod @token, 'JsonTypeOf', @iTmp0 OUT, 'access_token'
EXEC sp_OAMethod @token, 'StringOfEquals', @iTmp1 OUT, 'access_token', '', 1
IF (@iTmp0 <> 1) or (@iTmp1 = 1)
BEGIN
PRINT 'An OAuth access token is required.'
EXEC @hr = sp_OADestroy @token
RETURN
END
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
EXEC sp_OASetProperty @http, 'RequireSslCertVerify', 1
EXEC sp_OAMethod @token, 'StringOf', @sTmp0 OUT, 'access_token'
EXEC sp_OASetProperty @http, 'AuthToken', @sTmp0
DECLARE @resp int
EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT
DECLARE @reply int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @reply OUT
DECLARE @messageId nvarchar(4000)
SELECT @messageId = 'GMAIL_MESSAGE_ID'
DECLARE @filename nvarchar(4000)
SELECT @filename = 'attachment.pdf'
DECLARE @messageUrl int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @messageUrl OUT
EXEC sp_OAMethod @messageUrl, 'Append', @success OUT, 'https://gmail.googleapis.com/gmail/v1/users/me/messages/'
EXEC sp_OAMethod @http, 'UrlEncode', @sTmp0 OUT, @messageId
EXEC sp_OAMethod @messageUrl, 'Append', @success OUT, @sTmp0
DECLARE @url int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @url OUT
EXEC sp_OAMethod @messageUrl, 'GetAsString', @sTmp0 OUT
EXEC sp_OAMethod @url, 'Append', @success OUT, @sTmp0
EXEC sp_OAMethod @url, 'Append', @success OUT, '?format=full'
EXEC sp_OAMethod @url, 'GetAsString', @sTmp0 OUT
EXEC sp_OAMethod @http, 'HttpNoBody', @success OUT, 'GET', @sTmp0, @resp
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
PRINT 'Gmail did not return an HTTP response.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp1 OUT
IF (@success <> 1) or (@iTmp0 < 200) or (@iTmp1 >= 300)
BEGIN
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT 'Gmail HTTP ' + @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
EXEC sp_OAMethod @reply, 'Load', @success OUT, @sTmp0
IF @success = 1
BEGIN
EXEC sp_OAMethod @reply, 'StringOf', @sTmp0 OUT, 'error.message'
PRINT @sTmp0
END
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
RETURN
END
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
EXEC sp_OAMethod @reply, 'Load', @success OUT, @sTmp0
IF @success <> 1
BEGIN
PRINT 'Expected a Gmail JSON response.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
RETURN
END
DECLARE @paths int
EXEC @hr = sp_OACreate 'Chilkat.StringTable', @paths OUT
EXEC sp_OAMethod @paths, 'Append', @success OUT, 'payload'
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @paths, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
RETURN
END
DECLARE @part int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @part OUT
DECLARE @selected int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @selected OUT
DECLARE @childPath int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @childPath OUT
DECLARE @matches int
SELECT @matches = 0
DECLARE @p int
SELECT @p = 0
EXEC sp_OAGetProperty @paths, 'Count', @iTmp0 OUT
WHILE (@p < @iTmp0)
BEGIN
EXEC sp_OAMethod @paths, 'StringAt', @sTmp0 OUT, @p
EXEC sp_OAMethod @reply, 'ObjectOf2', @success OUT, @sTmp0, @part
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @reply, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
RETURN
END
EXEC sp_OAMethod @part, 'StringOfEquals', @iTmp0 OUT, 'filename', @filename, 1
IF @iTmp0 = 1
BEGIN
SELECT @matches = @matches + 1
EXEC sp_OAMethod @part, 'MakeCopy', @success OUT, @selected
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @part, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
RETURN
END
EXEC sp_OAMethod @paths, 'StringAt', @sTmp0 OUT, @p
PRINT 'Matching MIME part: ' + @sTmp0
END
DECLARE @j int
SELECT @j = 0
EXEC sp_OAMethod @part, 'SizeOfArray', @iTmp0 OUT, 'parts'
WHILE (@j < @iTmp0)
BEGIN
EXEC sp_OAMethod @paths, 'StringAt', @sTmp0 OUT, @p
EXEC sp_OAMethod @childPath, 'SetString', @success OUT, @sTmp0
EXEC sp_OAMethod @childPath, 'Append', @success OUT, '.parts['
EXEC sp_OAMethod @childPath, 'AppendInt', @success OUT, @j
EXEC sp_OAMethod @childPath, 'Append', @success OUT, ']'
EXEC sp_OAMethod @childPath, 'GetAsString', @sTmp0 OUT
EXEC sp_OAMethod @paths, 'Append', @success OUT, @sTmp0
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @paths, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
RETURN
END
SELECT @j = @j + 1
END
SELECT @p = @p + 1
END
IF @matches <> 1
BEGIN
PRINT 'Expected one filename match. Matches: ' + @matches
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
RETURN
END
DECLARE @body int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @body OUT
EXEC sp_OAMethod @selected, 'ObjectOf2', @success OUT, 'body', @body
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @selected, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
RETURN
END
EXEC sp_OAMethod @body, 'JsonTypeOf', @iTmp0 OUT, 'size'
IF @iTmp0 <> 2
BEGIN
PRINT 'The selected part has no byte count.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
RETURN
END
DECLARE @expectedSize int
EXEC sp_OAMethod @body, 'IntOf', @expectedSize OUT, 'size'
EXEC sp_OAMethod @body, 'JsonTypeOf', @iTmp0 OUT, 'attachmentId'
IF @iTmp0 = 1
BEGIN
EXEC sp_OAMethod @messageUrl, 'GetAsString', @sTmp0 OUT
EXEC sp_OAMethod @url, 'SetString', @success OUT, @sTmp0
EXEC sp_OAMethod @url, 'Append', @success OUT, '/attachments/'
EXEC sp_OAMethod @body, 'StringOf', @sTmp1 OUT, 'attachmentId'
EXEC sp_OAMethod @http, 'UrlEncode', @sTmp0 OUT, @sTmp1
EXEC sp_OAMethod @url, 'Append', @success OUT, @sTmp0
EXEC sp_OAMethod @url, 'GetAsString', @sTmp0 OUT
EXEC sp_OAMethod @http, 'HttpNoBody', @success OUT, 'GET', @sTmp0, @resp
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
PRINT 'Gmail did not return an HTTP response.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp1 OUT
IF (@success <> 1) or (@iTmp0 < 200) or (@iTmp1 >= 300)
BEGIN
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT 'Gmail HTTP ' + @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
EXEC sp_OAMethod @reply, 'Load', @success OUT, @sTmp0
IF @success = 1
BEGIN
EXEC sp_OAMethod @reply, 'StringOf', @sTmp0 OUT, 'error.message'
PRINT @sTmp0
END
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
RETURN
END
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
EXEC sp_OAMethod @reply, 'Load', @success OUT, @sTmp0
IF @success <> 1
BEGIN
PRINT 'Expected a Gmail JSON response.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
RETURN
END
EXEC sp_OAMethod @reply, 'MakeCopy', @success OUT, @body
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @reply, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
RETURN
END
END
EXEC sp_OAMethod @body, 'JsonTypeOf', @iTmp0 OUT, 'data'
IF @iTmp0 <> 1
BEGIN
PRINT 'The attachment response has no data.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
RETURN
END
DECLARE @data int
EXEC @hr = sp_OACreate 'Chilkat.BinData', @data OUT
EXEC sp_OAMethod @body, 'StringOfEquals', @iTmp0 OUT, 'data', '', 1
IF @iTmp0 <> 1
BEGIN
EXEC sp_OAMethod @body, 'BytesOf', @success OUT, 'data', 'base64url', @data
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @body, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
EXEC @hr = sp_OADestroy @data
RETURN
END
END
EXEC sp_OAGetProperty @data, 'NumBytes', @iTmp0 OUT
IF @iTmp0 <> @expectedSize
BEGIN
PRINT 'Attachment size mismatch.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
EXEC @hr = sp_OADestroy @data
RETURN
END
EXEC sp_OAMethod @data, 'WriteFile', @success OUT, 'downloaded-attachment.bin'
IF @success <> 1
BEGIN
PRINT 'Could not save the attachment.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
EXEC @hr = sp_OADestroy @data
RETURN
END
EXEC sp_OAGetProperty @data, 'NumBytes', @iTmp0 OUT
PRINT 'Saved ' + @iTmp0 + ' attachment bytes.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @reply
EXEC @hr = sp_OADestroy @messageUrl
EXEC @hr = sp_OADestroy @url
EXEC @hr = sp_OADestroy @paths
EXEC @hr = sp_OADestroy @part
EXEC @hr = sp_OADestroy @selected
EXEC @hr = sp_OADestroy @childPath
EXEC @hr = sp_OADestroy @body
EXEC @hr = sp_OADestroy @data
END
GO