Class EmailTemplatesClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class EmailTemplatesClient : IEmailTemplatesClient

Inheritance

object

EmailTemplatesClient

Implements

IEmailTemplatesClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Methods

CreateAsync(CreateEmailTemplateRequestContent, RequestOptions?, CancellationToken)

Create an email template.

public WithRawResponseTask<CreateEmailTemplateResponseContent> CreateAsync(CreateEmailTemplateRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateEmailTemplateRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateEmailTemplateResponseContent>

Examples

await client.EmailTemplates.CreateAsync(
    new CreateEmailTemplateRequestContent { Template = EmailTemplateNameEnum.VerifyEmail }
);

GetAsync(EmailTemplateNameEnum, RequestOptions?, CancellationToken)

Retrieve an email template by pre-defined name. These names are verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, and async_approval. The names change_password, and password_reset are also supported for legacy scenarios.

public WithRawResponseTask<GetEmailTemplateResponseContent> GetAsync(EmailTemplateNameEnum templateName, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

templateName EmailTemplateNameEnum

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetEmailTemplateResponseContent>

Examples

await client.EmailTemplates.GetAsync(EmailTemplateNameEnum.VerifyEmail);

SetAsync(EmailTemplateNameEnum, SetEmailTemplateRequestContent, RequestOptions?, CancellationToken)

Update an email template.

public WithRawResponseTask<SetEmailTemplateResponseContent> SetAsync(EmailTemplateNameEnum templateName, SetEmailTemplateRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

templateName EmailTemplateNameEnum

request SetEmailTemplateRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<SetEmailTemplateResponseContent>

Examples

await client.EmailTemplates.SetAsync(
    EmailTemplateNameEnum.VerifyEmail,
    new SetEmailTemplateRequestContent { Template = EmailTemplateNameEnum.VerifyEmail }
);

UpdateAsync(EmailTemplateNameEnum, UpdateEmailTemplateRequestContent, RequestOptions?, CancellationToken)

Modify an email template.

public WithRawResponseTask<UpdateEmailTemplateResponseContent> UpdateAsync(EmailTemplateNameEnum templateName, UpdateEmailTemplateRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

templateName EmailTemplateNameEnum

request UpdateEmailTemplateRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateEmailTemplateResponseContent>

Examples

await client.EmailTemplates.UpdateAsync(
    EmailTemplateNameEnum.VerifyEmail,
    new UpdateEmailTemplateRequestContent()
);