Class RecipientSetMembersClient

Membership of a single recipient set.

Index

Constructors

Methods

add batchAdd batchDelete delete list

Constructors

constructor

new RecipientSetMembersClient(
options: RecipientSetMembersClientOptions,
): RecipientSetMembersClient
Parameters
- options: RecipientSetMembersClientOptions
  The underlying admin client and membership path.
Returns RecipientSetMembersClient
- Defined in recipient-sets/client.ts:171

Methods

add

add(emailAddress: string, options?: RequestOptions): Promise<RecipientSetMember>
Adds one member.
Parameters
- emailAddress: string
  The member's email address.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RecipientSetMember>
The added member.

Throws
Error When the address is not a valid email address.
- Defined in recipient-sets/client.ts:212

batchAdd

batchAdd(
emailAddresses: readonly string[],
options?: RequestOptions,
): Promise<RecipientSetBatchResult>
Adds several members in one batch.
Parameters
- emailAddresses: readonly string[]
  The addresses to add, at most 1000.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RecipientSetBatchResult>
Per-operation outcome counts.

Throws
Error When the list is empty, too large, or contains an invalid address.
- Defined in recipient-sets/client.ts:244

batchDelete

batchDelete(
emailAddresses: readonly string[],
options?: RequestOptions,
): Promise<RecipientSetBatchResult>
Removes several members in one batch.
Parameters
- emailAddresses: readonly string[]
  The addresses to remove, at most 1000.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<RecipientSetBatchResult>
Per-operation outcome counts.

Throws
Error When the list is empty, too large, or contains an invalid address.
- Defined in recipient-sets/client.ts:266

delete

delete(emailAddress: string, options?: RequestOptions): Promise<void>
Removes one member.
Parameters
- emailAddress: string
  The member's email address.
- Optionaloptions: RequestOptions
  Optional cancellation signal.
Returns Promise<void>
- Defined in recipient-sets/client.ts:230

list

list(
options?: ListRecipientSetMembersOptions,
): Promise<Paged<RecipientSetMember>>
Lists members with optional filters.
Parameters
- options: ListRecipientSetMembersOptions = {}
  Optional filters, pagination, and cancellation signal.
Returns Promise<Paged<RecipientSetMember>>
A lazily paginating collection of members.

Throws
ApiException When the control plane returns a non-success status.
- Defined in recipient-sets/client.ts:185