emails

Accessed as client.admin.emails; the async client mirrors it.

SyncAsync

AdminEmails

The admin.emails namespace.

list(*, page: int | None = None, limit: int | None = None) -> Paginated[Email]

List all users' email addresses.

Parameters:

Name	Type	Description	Default
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`Paginated[Email]`	EmailList.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: adminGetAllEmails

search(*, q: str | None = None, page: int | None = None, limit: int | None = None) -> Paginated[Email]

Search users' email addresses.

Parameters:

Name	Type	Description	Default
`q`	`str \| None`	keyword	`None`
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`Paginated[Email]`	EmailList.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: adminSearchEmails

The admin.emails namespace.

list(*, page: int | None = None, limit: int | None = None) -> AsyncPaginated[Email]

List all users' email addresses.

Parameters:

Name	Type	Description	Default
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`AsyncPaginated[Email]`	EmailList.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: adminGetAllEmails

search(*, q: str | None = None, page: int | None = None, limit: int | None = None) -> AsyncPaginated[Email]

Search users' email addresses.

Parameters:

Name	Type	Description	Default
`q`	`str \| None`	keyword	`None`
`page`	`int \| None`	1-based page to start iteration at.	`None`
`limit`	`int \| None`	Page size; the instance caps it server-side.	`None`

Returns:

Type	Description
`AsyncPaginated[Email]`	EmailList.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: adminSearchEmails