mongo

Documentation

Index

• type Option
  • func Collection(name string) Option
  • func CreateIndexes(ci bool) Option
  • func Database(name string) Option
  • func RFCOptions(opts ...rfc.Option) Option
  • func WithoutAttachmentContent(ac bool) Option
• type Store
  • func NewStore(ctx context.Context, client *mongo.Client, opts ...Option) (*Store, error)
  • func (s *Store) Find(ctx context.Context, id uuid.UUID) (archive.Mail, error)
  • func (s *Store) Insert(ctx context.Context, m archive.Mail) error
  • func (s *Store) Query(ctx context.Context, q query.Query) (archive.Cursor, error)
  • func (s *Store) Remove(ctx context.Context, m archive.Mail) error

Types

type Option

type Option func(*Store)

Option is a Store option.

func Collection

func Collection(name string) Option

Collection returns an Option that specifies the used collection.

func CreateIndexes

func CreateIndexes(ci bool) Option

CreateIndexes returns an Option that creates the indexes for the mails collection.

func Database

func Database(name string) Option

Database returns an Option that specifies the used database.

func RFCOptions

func RFCOptions(opts ...rfc.Option) Option

RFCOptions returns an Option that adds rfc.Options when building the rfc body of a mail.

func WithoutAttachmentContent

func WithoutAttachmentContent(ac bool) Option

WithoutAttachmentContent returns an Option that empties the attachment contents of mails before they are stored in the database.

type Store

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

Store is the mongo store.

func NewStore

func NewStore(ctx context.Context, client *mongo.Client, opts ...Option) (*Store, error)

NewStore returns a mongo store. It returns an error if either client is nil or CreateIndexes() is used and index creation fails.

func (*Store) Find

func (s *Store) Find(ctx context.Context, id uuid.UUID) (archive.Mail, error)

Find fetches the mail with the given id from the database. If it can't find the mail, it returns archive.ErrNotFound.

func (*Store) Insert

func (s *Store) Insert(ctx context.Context, m archive.Mail) error

Insert stores m into the database. If there's already a stored mail with the same ID as m, m will override the previously stored mail.

func (*Store) Query

func (s *Store) Query(ctx context.Context, q query.Query) (archive.Cursor, error)

Query queries the database for mails matching the query q.

func (*Store) Remove

func (s *Store) Remove(ctx context.Context, m archive.Mail) error

Remove deletes the mail m from the database.