Class SmtpForwardDestination

A verified SMTP forwarding destination.

Hierarchy (View Summary)

Entity<SmtpForwardDestinationData>
- SmtpForwardDestination

Index

Constructors

Properties

Accessors

createdAt data deliveryRequestedAt deliveryStatus destinationRef displayName emailAddress id isDeleted tenantId updatedAt verificationEmailSentAt verificationMethod verificationStatus verifiedAt

Methods

delete reload sendVerification

Constructors

constructor

new SmtpForwardDestination(
options: EntityOptions<SmtpForwardDestinationData>,
): SmtpForwardDestination
Parameters
- options: EntityOptions<SmtpForwardDestinationData>
  The client, path, backing data, and delete state.
Returns SmtpForwardDestination
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

createdAt

get createdAt(): string
Creation timestamp.

Returns string
- Defined in smtp-forward-destinations/entity.ts:76

data

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

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

deliveryRequestedAt

get deliveryRequestedAt(): string | null | undefined
When delivery was requested.

Returns string | null | undefined
- Defined in smtp-forward-destinations/entity.ts:66

deliveryStatus

get deliveryStatus(): SmtpForwardVerificationDeliveryStatus | null | undefined
Verification-email delivery status.

Returns SmtpForwardVerificationDeliveryStatus | null | undefined
- Defined in smtp-forward-destinations/entity.ts:56

destinationRef

get destinationRef(): string
Immutable destination reference.

Returns string
- Defined in smtp-forward-destinations/entity.ts:31

displayName

get displayName(): string
Human-readable name.

Returns string
- Defined in smtp-forward-destinations/entity.ts:36

emailAddress

get emailAddress(): string
The forwarding mailbox.

Returns string
- Defined in smtp-forward-destinations/entity.ts:41

id

get id(): string
Destination identifier.

Returns string
- Defined in smtp-forward-destinations/entity.ts:21

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

tenantId

get tenantId(): string
Owning tenant identifier.

Returns string
- Defined in smtp-forward-destinations/entity.ts:26

updatedAt

get updatedAt(): string
Last-update timestamp.

Returns string
- Defined in smtp-forward-destinations/entity.ts:81

verificationEmailSentAt

get verificationEmailSentAt(): string | null | undefined
When the verification email was sent.

Returns string | null | undefined
- Defined in smtp-forward-destinations/entity.ts:71

verificationMethod

get verificationMethod(): | SmtpForwardDestinationVerificationMethod
| null
| undefined
Verification method.

Returns SmtpForwardDestinationVerificationMethod | null | undefined
- Defined in smtp-forward-destinations/entity.ts:51

verificationStatus

get verificationStatus(): SmtpForwardDestinationVerificationStatus
Verification status.

Returns SmtpForwardDestinationVerificationStatus
- Defined in smtp-forward-destinations/entity.ts:46

verifiedAt

get verifiedAt(): string | null | undefined
When the destination was verified.

Returns string | null | undefined
- Defined in smtp-forward-destinations/entity.ts:61

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<SmtpForwardDestination>
Re-fetches this destination.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpForwardDestination>
A fresh snapshot.

Throws
NotFoundException When the destination is no longer visible.
- Defined in smtp-forward-destinations/entity.ts:94

sendVerification

sendVerification(options?: RequestOptions): Promise<SmtpForwardDestination>
Sends (or resends) the verification email.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<SmtpForwardDestination>
The refreshed destination.
- Defined in smtp-forward-destinations/entity.ts:114