Class Domains

Nylas Manage Domains API

Register email domains and run their DNS verification flow (ownership / MX / SPF / DKIM / feedback) for Transactional Send and Nylas Inbound.

Index

Constructors

constructor

new Domains(apiClient: APIClient): Domains
Parameters
- apiClient: APIClient
  client The configured Nylas API client
Returns Domains
Inherited from Resource.constructor
- Defined in src/resources/resource.ts:50

Properties

`Protected`apiClient

apiClient: APIClient

Methods

`Protected`_create

_create<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._create
- Defined in src/resources/resource.ts:195

`Protected`_destroy

_destroy<T>(__namedParameters: DestroyParams): Promise<T>
Type Parameters
- T
Parameters
- __namedParameters: DestroyParams
Returns Promise<T>
Inherited from Resource._destroy
- Defined in src/resources/resource.ts:209

`Protected`_find

_find<T>(__namedParameters: FindParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- __namedParameters: FindParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._find
- Defined in src/resources/resource.ts:169

`Protected`_getRaw

_getRaw(__namedParameters: FindParams<void>): Promise<Buffer<ArrayBufferLike>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<Buffer<ArrayBufferLike>>
Inherited from Resource._getRaw
- Defined in src/resources/resource.ts:224

`Protected`_getStream

_getStream(
__namedParameters: FindParams<void>,
): Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
Parameters
- __namedParameters: FindParams<void>
Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>
Inherited from Resource._getStream
- Defined in src/resources/resource.ts:237

`Protected`_list

_list<T extends List<T>>(listParams: ListParams<T>): AsyncListResponse<T>
Type Parameters
- T extends List<T>
Parameters
- listParams: ListParams<T>
Returns AsyncListResponse<T>
Inherited from Resource._list
- Defined in src/resources/resource.ts:149

`Protected`_update

_update<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._update
- Defined in src/resources/resource.ts:199

`Protected`_updatePatch

_updatePatch<T>(params: PayloadParams<T>): Promise<NylasResponse<T>>
Type Parameters
- T
Parameters
- params: PayloadParams<T>
Returns Promise<NylasResponse<T>>
Inherited from Resource._updatePatch
- Defined in src/resources/resource.ts:203

create

create(
__namedParameters: CreateDomainParams & Overrides,
): Promise<NylasResponse<Domain>>
Create a domain.
Parameters
- __namedParameters: CreateDomainParams & Overrides
Returns Promise<NylasResponse<Domain>>
The created domain.
- Defined in src/resources/domains.ts:120

destroy

destroy(
__namedParameters: DestroyDomainParams & Overrides,
): Promise<NylasBaseResponse>
Delete a domain.
Parameters
- __namedParameters: DestroyDomainParams & Overrides
Returns Promise<NylasBaseResponse>
The deletion response.
- Defined in src/resources/domains.ts:155

find

find(
__namedParameters: FindDomainParams & Overrides,
): Promise<NylasResponse<Domain>>
Return a domain.
Parameters
- __namedParameters: FindDomainParams & Overrides
Returns Promise<NylasResponse<Domain>>
The domain.
- Defined in src/resources/domains.ts:106

info

info(
__namedParameters: InfoDomainParams & Overrides,
): Promise<NylasResponse<DomainVerificationResult>>
Get the DNS record a customer must configure for a given verification type.
Parameters
- __namedParameters: InfoDomainParams & Overrides
Returns Promise<NylasResponse<DomainVerificationResult>>
The verification result, including the DNS record to configure.
- Defined in src/resources/domains.ts:169

list

list(
__namedParameters?: ListDomainsParams & Overrides,
): AsyncListResponse<NylasListResponse<Domain>>
Return all domains for the caller's organization.
Parameters
- __namedParameters: ListDomainsParams & Overrides = {}
Returns AsyncListResponse<NylasListResponse<Domain>>
The list of domains.
- Defined in src/resources/domains.ts:89

update

update(
__namedParameters: UpdateDomainParams & Overrides,
): Promise<NylasResponse<Domain>>
Update a domain.

Note: the response echoes the sparse cleared input (typically just name and updatedAt), not a full domain. Re-fetch the domain with find if you need the complete record.
Parameters
- __namedParameters: UpdateDomainParams & Overrides
Returns Promise<NylasResponse<Domain>>
The updated domain fields.
- Defined in src/resources/domains.ts:139

verify

verify(
__namedParameters: VerifyDomainParams & Overrides,
): Promise<NylasResponse<DomainVerificationResult>>
Trigger a DNS verification check for a given verification type.
Parameters
- __namedParameters: VerifyDomainParams & Overrides
Returns Promise<NylasResponse<DomainVerificationResult>>
The verification result, including the current status.
- Defined in src/resources/domains.ts:187

Class Domains

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Domains

Properties

ProtectedapiClient

Methods

Protected_create

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_destroy

Type Parameters

Parameters

Returns Promise<T>

Protected_find

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_getRaw

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

Protected_getStream

Parameters

Returns Promise<ReadableStream<Uint8Array<ArrayBufferLike>>>

Protected_list

Type Parameters

Parameters

Returns AsyncListResponse<T>

Protected_update

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

Protected_updatePatch

Type Parameters

Parameters

Returns Promise<NylasResponse<T>>

create

Parameters

Returns Promise<NylasResponse<Domain>>

destroy

Parameters

Returns Promise<NylasBaseResponse>

find

Parameters

Returns Promise<NylasResponse<Domain>>

info

Parameters

Returns Promise<NylasResponse<DomainVerificationResult>>

list

Parameters

Returns AsyncListResponse<NylasListResponse<Domain>>

update

Parameters

Returns Promise<NylasResponse<Domain>>

verify

Parameters

Returns Promise<NylasResponse<DomainVerificationResult>>

Settings

On This Page

`Protected`apiClient

`Protected`_create

`Protected`_destroy

`Protected`_find

`Protected`_getRaw

`Protected`_getStream

`Protected`_list

`Protected`_update

`Protected`_updatePatch