Mailglass.Suppression.Escalation (Mailglass v1.0.0)

Copy Markdown View Source

Oban worker for async soft-bounce escalation.

Summary

Types

action()

Functions

available?()
enqueue(multi, map)

Enqueues a soft-bounce escalation job through the optional-dep gateway.

evaluate(tenant_id, recipient, opts \\ [])

Evaluates whether recent deferred events warrant suppression.

Types

action()

@type action() :: :hard_suppress | {:suppress_for, [{:days, pos_integer()}]}

Functions

available?()

(since 0.1.0) 
@spec available?() :: true

enqueue(multi, map)

(since 0.1.0) 
@spec enqueue(Ecto.Multi.t(), map()) :: Ecto.Multi.t()

Enqueues a soft-bounce escalation job through the optional-dep gateway.

evaluate(tenant_id, recipient, opts \\ [])

(since 0.1.0) 
@spec evaluate(String.t(), String.t(), keyword()) ::
  {:ok, Mailglass.Suppression.Entry.t() | :below_threshold}
  | {:error, Ecto.Changeset.t() | term()}

Evaluates whether recent deferred events warrant suppression.