Class EmailProviderClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Contains methods to access the /emails/provider endpoints.

public class EmailProviderClient : BaseClient, IEmailProviderClient

Inheritance

object

BaseClient

EmailProviderClient

Implements

IEmailProviderClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

EmailProviderClient(IManagementConnection, Uri, IDictionary<string, string>)

Initializes a new instance of EmailProviderClient.

public EmailProviderClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

IManagementConnection used to make all API calls.

baseUri Uri

Uri of the endpoint to use in making API calls.

defaultHeaders IDictionary<string, string>

Dictionary containing default headers included with every request this client makes.

Methods

ConfigureAsync(EmailProviderConfigureRequest, CancellationToken)

Configures the email provider.

public Task<EmailProvider> ConfigureAsync(EmailProviderConfigureRequest request, CancellationToken cancellationToken = default)

Parameters

request EmailProviderConfigureRequest

The EmailProviderConfigureRequest containing the configuration properties of the provider.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<EmailProvider>

A EmailProvider instance containing the email provider details.

DeleteAsync(CancellationToken)

Deletes the email provider.

public Task DeleteAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

A Task that represents the asynchronous delete operation.

GetAsync(string, bool, CancellationToken)

Gets the email provider.

public Task<EmailProvider> GetAsync(string fields = null, bool includeFields = true, CancellationToken cancellationToken = default)

Parameters

fields string

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

includeFields bool

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

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<EmailProvider>

A EmailProvider instance containing the email provider details.

UpdateAsync(EmailProviderUpdateRequest, CancellationToken)

Updates the email provider.

public Task<EmailProvider> UpdateAsync(EmailProviderUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

request EmailProviderUpdateRequest

The EmailProviderUpdateRequest containing the configuration properties of the email provider.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<EmailProvider>

A EmailProvider instance containing the email provider details.