Class AccountClient

Hierarchy

  • default
    • AccountClient

Constructors

constructor

Properties

clientVersion httpClient

Methods

createDomain createSenderSignature createServer deleteDomain deleteSenderSignature deleteServer editDomain editSenderSignature editServer getClientOptions getDataRemovalStatus getDomain getDomains getSenderSignature getSenderSignatures getServer getServers pushTemplates requestDataRemoval requestNewDKIMForSenderSignature resendSenderSignatureConfirmation rotateDomainDKIM setClientOptions verifyDomainDKIM verifyDomainReturnPath verifyDomainSPF verifySenderSignatureSPF

Constructors

constructor

  • new AccountClient(accountToken, configOptions?): AccountClient

  • Create a new AccountClient

    Parameters

    • accountToken: string

      The account token that should be used with requests.

    • Optional configOptions: Configuration

      Various options to customize client behavior.

    Returns AccountClient

Properties

clientVersion

clientVersion: string

httpClient

httpClient: HttpClient

Methods

createDomain

createSenderSignature

createServer

  • createServer(options, callback?): Promise<Server>

  • Create a new Server.

    Parameters

    • options: CreateServerRequest

      The options to be used to create new Server.

    • Optional callback: Callback<Server>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<Server>

    A promise that will complete when the API responds (or an error occurs).

deleteDomain

  • deleteDomain(id, callback?): Promise<DefaultResponse>

  • Delete a Domain.

    Parameters

    • id: number

      The ID of the Domain you wish to delete.

    • Optional callback: Callback<DefaultResponse>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DefaultResponse>

    A promise that will complete when the API responds (or an error occurs).

deleteSenderSignature

  • deleteSenderSignature(id, callback?): Promise<DefaultResponse>

  • Delete a Domain.

    Parameters

    • id: number

      The ID of the Domain you wish to delete.

    • Optional callback: Callback<DefaultResponse>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DefaultResponse>

    A promise that will complete when the API responds (or an error occurs).

deleteServer

  • deleteServer(id, callback?): Promise<DefaultResponse>

  • Modify the Server associated with this Client.

    Parameters

    • id: number

      The ID of the Domain you wish to delete.

    • Optional callback: Callback<DefaultResponse>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DefaultResponse>

    A promise that will complete when the API responds (or an error occurs).

editDomain

editSenderSignature

  • editSenderSignature(id, options, callback?): Promise<SignatureDetails>

  • Update a Sender Signature.

    Parameters

    • id: number

      The ID of the Sender Signature for which you wish to update.

    • options: UpdateSignatureRequest

      The values on the Sender Signature you wish to update.

    • Optional callback: Callback<SignatureDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<SignatureDetails>

    A promise that will complete when the API responds (or an error occurs).

editServer

  • editServer(id, options, callback?): Promise<Server>

  • Modify the Server associated with this Client.

    Parameters

    • id: number

      The ID of the Server you wish to update.

    • options: UpdateServerRequest

      The options to be used to create new Server.

    • Optional callback: Callback<Server>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<Server>

    A promise that will complete when the API responds (or an error occurs).

getClientOptions

getDataRemovalStatus

  • getDataRemovalStatus(id, callback?): Promise<DataRemovalStatus>

  • Retrieve a single data removal status by ID.

    Parameters

    • id: number

      The ID of the DataRemoval for which you wish to retrieve details.

    • Optional callback: Callback<DataRemovalStatus>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DataRemovalStatus>

    A promise that will complete when the API responds (or an error occurs).

getDomain

  • getDomain(id, callback?): Promise<DomainDetails>

  • Retrieve a single Domain by ID.

    Parameters

    • id: number

      The ID of the Domain for which you wish to retrieve details.

    • Optional callback: Callback<DomainDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DomainDetails>

    A promise that will complete when the API responds (or an error occurs).

getDomains

  • getDomains(filter?, callback?): Promise<Domains>

  • Retrieve a batch of Domains.

    Parameters

    • filter: FilteringParameters = ...

      An optional filter for which data is retrieved.

    • Optional callback: Callback<Domains>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<Domains>

    A promise that will complete when the API responds (or an error occurs).

getSenderSignature

  • getSenderSignature(id, callback?): Promise<SignatureDetails>

  • Retrieve a single Sender Signature by ID.

    Parameters

    • id: number

      The ID of the Sender Signature for which you wish to retrieve details.

    • Optional callback: Callback<SignatureDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<SignatureDetails>

    A promise that will complete when the API responds (or an error occurs).

getSenderSignatures

  • getSenderSignatures(filter?, callback?): Promise<Signatures>

  • Retrieve a batch of Sender Signatures.

    Parameters

    • filter: FilteringParameters = ...

      An optional filter for which data is retrieved.

    • Optional callback: Callback<Signatures>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<Signatures>

    A promise that will complete when the API responds (or an error occurs).

getServer

  • getServer(id, callback?): Promise<Server>

  • Retrieve a single server by ID.

    Parameters

    • id: number

      The ID of the Server for which you wish to retrieve details.

    • Optional callback: Callback<Server>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<Server>

    A promise that will complete when the API responds (or an error occurs).

getServers

  • getServers(filter?, callback?): Promise<Servers>

  • Retrieve a list of Servers.

    Parameters

    • filter: ServerFilteringParameters = ...

      An optional filter for which data is retrieved.

    • Optional callback: Callback<Servers>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<Servers>

    A promise that will complete when the API responds (or an error occurs).

pushTemplates

  • pushTemplates(options, callback?): Promise<TemplatesPush>

  • Request a push of templates from one server to another.

    Parameters

    • options: TemplatesPushRequest

      details for pushing templates from one place to another.

    • Optional callback: Callback<TemplatesPush>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<TemplatesPush>

    A promise that will complete when the API responds (or an error occurs).

requestDataRemoval

requestNewDKIMForSenderSignature

  • requestNewDKIMForSenderSignature(id, callback?): Promise<SignatureDetails>

  • Request that the SPF records for Sender Signature be verified.

    Parameters

    • id: number

      The ID of the Sender Signature.

    • Optional callback: Callback<SignatureDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<SignatureDetails>

    A promise that will complete when the API responds (or an error occurs).

resendSenderSignatureConfirmation

  • resendSenderSignatureConfirmation(id, callback?): Promise<DefaultResponse>

  • Request a new confirmation email to be sent to the email address associated with a Sender Signature.

    Parameters

    • id: number

      The ID of the Sender Signature.

    • Optional callback: Callback<DefaultResponse>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DefaultResponse>

    A promise that will complete when the API responds (or an error occurs).

rotateDomainDKIM

  • rotateDomainDKIM(id, callback?): Promise<DomainDetails>

  • Trigger Domain DKIM key verification.

    Parameters

    • id: number

      The ID of the Domain you wish to trigger DKIM verification for.

    • Optional callback: Callback<DomainDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DomainDetails>

    A promise that will complete when the API responds (or an error occurs).

setClientOptions

verifyDomainDKIM

  • verifyDomainDKIM(id, callback?): Promise<DomainDetails>

  • Trigger Domain DKIM key verification.

    Parameters

    • id: number

      The ID of the Domain you wish to trigger DKIM verification for.

    • Optional callback: Callback<DomainDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DomainDetails>

    A promise that will complete when the API responds (or an error occurs).

verifyDomainReturnPath

  • verifyDomainReturnPath(id, callback?): Promise<DomainDetails>

  • Trigger Domain DKIM key verification.

    Parameters

    • id: number

      The ID of the Domain you wish to trigger DKIM verification for.

    • Optional callback: Callback<DomainDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DomainDetails>

    A promise that will complete when the API responds (or an error occurs).

verifyDomainSPF

  • verifyDomainSPF(id, callback?): Promise<DomainDetails>

  • Trigger Domain DKIM key verification.

    Parameters

    • id: number

      The ID of the Domain you wish to trigger DKIM verification for.

    • Optional callback: Callback<DomainDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<DomainDetails>

    A promise that will complete when the API responds (or an error occurs).

verifySenderSignatureSPF

  • verifySenderSignatureSPF(id, callback?): Promise<SignatureDetails>

  • Request that the SPF records for Sender Signature be verified.

    Parameters

    • id: number

      The ID of the Sender Signature.

    • Optional callback: Callback<SignatureDetails>

      If the callback is provided, it will be passed to the resulting promise as a continuation.

    Returns Promise<SignatureDetails>

    A promise that will complete when the API responds (or an error occurs).

Settings

Member Visibility

Theme

On This Page