auth

Documentation

Index

• type Authenticator
  • func NewAuthenticator(credentials io.Reader) (*Authenticator, error)
  • func (a Authenticator) AuthURL(redirectURL string) string
  • func (a Authenticator) CacheToken(ctx context.Context, authCode string, token io.Writer) error
  • func (a Authenticator) Service(ctx context.Context, token io.Reader) (*calendar.Service, error)

Types

type Authenticator

type Authenticator struct {
	State string
	// contains filtered or unexported fields
}

Authenticator encapsulates authentication operations for Gmail APIs.

func NewAuthenticator

func NewAuthenticator(credentials io.Reader) (*Authenticator, error)

NewAuthenticator creates an Authenticator instance from credentials JSON file contents.

Credentials can be obtained by creating a new OAuth client ID at the Google API console https://console.developers.google.com/apis/credentials.

func (Authenticator) AuthURL

func (a Authenticator) AuthURL(redirectURL string) string

AuthURL returns the URL the user has to visit to authorize the application and obtain an auth code.

func (Authenticator) CacheToken

func (a Authenticator) CacheToken(ctx context.Context, authCode string, token io.Writer) error

CacheToken creates and caches a token JSON file from an auth code.

The token can be subsequently used to authorize a GmailAPI instance.

func (Authenticator) Service

func (a Authenticator) Service(ctx context.Context, token io.Reader) (*calendar.Service, error)

Service creates a Gmail API service from a token JSON file contents.

If no token is available, AuthURL and CacheToken can be used to obtain one.