Class EmailsApi

Hierarchy

FaxDomainApi
- EmailsApi

Index

Methods

addToNumbers delete list listNumbers setBasePath update

Methods

addToNumbers

addToNumbers(data: AddEmailToNumbersRequestData): Promise<Email>
Add an email Add an email to be used for sending and receiving faxes.
Parameters
- data: AddEmailToNumbersRequestData
  The data to provide to the API call.
Returns Promise<Email>

delete

delete(data: DeleteEmailRequestData): Promise<void>
Remove email Delete an email and associated numbers to that email to disable that email from sending and receiving faxes.
Parameters
- data: DeleteEmailRequestData
  The data to provide to the API call.
Returns Promise<void>

list

list(data: ListEmailsForProjectRequestData): ApiListPromise<Email>
List emails List emails for the project.
Parameters
- data: ListEmailsForProjectRequestData
  The data to provide to the API call.
Returns ApiListPromise<Email>
- The list of emails for the project

listNumbers

listNumbers(
data: ListNumbersByEmailRequestData,
): ApiListPromise<ServicePhoneNumber>
Get numbers for email Get configured numbers for an email
Parameters
- data: ListNumbersByEmailRequestData
  The data to provide to the API call.
Returns ApiListPromise<ServicePhoneNumber>

setBasePath

setBasePath(basePath: string): void
Update the default basePath for the API
Parameters
- basePath: string
  The new base path to use for the APIs.
Returns void
Inherited from FaxDomainApi.setBasePath

update

update(data: UpdateEmailRequestData): Promise<Email>
Update numbers for email Set the numbers for an email.
Parameters
- data: UpdateEmailRequestData
  The data to provide to the API call.
Returns Promise<Email>