Auth0Client.Management.EmailProvider (auth0_client v1.0.0)

Copy Markdown View Source

A module representing emails resource on Auth0

Summary

Functions

Configures the email provider

Deletes the email provider

Gets the email provider

Updates the email provider

Functions

configure(body)

Configures the email provider

credentials is required — the provider's API key or SMTP details, depending on name. Without it Auth0 rejects the request.

iex> Auth0Client.Management.EmailProvider.configure(%{
...>   name: "mandrill",
...>   enabled: true,
...>   credentials: %{api_key: "..."}
...> })

delete()

Deletes the email provider

iex> Auth0Client.Management.EmailProvider.delete()

get(params \\ %{})

Gets the email provider

iex> Auth0Client.Management.EmailProvider.get()
iex> Auth0Client.Management.EmailProvider.get(fields: "name,enabled")

update(body)

Updates the email provider

iex> Auth0Client.Management.EmailProvider.update(name: "new_name")