Swoosh.ApiClient behaviour (Swoosh v1.3.3) View Source

Specification for a Swoosh API client.

It can be set to your own client with:

config :swoosh, :api_client, MyAPIClient

Link to this section Summary

body()

status()

url()

API used by adapters to post to a given URL with headers, body, and e-mail.

init()

Callback to initializes the given api client.

Callback invoked when posting to a given URL.

body() :: binary()

headers() :: [{binary(), binary()}]

status() :: pos_integer()

url() :: binary()

API used by adapters to post to a given URL with headers, body, and e-mail.

(optional)

init() :: :ok

Callback to initializes the given api client.

post(url(), headers(), body(), Swoosh.Email.t()) ::
  {:ok, status(), headers(), body()} | {:error, term()}

Callback invoked when posting to a given URL.