emails

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

SyncAsync

AdminUsersEmails

The admin.users.emails namespace.

delete(username: str, *, emails: list[str] | None = None) -> None

Delete email addresses from a user's account.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of user to delete email addresses from	required
`emails`	`list[str] \| None`	email addresses to delete	`None`

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: adminDeleteUserEmails

list(username: str) -> list[Email]

List all email addresses for a user.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of user to get email addresses of	required

Returns:

Type	Description
`list[Email]`	EmailList.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminListUserEmails

The admin.users.emails namespace.

delete(username: str, *, emails: list[str] | None = None) -> None

Delete email addresses from a user's account.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of user to delete email addresses from	required
`emails`	`list[str] \| None`	email addresses to delete	`None`

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: adminDeleteUserEmails

list(username: str) -> list[Email]

List all email addresses for a user.

Parameters:

Name	Type	Description	Default
`username`	`str`	username of user to get email addresses of	required

Returns:

Type	Description
`list[Email]`	EmailList.

Raises:

Type	Description
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminListUserEmails