Class Workspace

A tenant-bound view of the control plane.

Obtain one from AdminClient.workspace and reach every tenant-scoped resource family from it, without repeating the tenant slug on every call. A workspace is a lightweight binding: creating one per request is cheap.

Example

const ws = admin.workspace("my-workspace");
const tenant = await ws.tenant();
for await (const domain of ws.domains().list()) {
  console.log(domain.domainName);
}

Index

Constructors

constructor

new Workspace(options: WorkspaceOptions): Workspace
Parameters
- options: WorkspaceOptions
  The underlying admin client and the tenant slug.
Returns Workspace
- Defined in workspace.ts:60

Properties

`Readonly`slug

slug: string

The tenant slug this workspace is bound to.

Methods

autoReplyTemplates

autoReplyTemplates(): AutoReplyTemplatesClient
Accesses the auto-reply-template resource family.

Returns AutoReplyTemplatesClient
A client for auto-reply-template operations in this workspace.
- Defined in workspace.ts:163

domains

domains(): DomainsClient
Accesses the domain resource family.

Returns DomainsClient
A client for domain operations in this workspace.
- Defined in workspace.ts:86

governance

governance(): GovernanceClient
Accesses the governance resource family.

Returns GovernanceClient
A client for governance operations in this workspace.
- Defined in workspace.ts:130

identityProviders

identityProviders(): IdentityProvidersClient
Accesses the identity-provider resource family.

Returns IdentityProvidersClient
A client for identity-provider operations in this workspace.
- Defined in workspace.ts:119

inboundRoutes

inboundRoutes(): InboundRoutesClient
Accesses the inbound-route resource family.

Returns InboundRoutesClient
A client for inbound-route operations in this workspace.
- Defined in workspace.ts:97

listeners

listeners(): ListenersClient
Accesses the listener resource family.

Returns ListenersClient
A client for listener operations in this workspace.
- Defined in workspace.ts:108

mailAnalytics

mailAnalytics(): MailAnalyticsClient
Accesses the mail-analytics resource family.

Returns MailAnalyticsClient
A client for mail-analytics operations in this workspace.
- Defined in workspace.ts:141

mtaRateLimits

mtaRateLimits(): MtaRateLimitsClient
Accesses the tenant MTA rate-limit family.

Returns MtaRateLimitsClient
A client for MTA rate-limit operations in this workspace.
- Defined in workspace.ts:240

quotas

quotas(): QuotasClient
Accesses the tenant quota family.

Returns QuotasClient
A client for quota operations in this workspace.
- Defined in workspace.ts:229

recipientSets

recipientSets(): RecipientSetsClient
Accesses the recipient-set resource family.

Returns RecipientSetsClient
A client for recipient-set operations in this workspace.
- Defined in workspace.ts:152

smtpForwardDestinations

smtpForwardDestinations(): SmtpForwardDestinationsClient
Accesses the SMTP forward-destination resource family.

Returns SmtpForwardDestinationsClient
A client for SMTP forward-destination operations in this workspace.
- Defined in workspace.ts:174

smtpRelays

smtpRelays(): SmtpRelaysClient
Accesses the SMTP relay resource family.

Returns SmtpRelaysClient
A client for SMTP relay operations in this workspace.
- Defined in workspace.ts:196

storageIntegrations

storageIntegrations(): StorageIntegrationsClient
Accesses the storage-integration resource family.

Returns StorageIntegrationsClient
A client for storage-integration operations in this workspace.
- Defined in workspace.ts:207

suppressions

suppressions(): SuppressionsClient
Accesses the suppression resource family.

Returns SuppressionsClient
A client for suppression operations in this workspace.
- Defined in workspace.ts:185

tenant

tenant(options?: RequestOptions): Promise<Tenant>
Fetches this workspace's identity and provisioning state.
Parameters
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<Tenant>
The tenant record.

Throws
NotFoundException When the tenant is not visible.
- Defined in workspace.ts:74

webhookEndpoints

webhookEndpoints(): WebhookEndpointsClient
Accesses the webhook-endpoint resource family.

Returns WebhookEndpointsClient
A client for webhook-endpoint operations in this workspace.
- Defined in workspace.ts:218

Class Workspace

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Workspace

Properties

Readonlyslug

Methods

autoReplyTemplates

Returns AutoReplyTemplatesClient

domains

Returns DomainsClient

governance

Returns GovernanceClient

identityProviders

Returns IdentityProvidersClient

inboundRoutes

Returns InboundRoutesClient

listeners

Returns ListenersClient

mailAnalytics

Returns MailAnalyticsClient

mtaRateLimits

Returns MtaRateLimitsClient

quotas

Returns QuotasClient

recipientSets

Returns RecipientSetsClient

smtpForwardDestinations

Returns SmtpForwardDestinationsClient

smtpRelays

Returns SmtpRelaysClient

storageIntegrations

Returns StorageIntegrationsClient

suppressions

Returns SuppressionsClient

tenant

Parameters

Returns Promise<Tenant>

Throws

webhookEndpoints

Returns WebhookEndpointsClient

Settings

On This Page

`Readonly`slug