class BouncedFilter implements FilterInterface

Filters users by whether their email address has bounced or been marked as spam. Used via the `bounced` gambit, e.g. `is:bounced`.

Methods

string
getFilterKey()

This filter will only be run when a query contains a filter param with this key.

void
filter( SearchState $state, string|array $value, bool $negate)

Filters a query.

void
constrain( Builder $query, bool $negate)

No description

Details

string getFilterKey()

This filter will only be run when a query contains a filter param with this key.

Return Value

string

void filter( SearchState $state, string|array $value, bool $negate)

Filters a query.

Parameters

SearchState $state
string|array $value
bool $negate

Return Value

void

protected void constrain( Builder $query, bool $negate)

Parameters

Builder $query
bool $negate

Return Value

void