gmail

Documentation

Overview

Package gmail provides the transport implementation for gmail.

Index

• Constants
• func AutowireTransport(ctx context.Context, cfg map[string]interface{}) (postdog.Transport, error)
• func NewTransport(ctx context.Context, options ...Option) (postdog.Transport, error)
• func Register(cfg *autowire.Config)
• type Option
  • func ClientOptions(options ...option.ClientOption) Option
  • func Credentials(creds *google.Credentials) Option
  • func CredentialsFile(filename string) Option
  • func CredentialsJSON(p []byte) Option
  • func Scopes(scopes ...string) Option

Constants

const (
	// Provider is the provider name for Gmail.
	Provider = "gmail"
)

Functions

func AutowireTransport

func AutowireTransport(ctx context.Context, cfg map[string]interface{}) (postdog.Transport, error)

AutowireTransport autowires gmail transport from the given config.

func NewTransport

func NewTransport(ctx context.Context, options ...Option) (postdog.Transport, error)

NewTransport initializes a gmail transport. Credentials must be provided, if GMAIL_CREDENTIALS environment variable is not set. If no scopes are provided, the gmail.MailGoogleComScope (https://mail.google.com/) scope is used.

func Register

func Register(cfg *autowire.Config)

Register registers the transport factory in the autowire config.

Types

type Option

type Option func(*transport)

Option is a gmail transport option.

func ClientOptions

func ClientOptions(options ...option.ClientOption) Option

ClientOptions adds custom option.ClientOption to the gmail service.

func Credentials

func Credentials(creds *google.Credentials) Option

Credentials adds an option.ClientOption that authenticates API calls.

func CredentialsFile

func CredentialsFile(filename string) Option

CredentialsFile adds an option.ClientOption that authenticates API calls with the given service account or refresh token JSON credentials file.

func CredentialsJSON

func CredentialsJSON(p []byte) Option

CredentialsJSON adds an option.ClientOption that authenticates API calls with the given service account or refresh token JSON credentials.

func Scopes

func Scopes(scopes ...string) Option

Scopes adds gmail scopes.