SquatchMail.Suppression (SquatchMail v0.1.0)

Copy Markdown View Source

An address that should not be sent to.

Suppressions are unique per address. Soft bounces may carry an expires_at after which the address is deliverable again; hard bounces and complaints are typically permanent (expires_at is nil).

Summary

Types

t()

Functions

changeset(suppression, attrs)

Builds a changeset for a suppression.

reasons()

Returns the list of valid suppression reasons.

Types

t()

@type t() :: %SquatchMail.Suppression{
  __meta__: term(),
  address: term(),
  email: term(),
  email_id: term(),
  event_type: term(),
  expires_at: term(),
  id: term(),
  inserted_at: term(),
  notes: term(),
  reason: term(),
  updated_at: term()
}

Functions

changeset(suppression, attrs)

@spec changeset(t(), map()) :: Ecto.Changeset.t()

Builds a changeset for a suppression.

reasons()

@spec reasons() :: [String.t()]

Returns the list of valid suppression reasons.