Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AccountClient

Hierarchy

  • default
    • AccountClient

Index

Constructors

  • 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: string
httpClient: HttpClient

Methods

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).

  • 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).