Vaartix.Emails (vaartix v0.1.0)

Copy Markdown View Source

Send and read emails.

Summary

Functions

Cancel a scheduled email before it is sent. Needs a full-access key.

One email with its events. Needs a full-access key.

Recent emails, newest first. Options: :limit (1–100), :before (an email ID). Needs a full-access key.

Send one email. Set html or text (or both). tracking: %{opens: true, clicks: false} overrides the domain's defaults. Pass idempotency_key: "..." to make retries safe for 24 hours.

Functions

cancel(client, id)

Cancel a scheduled email before it is sent. Needs a full-access key.

get(client, id)

One email with its events. Needs a full-access key.

list(client, opts \\ [])

Recent emails, newest first. Options: :limit (1–100), :before (an email ID). Needs a full-access key.

send(client, email, opts \\ [])

Send one email. Set html or text (or both). tracking: %{opens: true, clicks: false} overrides the domain's defaults. Pass idempotency_key: "..." to make retries safe for 24 hours.