filter

package
v0.2.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 7, 2018 License: MIT Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Action

type Action struct {
	Archive       bool
	Delete        bool
	MarkImportant bool
	MarkRead      bool
	Category      config.Category
	AddLabel      string
}

Action represents an action associated with a Gmail filter.

func (Action) Empty

func (a Action) Empty() bool

Empty returns true if no action is specified.

type Criteria

type Criteria struct {
	From    string
	To      string
	Subject string
	Query   string
}

Criteria represents the filtering criteria associated with a Gmail filter.

func (Criteria) Empty

func (c Criteria) Empty() bool

Empty returns true if no criteria is specified.

type Filter

type Filter struct {
	// ID is an optional identifier associated with a filter.
	ID       string
	Action   Action
	Criteria Criteria
}

Filter matches 1:1 a filter created on Gmail.

func (Filter) String

func (f Filter) String() string

type Filters

type Filters []Filter

Filters is a list of filters created in Gmail.

func FromConfig

func FromConfig(cfg config.Config) (Filters, error)

FromConfig translates a config into entries that map directly into Gmail filters

func FromConfigRule

func FromConfigRule(rule config.Rule, consts config.Consts) (Filters, error)

FromConfigRule creates a set of filters based on a single config Rule

func (Filters) String

func (fs Filters) String() string

type FiltersDiff

type FiltersDiff struct {
	Added   Filters
	Removed Filters
}

FiltersDiff contains filters that have been added and removed locally with respect to upstream.

func Diff

func Diff(upstream, local Filters) (FiltersDiff, error)

Diff computes the diff between two lists of filters.

To compute the diff, IDs are ignored, only the contents of the filters are actually considered.

func NewMinimalFiltersDiff

func NewMinimalFiltersDiff(added, removed Filters) FiltersDiff

NewMinimalFiltersDiff creates a new FiltersDiff with reordered filters, where similar added and removed ones are next to each other.

The algorithm used is a quadratic approximation to the otherwise NP-complete travel salesman problem. Hopefully the number of filters is low enough to make this not too slow and the approximation not too bad.

func (FiltersDiff) Empty

func (f FiltersDiff) Empty() bool

Empty returns true if the diff is empty.

func (FiltersDiff) String

func (f FiltersDiff) String() string

type Label

type Label struct {
	ID   string
	Name string
}

Label contains information about a Gmail label.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL