Class ClassicMailAPI

constructor

• new ClassicMailAPI(client): ClassicMailAPI

• Parameters

  • client: Client

  Returns ClassicMailAPI

Static ReadonlyLOCALITIES

createMailbox

• createMailbox(request): Promise<Mailbox>

• Create a new mailbox within your hosting plan.. Create a new mailbox within your hosting plan.

  Parameters

  • request: Readonly<ClassicMailApiCreateMailboxRequest>

    The request ClassicMailApiCreateMailboxRequest

  Returns Promise<Mailbox>

  A Promise of Mailbox

deleteMailbox

• deleteMailbox(request): Promise<Mailbox>

• Parameters

  • request: Readonly<ClassicMailApiDeleteMailboxRequest>

  Returns Promise<Mailbox>

getMailbox

• getMailbox(request): Promise<Mailbox>

• Get a mailbox by id within your hosting plan.. Get a mailbox by id within your hosting plan.

  Parameters

  • request: Readonly<ClassicMailApiGetMailboxRequest>

    The request ClassicMailApiGetMailboxRequest

  Returns Promise<Mailbox>

  A Promise of Mailbox

listMailboxes

• listMailboxes(request): Promise<ListMailboxesResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Mailbox[], void, void>);
      all: (() => Promise<Mailbox[]>);
  }

• List all mailboxes within your hosting plan.. List all mailboxes within your hosting plan.

  Parameters

  • request: Readonly<Webhosting.v1alpha1.ClassicMailApiListMailboxesRequest>

    The request ClassicMailApiListMailboxesRequest

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

  A Promise of ListMailboxesResponse

updateMailbox

• updateMailbox(request): Promise<Mailbox>

• Update the mailbox within your hosting plan.. Update the mailbox within your hosting plan.

  Parameters

  • request: Readonly<ClassicMailApiUpdateMailboxRequest>

    The request ClassicMailApiUpdateMailboxRequest

  Returns Promise<Mailbox>

  A Promise of Mailbox