Swoosh.ApiClient behaviour (Swoosh v1.19.2)

Specification for a Swoosh API client.

It can be set to your own client with:

config :swoosh, :api_client, MyAPIClient

Summary

body()

headers()

status()

url()

init()

Callback to initializes the given api client.

Callback invoked when posting to a given URL.

API used by adapters to post to a given URL with headers, body, and email.

@type body() :: binary()

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

@type status() :: pos_integer()

@type url() :: binary()

(optional)

@callback init() :: :ok

Callback to initializes the given api client.

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

Callback invoked when posting to a given URL.

API used by adapters to post to a given URL with headers, body, and email.