gmailutil

Documentation

Index

• Constants
• Variables
• func GetLabelNames(client *http.Client) ([]string, error)
• func NewUsersService(client *http.Client) (*gmail.UsersService, error)
• type GmailService
  • func NewGmailService(ctx context.Context, client *http.Client) (*GmailService, error)
  • func (gs GmailService) Send(ctx context.Context, from string, msg mailutil.MessageWriter, ...) (*gmail.Message, error)
• type MessagesAPI
  • func (mapi *MessagesAPI) BatchDeleteMessages(userID string, messageIDs []string) error
  • func (mapi *MessagesAPI) DeleteMessagesFrom(rfc822s []string) (int, int, error)
  • func (mapi *MessagesAPI) GetMessage(userID, messageID string) (*gmail.Message, error)
  • func (mapi *MessagesAPI) GetMessagesByCategory(userID, categoryName string, getAll bool) ([]*gmail.Message, error)
  • func (mapi *MessagesAPI) GetMessagesFrom(rfc822 string) (*gmail.ListMessagesResponse, error)
  • func (mapi *MessagesAPI) GetMessagesList(opts MessagesListOpts) (*gmail.ListMessagesResponse, error)
  • func (mapi *MessagesAPI) InflateMessages(userID string, msgMetas []*gmail.Message) ([]*gmail.Message, error)
• type MessagesListOpts
  • func (opts *MessagesListOpts) Condense()
  • func (opts *MessagesListOpts) Inflate()
• type MessagesListQueryOpts
  • func (opts *MessagesListQueryOpts) Encode() string
  • func (opts *MessagesListQueryOpts) TrimSpace()

Constants

const (
	MailGoogleComScope = gmail.MailGoogleComScope // "https://mail.google.com/"
	GmailReadonlyScope = gmail.GmailReadonlyScope // "https://www.googleapis.com/auth/gmail.readonly"
	GmailSendScope     = gmail.GmailSendScope     // "https://www.googleapis.com/auth/gmail.send"

	UserIDMe = "me"
)

const (
	GmailDateFormat  = "2006/01/02"
	ReferenceURL     = "https://developers.google.com/gmail/api/v1/reference"
	TutorialURLGO    = "https://developers.google.com/gmail/api/quickstart/go"
	ListApiReference = "https://developers.google.com/gmail/api/v1/reference/users/messages/list"
	ListApiExample   = "https://stackoverflow.com/questions/43057478/google-api-go-client-listing-messages-w-label-and-fetching-header-fields"
	FilteringExample = "https://developers.google.com/gmail/api/guides/filtering"
	FilterRules      = "https://support.google.com/mail/answer/7190"

	CategoryForums     = "forums"
	CategoryPromotions = "promotions"
	CategorySocial     = "social"
	CategoryUpdates    = "updates"

	ExampleRule1 = "category:promotions older_than:2y"
	ExampleRule2 = "category:updates older_than:2y"
	ExampleRule3 = "category:social older_than:2y"
)

Variables

var (
	ErrGmailServiceCannotBeNil              = errors.New("gmail service cannot be nil")
	ErrGmailUsersServiceCannotBeNil         = errors.New("gmail users service cannot be nil")
	ErrGmailUsersServiceMessagesCannotBeNil = errors.New("gmail users service messages cannot be nil")
	ErrGmailUserIDCannotBeEmpty             = errors.New("gmail userid cannot be empty")
	ErrHTTPClientCannotBeNil                = errors.New("http.client cannot be nil")
	ErrMessagesAPIGmailServiceCannotBeNil   = errors.New("messages api.gmail service cannot be nil")
)

Functions

func GetLabelNames

func GetLabelNames(client *http.Client) ([]string, error)

func NewUsersService

func NewUsersService(client *http.Client) (*gmail.UsersService, error)

Types

type GmailService

type GmailService struct {
	APICallOptions []googleapi.CallOption
	Service        *gmail.Service
	UsersService   *gmail.UsersService
	MessagesAPI    MessagesAPI
	// contains filtered or unexported fields
}

func NewGmailService

func NewGmailService(ctx context.Context, client *http.Client) (*GmailService, error)

func (GmailService) Send

func (gs GmailService) Send(ctx context.Context, from string, msg mailutil.MessageWriter, opts ...googleapi.CallOption) (*gmail.Message, error)

Send is a helpfer for https://pkg.go.dev/google.golang.org/api/gmail/v1#UsersMessagesService.Send

type MessagesAPI

type MessagesAPI struct {
	GmailService *GmailService
}

func (*MessagesAPI) BatchDeleteMessages

func (mapi *MessagesAPI) BatchDeleteMessages(userID string, messageIDs []string) error

func (*MessagesAPI) DeleteMessagesFrom

func (mapi *MessagesAPI) DeleteMessagesFrom(rfc822s []string) (int, int, error)

func (*MessagesAPI) GetMessage

func (mapi *MessagesAPI) GetMessage(userID, messageID string) (*gmail.Message, error)

func (*MessagesAPI) GetMessagesByCategory

func (mapi *MessagesAPI) GetMessagesByCategory(userID, categoryName string, getAll bool) ([]*gmail.Message, error)

func (*MessagesAPI) GetMessagesFrom

func (mapi *MessagesAPI) GetMessagesFrom(rfc822 string) (*gmail.ListMessagesResponse, error)

func (*MessagesAPI) GetMessagesList

func (mapi *MessagesAPI) GetMessagesList(opts MessagesListOpts) (*gmail.ListMessagesResponse, error)

func (*MessagesAPI) InflateMessages

func (mapi *MessagesAPI) InflateMessages(userID string, msgMetas []*gmail.Message) ([]*gmail.Message, error)

type MessagesListOpts

type MessagesListOpts struct {
	UserId               string
	IncludeSpamTrash     bool
	LabelIds             []string
	MaxResults           int
	PageToken            string
	Query                MessagesListQueryOpts
	Fields               []googleapi.Field
	IfNoneMatchEntityTag string
}

func (*MessagesListOpts) Condense

func (opts *MessagesListOpts) Condense()

func (*MessagesListOpts) Inflate

func (opts *MessagesListOpts) Inflate()

type MessagesListQueryOpts

type MessagesListQueryOpts struct {
	Category    string
	In          string
	From        string
	RFC822msgid string
	After       time.Time
	Before      time.Time
	OlderThan   string // #(mdy)
	NewerThan   string // #(mdy)
	Interval    timeutil.Interval
}

func (*MessagesListQueryOpts) Encode

func (opts *MessagesListQueryOpts) Encode() string

func (*MessagesListQueryOpts) TrimSpace

func (opts *MessagesListQueryOpts) TrimSpace()