Class SmtpRelaysClient

Tenant SMTP relay collection.

Index

Constructors

Methods

create get getByRef list

Constructors

constructor

new SmtpRelaysClient(options: SmtpRelaysClientOptions): SmtpRelaysClient
Parameters
- options: SmtpRelaysClientOptions
  The underlying admin client and tenant slug.
Returns SmtpRelaysClient
- Defined in smtp-relays/client.ts:35

Methods

create

create(
request: CreateSmtpRelayRequest,
options?: RequestOptions,
): Promise<SmtpRelay>
Creates an SMTP relay.
Parameters
- request: CreateSmtpRelayRequest
  The relay reference, connection, and credentials.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpRelay>
The created relay.

Throws
Error When a field fails local validation.
- Defined in smtp-relays/client.ts:101

get

get(relayId: string, options?: RequestOptions): Promise<SmtpRelay>
Gets a relay by identifier.
Parameters
- relayId: string
  The relay identifier.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpRelay>
The hydrated relay.

Throws
NotFoundException When the relay is not visible.
- Defined in smtp-relays/client.ts:67

getByRef

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

Throws
NotFoundException When the relay is not visible.
- Defined in smtp-relays/client.ts:83

list

list(options?: ListOptions): Promise<Paged<SmtpRelay>>
Lists SMTP relays.
Parameters
- options: ListOptions = {}
  Optional pagination and cancellation signal.
Returns Promise<Paged<SmtpRelay>>
A lazily paginating collection of relays.

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