Class MailAccountAPI

constructor

• new MailAccountAPI(client): MailAccountAPI

• Parameters

  • client: Client

  Returns MailAccountAPI

Static ReadonlyLOCALITIES

changeMailAccountPassword

• changeMailAccountPassword(request): Promise<MailAccount>

• Update the password of a mail account within your hosting plan.. Update the password of a mail account within your hosting plan.

  Parameters

  • request: Readonly<MailAccountApiChangeMailAccountPasswordRequest>

    The request MailAccountApiChangeMailAccountPasswordRequest

  Returns Promise<MailAccount>

  A Promise of MailAccount

createMailAccount

• createMailAccount(request): Promise<MailAccount>

• Create a new mail account within your hosting plan.. Create a new mail account within your hosting plan.

  Parameters

  • request: Readonly<MailAccountApiCreateMailAccountRequest>

    The request MailAccountApiCreateMailAccountRequest

  Returns Promise<MailAccount>

  A Promise of MailAccount

listMailAccounts

• listMailAccounts(request): Promise<ListMailAccountsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<MailAccount[], void, void>);
      all: (() => Promise<MailAccount[]>);
  }

• List all mail accounts within your hosting plan.. List all mail accounts within your hosting plan.

  Parameters

  • request: Readonly<Webhosting.v1.MailAccountApiListMailAccountsRequest>

    The request MailAccountApiListMailAccountsRequest

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

  A Promise of ListMailAccountsResponse

removeMailAccount

• removeMailAccount(request): Promise<MailAccount>

• Delete a mail account within your hosting plan.. Delete a mail account within your hosting plan.

  Parameters

  • request: Readonly<MailAccountApiRemoveMailAccountRequest>

    The request MailAccountApiRemoveMailAccountRequest

  Returns Promise<MailAccount>

  A Promise of MailAccount