xoauth2

package

v0.19.0 Latest Latest Go to latest Published: Jun 20, 2026 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Package xoauth2 is Go library for generating XOAuth2 strings (for use in XOAUTH2 SASL auth schemes for IMAP/SMTP)

View Source

const XOAuth2 = "XOAUTH2"

The XOAUTH2 mechanism name.

This section is empty.

func NewXOAuth2Client(opt *XOAuth2Options) *xoauth2Client

An implementation of the OAUTHBEARER authentication mechanism, as described in RFC 7628.

func OAuth2String(user, accessToken string) string

OAuth2String generates an unencoded XOAuth2 string of the form

"user=" {User} "^Aauth=Bearer " {Access Token} "^A^A"

The function XOAuth2String in this package returns the base64 encoding of this string.

func XOAuth2String(user, accessToken string) string

XOAuth2String generates a base64-encoded XOAuth2 string suitable for use in SASL XOAUTH2, as defined at https://developers.google.com/google-apps/gmail/xoauth2_protocol#the_sasl_xoauth2_mechanism.

(Use the base64 encoding mechanism defined in RFC 4648.)

type XOAuth2Error struct {
	Status  string `json:"status"`
	Schemes string `json:"schemes"`
	Scope   string `json:"scope"`
}

func (err *XOAuth2Error) Error() string

Implements error

type XOAuth2Options struct {
	Username     string
	AccessToken  string
	RefreshToken string
}