DripDrop.UnsubscribeToken (DripDrop v0.1.0)

Signs and verifies one-click unsubscribe tokens.

Summary

payload()

sign(payload)

Signs an unsubscribe payload into a tamper-resistant token.

verify(token)

Verifies an unsubscribe token and returns the signed payload.

@type payload() :: %{
  :channel => String.t(),
  :recipient => String.t(),
  optional(:tenant_key) => String.t() | nil
}

@spec sign(payload()) :: {:ok, String.t()} | {:error, :missing_unsubscribe_secret}

Signs an unsubscribe payload into a tamper-resistant token.

@spec verify(String.t()) :: {:ok, payload()} | {:error, term()}

Verifies an unsubscribe token and returns the signed payload.