emails

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

SyncAsync

UserEmails

The user.emails namespace.

add

add(*, emails: list[str] | None = None) -> list[Email]

Add an email addresses to the current user's account.

Parameters:

Name	Type	Description	Default
`emails`	`list[str] \| None`	email addresses to add	`None`

Returns:

Type	Description
`list[Email]`	EmailList.

Raises:

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

Operation ID: userAddEmail

delete

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

Delete email addresses from the current user's account.

Parameters:

Name	Type	Description	Default
`emails`	`list[str] \| None`	email addresses to delete	`None`

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: userDeleteEmail

list

list() -> list[Email]

List all email addresses of the current user.

Returns:

Type	Description
`list[Email]`	EmailList.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userListEmails

AsyncUserEmails

The user.emails namespace.

add

add(*, emails: list[str] | None = None) -> list[Email]

Add an email addresses to the current user's account.

Parameters:

Name	Type	Description	Default
`emails`	`list[str] \| None`	email addresses to add	`None`

Returns:

Type	Description
`list[Email]`	EmailList.

Raises:

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

Operation ID: userAddEmail

delete

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

Delete email addresses from the current user's account.

Parameters:

Name	Type	Description	Default
`emails`	`list[str] \| None`	email addresses to delete	`None`

Returns:

Type	Description
`None`	No content.

Raises:

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

Operation ID: userDeleteEmail

list

list() -> list[Email]

List all email addresses of the current user.

Returns:

Type	Description
`list[Email]`	EmailList.

Raises:

Type	Description
`UnauthorizedError`	APIUnauthorizedError is a unauthorized error response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.

Operation ID: userListEmails