Class SmtpRelay

A tenant SMTP relay integration.

Hierarchy (View Summary)

Entity<SmtpRelayData>
- SmtpRelay

Index

Constructors

Properties

Accessors

credentialsPresent data displayName id isActive isDeleted relayRef tenantId

Methods

delete reload setActive update

Constructors

constructor

new SmtpRelay(options: EntityOptions<SmtpRelayData>): SmtpRelay
Parameters
- options: EntityOptions<SmtpRelayData>
  The client, path, backing data, and delete state.
Returns SmtpRelay
Inherited from Entity.constructor
- Defined in entity.ts:46

Properties

`Protected` `Readonly`client

client: AdminClient

The client used to issue requests for this entity.

`Protected` `Readonly`path

path: string

The client-relative path of this resource.

Accessors

credentialsPresent

get credentialsPresent(): boolean
Whether credentials are stored.

Returns boolean
- Defined in smtp-relays/entity.ts:42

data

get data(): D
The raw wire record backing this entity.

Returns D
Inherited from Entity.data
- Defined in entity.ts:58

displayName

get displayName(): string
Human-readable name.

Returns string
- Defined in smtp-relays/entity.ts:32

id

get id(): string
Relay identifier.

Returns string
- Defined in smtp-relays/entity.ts:17

isActive

get isActive(): boolean
Whether the relay is active.

Returns boolean
- Defined in smtp-relays/entity.ts:37

isDeleted

get isDeleted(): boolean
Whether this entity has been deleted through this instance.

Local state only; not authoritative server state.

Returns boolean
Inherited from Entity.isDeleted
- Defined in entity.ts:69

relayRef

get relayRef(): string
Immutable relay reference.

Returns string
- Defined in smtp-relays/entity.ts:27

tenantId

get tenantId(): string
Owning tenant identifier.

Returns string
- Defined in smtp-relays/entity.ts:22

Methods

delete

delete(): Promise<boolean>
Deletes this resource.

Idempotent per instance: once this instance has deleted the resource, further calls are a local no-op.

Returns Promise<boolean>
true once the resource has been deleted through this instance.

Throws
ApiException When the control plane returns a non-success status.
Inherited from Entity.delete
- Defined in entity.ts:84

reload

reload(options?: RequestOptions): Promise<SmtpRelay>
Re-fetches this relay.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpRelay>
A fresh snapshot.

Throws
NotFoundException When the relay is no longer visible.
- Defined in smtp-relays/entity.ts:55

setActive

setActive(isActive: boolean, options?: RequestOptions): Promise<SmtpRelay>
Activates or deactivates the relay.
Parameters
- isActive: boolean
  Whether the relay should be active.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpRelay>
The updated relay.
- Defined in smtp-relays/entity.ts:84

update

update(
request: UpdateSmtpRelayRequest,
options?: RequestOptions,
): Promise<SmtpRelay>
Replaces the relay connection and credentials.
Parameters
- request: UpdateSmtpRelayRequest
  The new connection and credentials.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpRelay>
The updated relay.
- Defined in smtp-relays/entity.ts:69