View Source Auth0.Management.Emails (Auth0Api v2.5.1)

Facade for the Auth0 Management API Emails endpoints.

Most applications should call Auth0.Api.Management instead of this module.

Summary

Types

config()
error()

Functions

configure_provider(params, config)

Create an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property)

delete_provider(config)

Delete email provider.

get_provider(params, config)

Retrieve details of the email provider configuration in your tenant. A list of fields to include or exclude may also be specified.

update_provider(params, config)

Update an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property)

Types

Link to this type

config()

View Source 
@type config() :: Auth0.Config.t()
Link to this type

error()

View Source 
@type error() :: {:error, integer(), term()} | {:error, term()}

Functions

Link to this function

configure_provider(params, config)

View Source 
@spec configure_provider(map(), config()) :: {:ok, map()} | error()

Create an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property):

see

https://auth0.com/docs/api/management/v2/emails/post-provider

Link to this function

delete_provider(config)

View Source 
@spec delete_provider(config()) :: {:ok, String.t()} | error()

Delete email provider.

Delete the email provider.

see

https://auth0.com/docs/api/management/v2/emails/delete-provider

Link to this function

get_provider(params, config)

View Source 
@spec get_provider(map(), config()) :: {:ok, map()} | error()

Retrieve details of the email provider configuration in your tenant. A list of fields to include or exclude may also be specified.

see

https://auth0.com/docs/api/management/v2/emails/get-provider

Link to this function

update_provider(params, config)

View Source 
@spec update_provider(map(), config()) :: {:ok, map()} | error()

Update an email provider. The credentials object requires different properties depending on the email provider (which is specified using the name property):

see

https://auth0.com/docs/api/management/v2/emails/patch-provider