Gmail POP3: Authenticate with OAuth2 and Check Available Mail
See more GMail SMTP/IMAP/POP Examples
Connect to pop.gmail.com:995 over implicit TLS, authenticate with XOAUTH2, and query the number of messages currently available through POP. The example does not retrieve or delete messages. It never prints the POP session log, which can contain an encoded bearer token.
Enable POP in Gmail's Forwarding and POP/IMAP settings and choose whether to make all mail or only new mail available. Workspace policy must also permit POP. Gmail's POP delivery history, delivery window, and batching mean the POP count is not the total number of messages in the account. Review the setting that controls what Gmail does after a message is accessed with POP before adding retrieval code.
For multiple clients, IMAP is usually the better fit. Gmail also provides a POP recent mode for mail from the last 30 days, but this example uses ordinary POP delivery. Gmail's removal of Check mail from other accounts concerns Gmail fetching external providers' mail; it does not remove applications' access to pop.gmail.com. See Google's POP changes FAQ.
This example reads gmail-mail-token.json from a private working directory. Authorize the account first, then refresh the access token before it expires. The separate filename avoids confusing this full-mail grant with a narrower Gmail REST token. Store credentials in protected application storage; never distribute a user's token file with an application.
Gmail SMTP, IMAP, and POP3 use the https://mail.google.com/ OAuth scope. Narrower Gmail REST scopes such as gmail.send or gmail.readonly do not authorize these protocols. Public applications using this restricted scope must meet Google's verification requirements. See Gmail OAuth scopes and XOAUTH2.
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 @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-mail-token.json'
IF @success <> 1
BEGIN
PRINT 'Could not read gmail-mail-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. Authorize or refresh the account first.'
EXEC @hr = sp_OADestroy @token
RETURN
END
DECLARE @mailbox nvarchar(4000)
SELECT @mailbox = 'user@example.com'
DECLARE @mailman int
EXEC @hr = sp_OACreate 'Chilkat.MailMan', @mailman OUT
EXEC sp_OASetProperty @mailman, 'MailHost', 'pop.gmail.com'
EXEC sp_OASetProperty @mailman, 'MailPort', 995
EXEC sp_OASetProperty @mailman, 'PopSsl', 1
EXEC sp_OASetProperty @mailman, 'RequireSslCertVerify', 1
EXEC sp_OASetProperty @mailman, 'PopUsername', @mailbox
EXEC sp_OASetProperty @mailman, 'PopPassword', ''
EXEC sp_OAMethod @token, 'StringOf', @sTmp0 OUT, 'access_token'
EXEC sp_OASetProperty @mailman, 'OAuth2AccessToken', @sTmp0
EXEC sp_OAMethod @mailman, 'Pop3Connect', @success OUT
IF @success <> 1
BEGIN
PRINT 'Could not establish the Gmail POP3 TLS connection.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @mailman
RETURN
END
EXEC sp_OAMethod @mailman, 'Pop3Authenticate', @success OUT
IF @success <> 1
BEGIN
EXEC sp_OAMethod @mailman, 'Pop3EndSessionNoQuit', @success OUT
PRINT 'POP3 authentication failed. Check the token, mailbox, POP setting, and Workspace policy.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @mailman
RETURN
END
-- STAT counts currently available POP messages. It does not retrieve or delete them.
DECLARE @count int
EXEC sp_OAMethod @mailman, 'CheckMail', @count OUT
IF @count < 0
BEGIN
EXEC sp_OAMethod @mailman, 'Pop3EndSessionNoQuit', @success OUT
PRINT 'Could not obtain the POP message count.'
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @mailman
RETURN
END
PRINT 'Messages currently available through POP: ' + @count
-- No DELE commands were issued, so this QUIT commits no deletions.
EXEC sp_OAMethod @mailman, 'Pop3EndSession', @success OUT
IF @success <> 1
BEGIN
PRINT 'The count was obtained, but ending the POP session failed.'
END
EXEC @hr = sp_OADestroy @token
EXEC @hr = sp_OADestroy @mailman
END
GO