Class InboundRoute

A recipient-domain route into an MTA listener.

Hierarchy (View Summary)

Entity<InboundRouteData>
- InboundRoute

Index

Constructors

Properties

Accessors

data dnsLastCheckedAt domainName id isDeleted isVerified mtaListenerId mxVerified requiredCustomerRecords tenantId txtVerified verificationStatus verificationToken

Methods

delete reload update

Constructors

constructor

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

data

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

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

dnsLastCheckedAt

get dnsLastCheckedAt(): string | null | undefined
Timestamp of the last DNS check.

Returns string | null | undefined
- Defined in inbound-routes/entity.ts:61

domainName

get domainName(): string
The routed recipient domain.

Returns string
- Defined in inbound-routes/entity.ts:36

id

get id(): string
Route identifier.

Returns string
- Defined in inbound-routes/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

isVerified

get isVerified(): boolean
Whether the route is verified.

Returns boolean
- Defined in inbound-routes/entity.ts:41

mtaListenerId

get mtaListenerId(): string
The MTA listener that receives the mail.

Returns string
- Defined in inbound-routes/entity.ts:31

mxVerified

get mxVerified(): boolean
Whether the MX record is verified.

Returns boolean
- Defined in inbound-routes/entity.ts:56

requiredCustomerRecords

get requiredCustomerRecords(): readonly DnsInstructionRecord[]
DNS records the customer must create.

Returns readonly DnsInstructionRecord[]
- Defined in inbound-routes/entity.ts:71

tenantId

get tenantId(): string
Owning tenant identifier.

Returns string
- Defined in inbound-routes/entity.ts:26

txtVerified

get txtVerified(): boolean
Whether the TXT record is verified.

Returns boolean
- Defined in inbound-routes/entity.ts:51

verificationStatus

get verificationStatus(): InboundRouteVerificationStatus
Verification status.

Returns InboundRouteVerificationStatus
- Defined in inbound-routes/entity.ts:46

verificationToken

get verificationToken(): string
DNS ownership verification token.

Returns string
- Defined in inbound-routes/entity.ts:66

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

Throws
NotFoundException When the route is no longer visible.
- Defined in inbound-routes/entity.ts:84

update

update(
request: UpdateInboundRouteRequest,
options?: RequestOptions,
): Promise<InboundRoute>
Replaces the route's listener and domain.
Parameters
- request: UpdateInboundRouteRequest
  The new MTA listener and recipient domain.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<InboundRoute>
The updated route.
- Defined in inbound-routes/entity.ts:103