EmailProviderManager

management. EmailProviderManager

EmailProviderManager Auth0 Email Provider.

Constructor

new EmailProviderManager(options)

Source:
Parameters:
Name Type Description
options Object

The client options.

Name Type Attributes Description
baseUrl String

The URL of the API.

headers Object <optional>

Headers to be included in all requests.

retry Object <optional>

Retry Policy Config

Members

(inner) auth0RestClient :external:RestClient

Provides an abstraction layer for consuming the Auth0 Clients endpoint.

Source:
Type:

(inner) clientOptions :Object

Options object for the Rest Client instance.

Source:
Type:
  • Object

Methods

configure(data, cbopt) → {Promise|undefined}

Configure the email provider.

Source:
Parameters:
Name Type Attributes Description
data Object

The email provider data object.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.emailProvider.configure(data, function (err) {
  if (err) {
    // Handle error.
  }

  // Email provider configured.
});

delete(cbopt) → {Promise|undefined}

Delete email provider.

Source:
Parameters:
Name Type Attributes Description
cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.emailProvider.delete(function (err) {
  if (err) {
    // Handle error.
  }

  // Email provider configured.
});

get(cbopt, paramsopt) → {Promise|undefined}

Get the email provider.

Source:
Parameters:
Name Type Attributes Description
cb function <optional>

Callback function.

params Object <optional>

Clients parameters.

Name Type Attributes Description
fields Number <optional>

A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve: name, enabled, settings fields.

include_fields Number <optional>

true if the fields specified are to be excluded from the result, false otherwise (defaults to true)

Returns:
Type:
Promise | undefined
Example
management.emailProvider.get(function (err, provider) {
  console.log(provider);
});

update(params, data, cbopt) → {Promise|undefined}

Update the email provider.

Source:
Parameters:
Name Type Attributes Description
params Object

Email provider parameters.

data Object

Updated email provider data.

cb function <optional>

Callback function.

Returns:
Type:
Promise | undefined
Example
management.emailProvider.update(params, data, function (err, provider) {
  if (err) {
    // Handle error.
  }

  // Updated email provider.
  console.log(provider);
});