nextmail.account
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
The account of the person behind the key or the app: the email notifications they get and the workspaces muted on their phone, their profile photo and username, the apps they connected, the invitations waiting for them, the devices they are signed in on, their passkeys and their security log. An API key acts for the workspace owner, and an app for the person who connected it.
account.get_notifications()
Read your notification settings
def get_notifications( *, api_key: str | None = None, timeout: float | None = None,) -> NotificationSettingsResourceReturns which kinds of email Nextmail sends the person, as Account, Notifications shows them, and the workspaces whose notifications are muted on their phone. An API key answers for the workspace owner, and an app for the person who connected it.
Parameters
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
NotificationSettingsResource with email, a list holding one EmailNotificationSetting for each kind of email, and mutedWorkspaces, a list of workspace ids.
Example
from nextmail import nextmail settings = nextmail.account.get_notifications() for kind in settings['email']: print(kind['label'], 'on' if kind['enabled'] else 'off') print('Muted on the phone:', settings['mutedWorkspaces'])Notes
accountandbillingemail are always on, andrequiredsays so.
Also available in
account.set_email_notification()
Turn a kind of email on or off
def set_email_notification( category: EmailNotificationCategory, body: EmailNotificationSet, *, api_key: str | None = None, timeout: float | None = None,) -> NotificationSettingsResource{'enabled': False} stops Nextmail sending the person that kind of email, and {'enabled': True} starts it again. activity and product can be turned off. account and billing cannot, and asking to is a 422 invalid_parameter on category.
Parameters
categoryEmailNotificationCategoryRequiredaccount,billing,activityorproduct.body['enabled']boolRequiredTrueto receive that email,Falseto stop it.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
NotificationSettingsResource as it is after the change.
Example
from nextmail import nextmail settings = nextmail.account.set_email_notification('product', {'enabled': False}) for kind in settings['email']: print(kind['category'], kind['enabled'])Notes
Retried automatically on network failure, since the same setting sent twice changes nothing.
Also available in
- API
PUT /account/notifications/email/{category}- TypeScript
nextmail.account.setEmailNotification()- Ruby
account.set_email_notification- PHP
account->setEmailNotification- Go
Account.SetEmailNotification- Java
account().setEmailNotification- C#
Account.SetEmailNotificationAsync- CLI
nextmail account set-email-notification
account.set_push_muted()
Mute a workspace on your phone
def set_push_muted( workspace_id: str, body: PushNotificationSet, *, api_key: str | None = None, timeout: float | None = None,) -> NotificationSettingsResource{'muted': True} stops the phone app notifying the person about the mail of one workspace, on every phone they signed in on, and {'muted': False} lets it notify them again.
Parameters
workspace_idstrRequiredA workspace id from
workspaces.list.body['muted']boolRequiredTrueto mute it,Falseto let it notify again.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
NotificationSettingsResource with the new mutedWorkspaces.
Example
from nextmail import nextmail settings = nextmail.account.set_push_muted( '10417196-e324-4283-af98-66ec62167c47', {'muted': True}) print(settings['mutedWorkspaces'])Notes
A workspace the person cannot open is a 404
resource_not_found.Retried automatically on network failure, since the same setting sent twice changes nothing.
Also available in
account.set_photo()
Set your profile photo
def set_photo( data: RawBody, *, content_type: ContactPhotoType | None = None, api_key: str | None = None, timeout: float | None = None,) -> AccountPhotoResourceSends the image bytes as the request body, replacing the person's profile photo, as Account, Profile does. PNG, JPEG, WebP and GIF are accepted, up to 5 MB. The server fits the image into a 512 pixel square, stores it as WebP and keeps the first frame of an animation.
data is bytes, a bytearray or a memoryview, such as what Path('photo.jpg').read_bytes() returns. Bytes carry no type of their own, so the type is read from content_type= alone. Without it the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.
Parameters
dataRawBodyRequiredThe image as
bytes, abytearrayor amemoryview.content_typeContactPhotoTypeimage/png,image/jpeg,image/webporimage/gif, matching the bytes. Left out, the upload is refused with 422invalid_image.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
AccountPhotoResource with the new url.
Example
from pathlib import Path from nextmail import nextmail photo = nextmail.account.set_photo(Path('photo.jpg').read_bytes(), content_type='image/jpeg') print(photo['url'])Notes
A busy image service answers 503
image_busy, which the SDK retries like any other 503.Every upload gets a new URL, so a cached old photo never shows under the new one.
Also available in
account.remove_photo()
Remove your profile photo
def remove_photo( *, api_key: str | None = None, timeout: float | None = None,) -> AccountPhotoResourceRemoves the profile photo and deletes the stored image, so the app shows the person's initials again. Removing it when there is none changes nothing.
Parameters
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
AccountPhotoResource with url set to None.
Example
from nextmail import nextmail photo = nextmail.account.remove_photo() print(photo['url'])Notes
Safe to replay, so the SDK retries it after a network failure.
Also available in
account.get_username()
Read your username
def get_username( *, api_key: str | None = None, timeout: float | None = None,) -> UsernameResourceReturns the person's username, whether they chose it or it was made for them from their name, and the free address that comes with it, when there is one. A username the person chose never changes.
Parameters
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
UsernameResource with username, chosen and address.
Example
from nextmail import nextmail account = nextmail.account.get_username() print(account['username'], 'chosen' if account['chosen'] else 'made for you')print(account['address'])Notes
The first read makes a username for an account that has none.
Also available in
account.check_username()
Check a username
def check_username( username: str, *, api_key: str | None = None, timeout: float | None = None,) -> UsernameAvailabilityResourceSays whether the person could choose a username, without choosing it, and why not when they could not. The username is lowercased and its spaces become dots before it is checked, as the app does, and username in the answer is the form that was checked.
Parameters
usernamestrRequiredUp to 60 characters before it is tidied.
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
UsernameAvailabilityResource with status, available and a message that says why.
Example
from nextmail import nextmail check = nextmail.account.check_username('Ada Lovelace') if check['available']: print(check['username'], 'is free')else: print(check['status'], check['message'])Notes
statusiscurrentfor the username the person already has, andavailableisFalsefor it.
Also available in
account.set_username()
Choose your username
def set_username( username: str, *, api_key: str | None = None, timeout: float | None = None,) -> UsernameResourceSets the person's username for good, and with it their free address. Once chosen it never changes: a second choice is refused with 409 username_locked. A username another account has is a 409 username_taken, and one that is too short, too long, reserved or not lowercase letters, numbers and single dots is a 422 invalid_parameter on username. Check one first with check_username.
Parameters
usernamestrRequired3 to 30 lowercase letters, numbers and single dots once it is tidied.
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
UsernameResource with chosen set to True.
Example
from nextmail import NextmailApiError, nextmail try: account = nextmail.account.set_username('ada.lovelace')except NextmailApiError as error: if error.code == 'username_taken': print('Someone else has that one, try another') elif error.code == 'username_locked': print('Your username is already chosen for good') else: raiseelse: print(account['username'], account['address'])Notes
Not retried automatically: a retry after a lost response would be refused with
username_locked, because the first call already chose it.
Also available in
account.list_connected_apps()
List your connected apps
def list_connected_apps( *, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[ConnectedAppResource]Returns every app the person connected with OAuth, as Account, Connected apps lists them: the workspace and the permissions each may reach, until when, how many tokens it holds, and until when it may make changes that ask for a verification code without one. current marks the app making the call.
What an app may reach is changed in the app, never through an app.
Parameters
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
list[ConnectedAppResource], each with clientId, name, kind, status, grant and tokenCount.
Example
from nextmail import nextmail apps = nextmail.account.list_connected_apps() for app in apps: print(app['name'], app['kind'], app['status'], '(this app)' if app['current'] else '')Notes
A sign-in of the command line tool shows with
kindset tocli, and its device incliDevice.
Also available in
account.list_connected_app_requests()
Read the request log of a connected app
def list_connected_app_requests( client_id: str, *, limit: int | None = None, cursor: str | None = None, since: datetime | str | None = None, until: datetime | str | None = None, failed_only: bool | None = None, statuses: Sequence[int] | None = None, api_key: str | None = None, timeout: float | None = None,) -> Page[ConnectedAppRequestResource]Returns one page of the REST calls an app the person connected made with the access they gave it, newest first, as Request log in the menu of the app under Account, Connected apps shows them. Each call has its method, path, status, how long it took and the error code of a refusal, and never a body, a query string or the address it came from. The command line tool signed in from a browser is in it too. Calls made under an earlier connection of the same app are not: connecting it again starts a new log. failed_only=, statuses=, since= and until= narrow it, and they combine.
Parameters
client_idstrRequiredThe app's
clientIdfromlist_connected_apps.limitintCalls per page, a whole number from 1 to 100. The server defaults to 25.
cursorstrThe
nextCursorof the previous page, passed back unchanged. Leave it out for the first page.sincedatetime | strOnly calls at or after this instant. A
datetimeis sent as ISO 8601 in UTC, and a string must already be one.untildatetime | strOnly calls before this instant. It has to be later than
since, or the server answers 400invalid_parameter.failed_onlyboolOnly calls answered with a status of 400 or more.
statusesSequence[int]Only calls answered with one of these HTTP status codes, such as
[401, 403]. At most 20, each from 100 to 599, sent comma-separated asstatus.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
Page[ConnectedAppRequestResource], a dict with items, hasMore and nextCursor. Each item has id, clientId, workspaceId, requestId, method, path, status, errorCode, durationMs, userAgent and createdAt.
Example
from nextmail import nextmail page = nextmail.account.list_connected_app_requests( 'kZ3mQ9vT2xR7pL4wN8bY1cF6hJ5sD0aE', failed_only=True, limit=50) for call in page['items']: print(call['createdAt'], call['method'], call['path'], call['status'], call['errorCode'])Notes
An app the person never connected is a 404
resource_not_found, and a cursor this log did not hand out is a 400invalid_cursor.Calls made with an API key are in the request log of that key,
nextmail.keys.list_requests(), not here.
Also available in
- API
GET /account/connected-apps/{clientId}/requests- TypeScript
nextmail.account.listConnectedAppRequests()- Ruby
account.list_connected_app_requests- PHP
account->listConnectedAppRequests- Go
Account.ListConnectedAppRequests- Java
account().listConnectedAppRequests- C#
Account.ListConnectedAppRequestsAsync- CLI
nextmail account list-connected-app-requests
account.list_all_connected_app_requests()
Collect the whole request log of a connected app into one list
def list_all_connected_app_requests( client_id: str, *, limit: int | None = None, cursor: str | None = None, since: datetime | str | None = None, until: datetime | str | None = None, failed_only: bool | None = None, statuses: Sequence[int] | None = None, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[ConnectedAppRequestResource]Walks every page of list_connected_app_requests under the same filters and returns every call in one list. The log is never pruned, so give it a window unless you mean to read a busy app's whole history, or use iterate_connected_app_requests to stop early.
Parameters
client_idstrRequiredThe app's
clientIdfromlist_connected_apps.limitintPage size for each request, 1 to 100. The server defaults to 25.
cursorstrStarts the walk from this cursor instead of the newest call.
sincedatetime | strOnly calls at or after this instant. A
datetimeis sent as ISO 8601 in UTC, and a string must already be one.untildatetime | strOnly calls before this instant. It has to be later than
since, or the server answers 400invalid_parameter.failed_onlyboolOnly calls answered with a status of 400 or more.
statusesSequence[int]Only calls answered with one of these HTTP status codes, such as
[401, 403]. At most 20, each from 100 to 599, sent comma-separated asstatus.api_keystrOverrides the client API key for every page of this walk.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
list[ConnectedAppRequestResource], newest first.
Example
from datetime import datetime, timedelta, timezone from nextmail import nextmail today = nextmail.account.list_all_connected_app_requests( 'kZ3mQ9vT2xR7pL4wN8bY1cF6hJ5sD0aE', since=datetime.now(timezone.utc) - timedelta(days=1), limit=100,) print(len(today), 'calls in the last 24 hours')Notes
If any page fails, the call raises and the calls already fetched are discarded.
Also available in
- API
GET /account/connected-apps/{clientId}/requests- TypeScript
nextmail.account.listAllConnectedAppRequests()- Ruby
account.list_all_connected_app_requests- PHP
account->listAllConnectedAppRequests- Go
Account.ListAllConnectedAppRequests- Java
account().listAllConnectedAppRequests- C#
Account.ListAllConnectedAppRequestsAsync
account.iterate_connected_app_requests()
Stream the request log of a connected app one call at a time
def iterate_connected_app_requests( client_id: str, *, limit: int | None = None, cursor: str | None = None, since: datetime | str | None = None, until: datetime | str | None = None, failed_only: bool | None = None, statuses: Sequence[int] | None = None, api_key: str | None = None, timeout: float | None = None,) -> Iterator[ConnectedAppRequestResource]A generator over list_connected_app_requests under the same filters, fetching a page only when the one before is drained. Nothing is requested until you start iterating.
Parameters
client_idstrRequiredThe app's
clientIdfromlist_connected_apps.limitintPage size for each request, 1 to 100. The server defaults to 25.
cursorstrStarts the walk from this cursor instead of the newest call.
sincedatetime | strOnly calls at or after this instant. A
datetimeis sent as ISO 8601 in UTC, and a string must already be one.untildatetime | strOnly calls before this instant. It has to be later than
since, or the server answers 400invalid_parameter.failed_onlyboolOnly calls answered with a status of 400 or more.
statusesSequence[int]Only calls answered with one of these HTTP status codes, such as
[401, 403]. At most 20, each from 100 to 599, sent comma-separated asstatus.api_keystrOverrides the client API key for every page of this walk.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
Iterator[ConnectedAppRequestResource], a generator yielding one call per step, newest first.
Example
from nextmail import nextmail for call in nextmail.account.iterate_connected_app_requests( 'kZ3mQ9vT2xR7pL4wN8bY1cF6hJ5sD0aE', failed_only=True): print('Last refused call', call['createdAt'], call['path'], call['errorCode']) breakNotes
Breaking out of the loop stops the walk, and no further page is fetched.
Also available in
- API
GET /account/connected-apps/{clientId}/requests- TypeScript
nextmail.account.iterateConnectedAppRequests()- Ruby
account.iterate_connected_app_requests- PHP
account->iterateConnectedAppRequests- Go
Account.IterateConnectedAppRequests- Java
account().iterateConnectedAppRequests- C#
Account.IterateConnectedAppRequestsAsync
account.revoke_connected_app()
Remove a connected app
def revoke_connected_app( client_id: str, *, api_key: str | None = None, timeout: float | None = None,) -> RevokedConnectedAppResourceDeletes every token the app holds and the access the person gave it, so its next call is refused and it has to ask again, as removing it in Account, Connected apps does. Removing the app making the call disconnects it.
Parameters
client_idstrRequiredThe app's
clientIdfromlist_connected_apps.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
RevokedConnectedAppResource with revoked set to True and tokensRevoked.
Example
from nextmail import nextmail revoked = nextmail.account.revoke_connected_app('kZ3mQ9vT2xR7pL4wN8bY1cF6hJ5sD0aE') print(revoked['clientId'], 'lost', revoked['tokensRevoked'], 'tokens')Notes
An app the person never connected is a 404
resource_not_found.Not retried automatically. A retry after a lost response is a 404, since the app is already gone.
Also available in
account.list_sessions()
List your signed-in devices
def list_sessions( *, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[SessionResource]Returns every browser and phone the person is signed in on, as Account, Security lists them, most recently used first: the browser and system, the country and city it was last used from, how it signed in and when.
No address is ever recorded, only the place. A key or an app is not a signed-in device, so current is always False here.
Parameters
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
list[SessionResource], each with id, device, authMethod, country, city, createdAt, lastActiveAt and expiresAt.
Example
from nextmail import nextmail sessions = nextmail.account.list_sessions() for session in sessions: device = session['device'] print(device['browser'] or device['os'], session['city'], session['lastActiveAt'])Notes
lastActiveAtis accurate to within ten minutes.authMethodisNonefor a device that signed in before it was recorded.
Also available in
account.revoke_session()
Sign out one device
def revoke_session( session_id: str, *, api_key: str | None = None, timeout: float | None = None,) -> RevokedSessionResourceSigns one browser or phone out, as Sign out next to it in Account, Security does. Its next request is refused at once, and a phone stops getting notifications. It is written to the person's security log.
Parameters
session_idstrRequiredThe device's
idfromlist_sessions.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
RevokedSessionResource with revoked set to True.
Example
from nextmail import nextmail sessions = nextmail.account.list_sessions() for session in sessions: if session['device']['kind'] == 'browser': revoked = nextmail.account.revoke_session(session['id']) print(revoked['id'], 'signed out')Notes
A device that is not signed in to the account is a 404
resource_not_found.Not retried automatically. A retry after a lost response is a 404, since the device is already signed out.
Also available in
account.revoke_sessions()
Sign out everywhere
def revoke_sessions( *, connected_apps: bool | None = None, api_key: str | None = None, timeout: float | None = None,) -> SessionSweepResourceSigns the person out of every browser and phone at once, for when a device is lost or a password may have leaked. Each one is refused on its next request.
With connected_apps=True every connected app is removed as well, except the app making the call. A key or an app is not a signed-in device, so the call never ends its own access.
Parameters
connected_appsboolTruealso removes every connected app, apart from the one making the call. Left out, apps stay.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
SessionSweepResource with sessionsRevoked and appsRevoked.
Example
from nextmail import nextmail swept = nextmail.account.revoke_sessions(connected_apps=True) print(swept['sessionsRevoked'], 'devices and', swept['appsRevoked'], 'apps signed out')Notes
Safe to repeat: a second call finds nothing left and answers zero for both counts.
Also available in
account.list_security_events()
Read your security log
def list_security_events( *, limit: int | None = None, cursor: str | None = None, api_key: str | None = None, timeout: float | None = None,) -> Page[SecurityEventResource]Returns one page of what happened to the sign-in of the account, newest first: each sign-in with its device and place, devices signed out, password changes and resets, two-factor turned on or off, and passkeys added or removed. Nothing is ever removed from it.
Parameters
limitintPage size, from 1 to 100. The server defaults to 25.
cursorstrThe
nextCursorof the previous page. Leave it out for the first page.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
Page[SecurityEventResource], a dict with items, hasMore and nextCursor. Each item has kind, at, device, country, city, authMethod and detail.
Example
from nextmail import nextmail page = nextmail.account.list_security_events(limit=50) for event in page['items']: print(event['at'], event['kind'], event['city'] or '')Notes
A sign-in from a device not seen before has
detail['newDevice']set toTrue, and the person is told by email.A cursor that names nothing in this list is 400
invalid_cursor.
Also available in
account.list_all_security_events()
Collect your whole security log into one list
def list_all_security_events( *, limit: int | None = None, cursor: str | None = None, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[SecurityEventResource]Walks every page of list_security_events and returns every entry in one list. The log is never pruned, so use iterate_security_events to stop early on an old account.
Parameters
limitintPage size for each request, 1 to 100. The server defaults to 25.
cursorstrStarts the walk from this cursor instead of the newest entry.
api_keystrOverrides the client API key for every page of this walk.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
list[SecurityEventResource], newest first.
Example
from nextmail import nextmail events = nextmail.account.list_all_security_events(limit=100)sign_ins = [event for event in events if event['kind'] == 'sign-in'] print(len(sign_ins), 'sign-ins on record')Notes
If any page fails, the call raises and the entries already fetched are discarded.
Also available in
account.iterate_security_events()
Stream your security log one entry at a time
def iterate_security_events( *, limit: int | None = None, cursor: str | None = None, api_key: str | None = None, timeout: float | None = None,) -> Iterator[SecurityEventResource]A generator over list_security_events, fetching a page only when the one before is drained. Nothing is requested until you start iterating.
Parameters
limitintPage size for each request, 1 to 100. The server defaults to 25.
cursorstrStarts the walk from this cursor instead of the newest entry.
api_keystrOverrides the client API key for every page of this walk.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
Iterator[SecurityEventResource], a generator yielding one entry per step, newest first.
Example
from nextmail import nextmail for event in nextmail.account.iterate_security_events(): if event['kind'] == 'password-changed': print('Password last changed', event['at']) breakNotes
Breaking out of the loop stops the walk, and no further page is fetched.
Also available in
account.list_passkeys()
List your passkeys
def list_passkeys( *, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[PasskeyResource]Returns the passkeys that can sign in to the account, oldest first, each with its name, whether it is synced between the person's devices and when it was last used.
A passkey is added on the device that holds it, in Account, Security, never through the API.
Parameters
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
list[PasskeyResource], each with id, name, synced, transports, createdAt and lastUsedAt.
Example
from nextmail import nextmail passkeys = nextmail.account.list_passkeys() for passkey in passkeys: print(passkey['name'], passkey['lastUsedAt'] or 'never used')Notes
The key itself is never returned, only its name and when it was used.
Also available in
account.rename_passkey()
Rename a passkey
def rename_passkey( passkey_id: str, name: str, *, api_key: str | None = None, timeout: float | None = None,) -> PasskeyResourceGives a passkey a name the person will recognise, such as the device that holds it.
Parameters
passkey_idstrRequiredThe passkey's
idfromlist_passkeys.namestrRequiredThe new name, 1 to 60 characters.
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
PasskeyResource with its new name.
Example
from nextmail import nextmail passkeys = nextmail.account.list_passkeys() if passkeys: renamed = nextmail.account.rename_passkey(passkeys[0]['id'], 'Work laptop') print(renamed['id'], renamed['name'])Notes
A passkey that is not on the account is a 404
resource_not_found.A name that is empty or longer than 60 characters is a 422
invalid_parameter.Retried automatically on network failure, since the same name sent twice changes nothing.
Also available in
account.remove_passkey()
Remove a passkey
def remove_passkey( passkey_id: str, *, api_key: str | None = None, timeout: float | None = None,) -> RemovedPasskeyResourceRemoves a passkey, so it can no longer sign in or confirm a change. The person is told by email, and it is written to their security log. The passkey stays on the device until they delete it there.
Parameters
passkey_idstrRequiredThe passkey's
idfromlist_passkeys.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
RemovedPasskeyResource with removed set to True.
Example
from nextmail import NextmailApiError, nextmail try: removed = nextmail.account.remove_passkey('pk_3f8a2c1e-9b47-4d6a-8e15-7c2b0a9d4f63')except NextmailApiError as error: if not error.is_not_found: raise print('That passkey is already gone')else: print(removed['id'], removed['removed'])Notes
A passkey that is not on the account is a 404
resource_not_found.Not retried automatically. A retry after a lost response is a 404, since the passkey is already gone.
Also available in
account.list_invitations()
List your invitations
def list_invitations( *, api_key: str | None = None, timeout: float | None = None,) -> builtins.list[ReceivedInvitationResource]Returns the invitations to join a workspace that are waiting for the address the person signs in with, oldest first. Expired, accepted and withdrawn ones are left out. The invitations a workspace sent are members.list_invitations instead.
Parameters
api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
list[ReceivedInvitationResource], each with id, workspaceName, roleName, inviterName, addresses and expiresAt.
Example
from nextmail import nextmail invitations = nextmail.account.list_invitations() for invitation in invitations: print(invitation['workspaceName'], invitation['roleName'], invitation['expiresAt'])Notes
addressescounts the addresses and the whole domains the invitation gives together.
Also available in
account.accept_invitation()
Accept an invitation
def accept_invitation( invitation_id: str, *, activate: bool | None = None, api_key: str | None = None, timeout: float | None = None,) -> AcceptedInvitationResourceJoins the workspace with the role and the addresses the invitation gives, as accepting it in the app or from its link does. activate=True also makes it the workspace the app opens for the person.
A workspace that asks everyone in it to sign in with two-factor authentication is refused with 403 two_factor_required until the person turns it on. An invitation that expired, was withdrawn or went to another address is a 422, and one that is not waiting any more a 404 invitation_not_found.
Parameters
invitation_idstrRequiredAn invitation id from
list_invitations.activateboolTrueto make it the workspace the app opens. Defaults toFalse.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
AcceptedInvitationResource with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.
Example
from nextmail import nextmail invitations = nextmail.account.list_invitations() if invitations: joined = nextmail.account.accept_invitation(invitations[0]['id'], activate=True) print(joined['workspaceName'], joined['addressesGranted'], joined['activated'])Notes
Retried automatically on network failure, since accepting an invitation the person already accepted succeeds again and changes nothing.
Also available in
account.decline_invitation()
Decline an invitation
def decline_invitation( invitation_id: str, *, api_key: str | None = None, timeout: float | None = None,) -> DeclinedInvitationResourceTurns the invitation down, so its link stops working, and tells whoever sent it. It cannot be taken back: they have to invite the person again. An invitation the person already accepted is refused with 409 invitation_accepted.
Parameters
invitation_idstrRequiredAn invitation id from
list_invitations.api_keystrOverrides the client's API key for this call only.
timeoutfloatSeconds this call may take, the response included, before it raises
NextmailNetworkErrorwithis_timeout. It overrides the client'stimeoutfor this call, and0turns the limit off.
Returns
DeclinedInvitationResource with declined set to True.
Example
from nextmail import nextmail declined = nextmail.account.decline_invitation('winv_6bb640f5b99e47deb758f1f5') print(declined['id'], declined['declined'])Notes
Retried automatically on network failure, since declining twice changes nothing.
Google Workspace
Fastmail