(SQL Server) GMail IMAP Authentication using OAuth2 Access Token

Demonstrates how to do IMAP OAuth2 authentication for GMail (or any other IMAP mail server supporting OAuth2 authentication). This example assumes an OAuth2 access token was previously obtained.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    -- See Get GMail IMAP OAuth2 Access Token for Desktop App 
    -- for sample code showing how to obtain a GMail IMAP read/write access token.

    -- In this example, our access token was previously saved to the following file which contains JSON like this:
    -- 	{
    -- 	 "access_token": "ya39.Ci-XA_C5bGgRDC3UaD-h0_NeL-DVIQnI2gHtBBBHkZzrwlARkwX6R3O0PCDEzRlfaQ",
    -- 	 "token_type": "Bearer",
    -- 	 "expires_in": 3600,
    -- 	 "refresh_token": "1/r_2c_7jddspcdfesrrfKqfXtqo08D6Q-gUU0DsdfVMsx0c"
    -- 	}
    -- 
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @json, 'LoadFile', @success OUT, 'qa_data/tokens/_gmailFullAccess.json'
    IF @success <> 1
      BEGIN

        PRINT 'Failed to load GMail access token file.'
        EXEC @hr = sp_OADestroy @json
        RETURN
      END
    DECLARE @accessToken nvarchar(4000)
    EXEC sp_OAMethod @json, 'StringOf', @accessToken OUT, 'access_token'

    -- Do OAuth2 authentication by using the access token as the password in the Login method below...
    DECLARE @imap int
    -- Use "Chilkat_9_5_0.Imap" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Imap', @imap OUT

    EXEC sp_OASetProperty @imap, 'Ssl', 1
    EXEC sp_OASetProperty @imap, 'Port', 993

    -- Connect to the GMail IMAP server.
    EXEC sp_OAMethod @imap, 'Connect', @success OUT, 'imap.gmail.com'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @imap
        RETURN
      END

    -- Indicate that XOAUTH2 authentication is to be used:
    EXEC sp_OASetProperty @imap, 'AuthMethod', 'XOAUTH2'

    -- Login
    -- Use the email address of the GMail account that granted authorization.
    EXEC sp_OAMethod @imap, 'Login', @success OUT, 'user@gmail.com', @accessToken
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @imap, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
      END
    ELSE
      BEGIN

        PRINT 'Successfully authenticated with GMail IMAP using XOAUTH2!'
      END

    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @imap


END
GO