Interface IEmailProviderClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

public interface IEmailProviderClient

Methods

ConfigureAsync(EmailProviderConfigureRequest, CancellationToken)

Configures the email provider.

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.

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.

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.

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.