admin

Documentation

Overview

Package admin provides access to the Email Migration API v2.

See https://developers.google.com/admin-sdk/email-migration/v2/

Usage example:

import "google.golang.org/api/admin/email_migration/v2"
...
adminService, err := admin.New(oauthHttpClient)

Index

• Constants
• type MailInsertCall
  • func (c *MailInsertCall) Context(ctx context.Context) *MailInsertCall
  • func (c *MailInsertCall) Do(opts ...googleapi.CallOption) error
  • func (c *MailInsertCall) Fields(s ...googleapi.Field) *MailInsertCall
  • func (c *MailInsertCall) Media(r io.Reader, options ...googleapi.MediaOption) *MailInsertCall
  • func (c *MailInsertCall) ProgressUpdater(pu googleapi.ProgressUpdater) *MailInsertCall
  • func (c *MailInsertCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *MailInsertCall
• type MailItem
  • func (s *MailItem) MarshalJSON() ([]byte, error)
• type MailService
  • func NewMailService(s *Service) *MailService
  • func (r *MailService) Insert(userKey string, mailitem *MailItem) *MailInsertCall
• type Service
  • func New(client *http.Client) (*Service, error)

Constants

const (
	// Manage email messages of users on your domain
	EmailMigrationScope = "https://www.googleapis.com/auth/email.migration"
)

OAuth2 scopes used by this API.

Types

type MailInsertCall

type MailInsertCall struct {
	// contains filtered or unexported fields
}

func (*MailInsertCall) Context

func (c *MailInsertCall) Context(ctx context.Context) *MailInsertCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled. This context will supersede any context previously provided to the ResumableMedia method.

func (*MailInsertCall) Do

func (c *MailInsertCall) Do(opts ...googleapi.CallOption) error

Do executes the "emailMigration.mail.insert" call.

func (*MailInsertCall) Fields

func (c *MailInsertCall) Fields(s ...googleapi.Field) *MailInsertCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*MailInsertCall) Media

func (c *MailInsertCall) Media(r io.Reader, options ...googleapi.MediaOption) *MailInsertCall

Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.

func (*MailInsertCall) ProgressUpdater

func (c *MailInsertCall) ProgressUpdater(pu googleapi.ProgressUpdater) *MailInsertCall

ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).

func (*MailInsertCall) ResumableMedia

func (c *MailInsertCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *MailInsertCall

ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.

Deprecated: use Media instead.

At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.

type MailItem

type MailItem struct {
	// IsDeleted: Boolean indicating if the mail is deleted (used in Vault)
	IsDeleted bool `json:"isDeleted,omitempty"`

	// IsDraft: Boolean indicating if the mail is draft
	IsDraft bool `json:"isDraft,omitempty"`

	// IsInbox: Boolean indicating if the mail is in inbox
	IsInbox bool `json:"isInbox,omitempty"`

	// IsSent: Boolean indicating if the mail is in 'sent mails'
	IsSent bool `json:"isSent,omitempty"`

	// IsStarred: Boolean indicating if the mail is starred
	IsStarred bool `json:"isStarred,omitempty"`

	// IsTrash: Boolean indicating if the mail is in trash
	IsTrash bool `json:"isTrash,omitempty"`

	// IsUnread: Boolean indicating if the mail is unread
	IsUnread bool `json:"isUnread,omitempty"`

	// Kind: Kind of resource this is.
	Kind string `json:"kind,omitempty"`

	// Labels: List of labels (strings)
	Labels []string `json:"labels,omitempty"`

	// ForceSendFields is a list of field names (e.g. "IsDeleted") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IsDeleted") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

MailItem: JSON template for MailItem object in Email Migration API.

func (*MailItem) MarshalJSON

func (s *MailItem) MarshalJSON() ([]byte, error)

type MailService

type MailService struct {
	// contains filtered or unexported fields
}

func NewMailService

func NewMailService(s *Service) *MailService

func (*MailService) Insert

func (r *MailService) Insert(userKey string, mailitem *MailItem) *MailInsertCall

Insert: Insert Mail into Google's Gmail backends

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Mail *MailService
	// contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)