Class API

constructor

• new API(client): TransactionalEmail.v1alpha1.API

• Parameters

  • client: Client

  Returns TransactionalEmail.v1alpha1.API

Static ReadonlyLOCALITIES

cancelEmail

• cancelEmail(request): Promise<Email>

• Cancel an email. You can cancel the sending of an email if it has not been sent yet. You must specify the region and the email_id of the email you want to cancel.

  Parameters

  • request: Readonly<CancelEmailRequest>

    The request CancelEmailRequest

  Returns Promise<Email>

  A Promise of Email

checkDomain

• checkDomain(request): Promise<TransactionalEmail.v1alpha1.Domain>

• Domain DNS check. Perform an immediate DNS check of a domain using the region and domain_id parameters.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.CheckDomainRequest>

    The request CheckDomainRequest

  Returns Promise<TransactionalEmail.v1alpha1.Domain>

  A Promise of Domain

createDomain

• createDomain(request): Promise<TransactionalEmail.v1alpha1.Domain>

• Register a domain in a project. You must specify the region, project_id and domain_name to register a domain in a specific Project.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.CreateDomainRequest>

    The request CreateDomainRequest

  Returns Promise<TransactionalEmail.v1alpha1.Domain>

  A Promise of Domain

createEmail

• createEmail(request): Promise<CreateEmailResponse>

• Send an email. You must specify the region, the sender and the recipient's information and the project_id to send an email from a checked domain. The subject of the email must contain at least 6 characters.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.CreateEmailRequest>

    The request CreateEmailRequest

  Returns Promise<CreateEmailResponse>

  A Promise of CreateEmailResponse

createWebhook

• createWebhook(request): Promise<Webhook>

• Create a Webhook. Create a new Webhook triggered by a list of event types and pushed to a Scaleway SNS ARN.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.CreateWebhookRequest>

    The request CreateWebhookRequest

  Returns Promise<Webhook>

  A Promise of Webhook

deleteWebhook

• deleteWebhook(request): Promise<void>

• Delete a Webhook. You must specify the Webhook you want to delete by the region and webhook_id. Deleting a Webhook is permanent and cannot be undone.

  Parameters

  • request: Readonly<DeleteWebhookRequest>

    The request DeleteWebhookRequest

  Returns Promise<void>

getDomain

• getDomain(request): Promise<TransactionalEmail.v1alpha1.Domain>

• Get information about a domain. Retrieve information about a specific domain using the region and domain_id parameters. Monitor your domain's reputation and improve average and bad reputation statuses, using your domain's Email activity tab on the Scaleway console to get a more detailed report. Check out our dedicated documentation to improve your domain's reputation.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.GetDomainRequest>

    The request GetDomainRequest

  Returns Promise<TransactionalEmail.v1alpha1.Domain>

  A Promise of Domain

getDomainLastStatus

• getDomainLastStatus(request): Promise<DomainLastStatus>

• Display SPF and DKIM records status and potential errors. Display SPF and DKIM records status and potential errors, including the found records to make debugging easier.

  Parameters

  • request: Readonly<GetDomainLastStatusRequest>

    The request GetDomainLastStatusRequest

  Returns Promise<DomainLastStatus>

  A Promise of DomainLastStatus

getEmail

• getEmail(request): Promise<Email>

• Get an email. Retrieve information about a specific email using the email_id and region parameters.

  Parameters

  • request: Readonly<GetEmailRequest>

    The request GetEmailRequest

  Returns Promise<Email>

  A Promise of Email

getProjectSettings

• getProjectSettings(request?): Promise<ProjectSettings>

• List project settings. Retrieve the project settings including periodic reports.

  Parameters

  • request: Readonly<GetProjectSettingsRequest> = {}

    The request GetProjectSettingsRequest

  Returns Promise<ProjectSettings>

  A Promise of ProjectSettings

getStatistics

• getStatistics(request?): Promise<Statistics>

• Email statuses. Get information on your emails' statuses.

  Parameters

  • request: Readonly<GetStatisticsRequest> = {}

    The request GetStatisticsRequest

  Returns Promise<Statistics>

  A Promise of Statistics

getWebhook

• getWebhook(request): Promise<Webhook>

• Get information about a Webhook. Retrieve information about a specific Webhook using the webhook_id and region parameters.

  Parameters

  • request: Readonly<GetWebhookRequest>

    The request GetWebhookRequest

  Returns Promise<Webhook>

  A Promise of Webhook

listDomains

• listDomains(request?): Promise<TransactionalEmail.v1alpha1.ListDomainsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<TransactionalEmail.v1alpha1.Domain[], void, void>);
      all: (() => Promise<TransactionalEmail.v1alpha1.Domain[]>);
  }

• List domains. Retrieve domains in a specific Project or in a specific Organization using the region parameter.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.ListDomainsRequest> = {}

    The request ListDomainsRequest

  Returns Promise<TransactionalEmail.v1alpha1.ListDomainsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<TransactionalEmail.v1alpha1.Domain[], void, void>);
      all: (() => Promise<TransactionalEmail.v1alpha1.Domain[]>);
  }

  A Promise of ListDomainsResponse

listEmails

• listEmails(request?): Promise<ListEmailsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Email[], void, void>);
      all: (() => Promise<Email[]>);
  }

• List emails. Retrieve the list of emails sent from a specific domain or for a specific Project or Organization. You must specify the region.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.ListEmailsRequest> = {}

    The request ListEmailsRequest

  Returns Promise<ListEmailsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Email[], void, void>);
      all: (() => Promise<Email[]>);
  }

  A Promise of ListEmailsResponse

listWebhookEvents

• listWebhookEvents(request): Promise<ListWebhookEventsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<WebhookEvent[], void, void>);
      all: (() => Promise<WebhookEvent[]>);
  }

• List Webhook triggered events. Retrieve the list of Webhook events triggered from a specific Webhook or for a specific Project or Organization. You must specify the region.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.ListWebhookEventsRequest>

    The request ListWebhookEventsRequest

  Returns Promise<ListWebhookEventsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<WebhookEvent[], void, void>);
      all: (() => Promise<WebhookEvent[]>);
  }

  A Promise of ListWebhookEventsResponse

listWebhooks

• listWebhooks(request?): Promise<ListWebhooksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Webhook[], void, void>);
      all: (() => Promise<Webhook[]>);
  }

• List Webhooks. Retrieve Webhooks in a specific Project or in a specific Organization using the region parameter.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.ListWebhooksRequest> = {}

    The request ListWebhooksRequest

  Returns Promise<ListWebhooksResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Webhook[], void, void>);
      all: (() => Promise<Webhook[]>);
  }

  A Promise of ListWebhooksResponse

revokeDomain

• revokeDomain(request): Promise<TransactionalEmail.v1alpha1.Domain>

• Delete a domain. You must specify the domain you want to delete by the region and domain_id. Deleting a domain is permanent and cannot be undone.

  Parameters

  • request: Readonly<RevokeDomainRequest>

    The request RevokeDomainRequest

  Returns Promise<TransactionalEmail.v1alpha1.Domain>

  A Promise of Domain

updateDomain

• updateDomain(request): Promise<TransactionalEmail.v1alpha1.Domain>

• Update a domain. Update a domain auto-configuration.

  Parameters

  • request: Readonly<UpdateDomainRequest>

    The request UpdateDomainRequest

  Returns Promise<TransactionalEmail.v1alpha1.Domain>

  A Promise of Domain

updateProjectSettings

• updateProjectSettings(request?): Promise<ProjectSettings>

• Update project settings. Update the project settings including periodic reports.

  Parameters

  • request: Readonly<UpdateProjectSettingsRequest> = {}

    The request UpdateProjectSettingsRequest

  Returns Promise<ProjectSettings>

  A Promise of ProjectSettings

updateWebhook

• updateWebhook(request): Promise<Webhook>

• Update a Webhook. Update a Webhook events type, SNS ARN or name.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.UpdateWebhookRequest>

    The request UpdateWebhookRequest

  Returns Promise<Webhook>

  A Promise of Webhook

waitForDomain

• waitForDomain(request, options?): Promise<TransactionalEmail.v1alpha1.Domain>

• Waits for Domain to be in a final state.

  Parameters

  • request: Readonly<TransactionalEmail.v1alpha1.GetDomainRequest>

    The request GetDomainRequest
  • Optionaloptions: Readonly<WaitForOptions<TransactionalEmail.v1alpha1.Domain>>

    The waiting options

  Returns Promise<TransactionalEmail.v1alpha1.Domain>

  A Promise of Domain

waitForEmail

• waitForEmail(request, options?): Promise<Email>

• Waits for Email to be in a final state.

  Parameters

  • request: Readonly<GetEmailRequest>

    The request GetEmailRequest
  • Optionaloptions: Readonly<WaitForOptions<Email>>

    The waiting options

  Returns Promise<Email>

  A Promise of Email