Class SmtpForwardDestinationsClient

Tenant SMTP forward-destination collection.

Index

Constructors

Methods

confirm create get getByRef list

Constructors

constructor

new SmtpForwardDestinationsClient(
options: SmtpForwardDestinationsClientOptions,
): SmtpForwardDestinationsClient
Parameters
- options: SmtpForwardDestinationsClientOptions
  The underlying admin client and tenant slug.
Returns SmtpForwardDestinationsClient
- Defined in smtp-forward-destinations/client.ts:52

Methods

confirm

confirm(
request: ConfirmSmtpForwardDestinationRequest,
options?: RequestOptions,
): Promise<SmtpForwardDestinationConfirmation>
Confirms a forward destination from a verification token.

This operation is public and is not tenant-scoped.
Parameters
- request: ConfirmSmtpForwardDestinationRequest
  The verification token.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpForwardDestinationConfirmation>
The confirmation result.

Throws
Error When the token length is invalid.
- Defined in smtp-forward-destinations/client.ts:158

create

create(
request: CreateSmtpForwardDestinationRequest,
options?: RequestOptions,
): Promise<SmtpForwardDestination>
Creates a forward destination.
Parameters
- request: CreateSmtpForwardDestinationRequest
  The reference, name, and forwarding mailbox.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpForwardDestination>
The created destination.

Throws
Error When a field fails local validation.
- Defined in smtp-forward-destinations/client.ts:131

get

get(
destinationId: string,
options?: RequestOptions,
): Promise<SmtpForwardDestination>
Gets a forward destination by identifier.
Parameters
- destinationId: string
  The destination identifier.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpForwardDestination>
The hydrated destination.

Throws
NotFoundException When the destination is not visible.
- Defined in smtp-forward-destinations/client.ts:88

getByRef

getByRef(
destinationRef: string,
options?: RequestOptions,
): Promise<SmtpForwardDestination>
Gets a forward destination by its immutable reference.
Parameters
- destinationRef: string
  The destination reference.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpForwardDestination>
The hydrated destination.

Throws
NotFoundException When the destination is not visible.
- Defined in smtp-forward-destinations/client.ts:106

list

list(
options?: ListSmtpForwardDestinationsOptions,
): Promise<Paged<SmtpForwardDestination>>
Lists forward destinations with optional filters.
Parameters
- options: ListSmtpForwardDestinationsOptions = {}
  Optional filters, pagination, and cancellation signal.
Returns Promise<Paged<SmtpForwardDestination>>
A lazily paginating collection of destinations.

Throws
ApiException When the control plane returns a non-success status.
- Defined in smtp-forward-destinations/client.ts:66