client.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
get_notifications(api_key: nil) -> HashReturns 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_keyStringOverrides the client's API key for this call only.
Returns
A Hash with email, an Array with one Hash for each kind of email, each with category, label, description, required and enabled, and mutedWorkspaces.
Example
settings = client.account.get_notifications settings[:email].each { |kind| puts "#{kind[:label]} #{kind[:enabled]}" }Notes
accountandbillingemail are always on, andrequiredsays so.
Also available in
account.set_email_notification
Turn a kind of email on or off
set_email_notification(category, body = nil, api_key: nil, **fields) -> Hashenabled: false stops Nextmail sending the person that kind of email, and 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
categoryStringRequiredaccount,billing,activityorproduct.enabledBooleanRequiredTrue to receive that email, false to stop it.
api_keyStringOverrides the client's API key for this call only.
Returns
The same Hash as account.get_notifications, as it is after the change.
Example
client.account.set_email_notification("product", enabled: false)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()- Python
account.set_email_notification()- PHP
account->setEmailNotification- Go
Account.SetEmailNotification- Java
account().setEmailNotification- C#
Account.SetEmailNotificationAsync- CLI
openemail account set-email-notification
account.set_push_muted
Mute a workspace on your phone
set_push_muted(workspace_id, body = nil, api_key: nil, **fields) -> Hashmuted: true stops the phone app notifying the person about the mail of one workspace, on every phone they signed in on, and false lets it notify them again.
Parameters
workspace_idStringRequiredA workspace id from
workspaces.list.mutedBooleanRequiredTrue to mute it, false to let it notify again.
api_keyStringOverrides the client's API key for this call only.
Returns
The same Hash as account.get_notifications, with the new mutedWorkspaces.
Example
settings = client.account.set_push_muted("10417196-e324-4283-af98-66ec62167c47", muted: true) p 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
set_photo(data, content_type: nil, api_key: nil) -> HashSends 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 a binary String, an IO or a Pathname. The type is read from content_type:, or, when that is left out, from the content_type of data itself or the extension of its file name. Without either the bytes go as application/octet-stream and the server refuses them with 422 invalid_image.
Parameters
dataString, IO or PathnameRequiredThe image: a binary
String, anIOor aPathname.content_typeStringimage/png,image/jpeg,image/webporimage/gif. Required unlessdatacarries its type, as an object with acontent_typeor aPathnameorFilenamed with the extension of the type.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with the new url.
Example
photo = client.account.set_photo(File.binread("photo.jpg"), content_type: "image/jpeg") puts 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
remove_photo(api_key: nil) -> HashRemoves 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_keyStringOverrides the client's API key for this call only.
Returns
A Hash with url nil.
Example
client.account.remove_photoNotes
Safe to replay, so the SDK retries it after a network failure.
Also available in
account.get_username
Read your username
get_username(api_key: nil) -> HashReturns 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_keyStringOverrides the client's API key for this call only.
Returns
A Hash with username, chosen and address.
Example
username, chosen, address = client.account.get_username.values_at(:username, :chosen, :address) puts username, chosen ? "chosen" : "made for you", addressNotes
The first read makes a username for an account that has none.
Also available in
account.check_username
Check a username
check_username(username, api_key: nil) -> HashSays 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
usernameStringRequiredUp to 60 characters before it is tidied.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with status, available and a message that says why.
Example
check = client.account.check_username("ada.lovelace") puts check[:message] unless check[:available]Notes
statusiscurrentfor the username the person already has, andavailableis false for it.
Also available in
account.set_username
Choose your username
set_username(username, api_key: nil) -> HashSets 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
usernameStringRequired3 to 30 lowercase letters, numbers and single dots once it is tidied.
api_keyStringOverrides the client's API key for this call only.
Returns
The same Hash as account.get_username, with chosen set to true.
Example
check = client.account.check_username("ada.lovelace") if check[:available] == false puts check[:message]else client.account.set_username(check[:username])endNotes
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
list_connected_apps(api_key: nil) -> Array<Hash>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_keyStringOverrides the client's API key for this call only.
Returns
An Array of Hashes, each with clientId, name, kind, status, grant and tokenCount.
Example
apps = client.account.list_connected_apps apps.each do |app| label = app[:current] ? "(this app)" : "" puts "#{app[:name]} #{app[:status]} #{label}"endNotes
A sign-in of the command line tool shows as
kind: "cli", with its device incliDevice.
Also available in
account.list_connected_app_requests
Read the request log of a connected app
list_connected_app_requests(client_id, failed_only: nil, statuses: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> Nextmail::PageReturns 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_idStringRequiredThe app's
clientIdfromlist_connected_apps.failed_onlyBooleanOnly calls answered with a status of 400 or more.
statusesArray<Integer>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.sinceTime, Date or StringOnly calls at or after this instant. A
Timeis sent as ISO 8601 in UTC, and a String must already be ISO 8601.untilTime, Date or StringOnly calls before this instant. It has to be later than
since, or the server answers 400invalid_parameter.limitIntegerCalls per page, a whole number from 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorof the previous page, passed back unchanged. Leave it out for the first page.api_keyStringOverrides the client's API key for this call only.
Returns
An Nextmail::Page of Hashes, with items, has_more? and next_cursor. Each item has id, clientId, workspaceId, requestId, method, path, status, errorCode, durationMs, userAgent and createdAt.
Example
page = client.account.list_connected_app_requests("kPzQwRtYuIoPaSdFgHjKlZxCvBnMqWeR", failed_only: true, limit: 50) page.items.each do |call| puts call.values_at(:createdAt, :method, :path, :status, :errorCode).join(" ")endNotes
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,
keys.list_requests, not here.
Also available in
- API
GET /account/connected-apps/{clientId}/requests- TypeScript
nextmail.account.listConnectedAppRequests()- Python
account.list_connected_app_requests()- PHP
account->listConnectedAppRequests- Go
Account.ListConnectedAppRequests- Java
account().listConnectedAppRequests- C#
Account.ListConnectedAppRequestsAsync- CLI
openemail account list-connected-app-requests
account.list_all_connected_app_requests
Collect the whole request log of a connected app into one Array
list_all_connected_app_requests(client_id, failed_only: nil, statuses: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Walks every page of list_connected_app_requests under the same filters. 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_idStringRequiredThe app's
clientIdfromlist_connected_apps.failed_onlyBooleanOnly calls answered with a status of 400 or more.
statusesArray<Integer>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.sinceTime, Date or StringOnly calls at or after this instant. A
Timeis sent as ISO 8601 in UTC, and a String must already be ISO 8601.untilTime, Date or StringOnly calls before this instant. It has to be later than
since, or the server answers 400invalid_parameter.limitIntegerPage size for each request, 1 to 100. The server defaults to 25.
cursorStringStarts the walk from this cursor instead of the newest call.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Array of Hashes, one per call with the fields list_connected_app_requests returns, newest first.
Example
today = client.account.list_all_connected_app_requests("kPzQwRtYuIoPaSdFgHjKlZxCvBnMqWeR", since: Time.now - (24 * 60 * 60), limit: 100) puts "#{today.size} calls today"Notes
If any page fails, the error is raised and the calls already fetched are discarded.
Also available in
- API
GET /account/connected-apps/{clientId}/requests- TypeScript
nextmail.account.listAllConnectedAppRequests()- Python
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
iterate_connected_app_requests(client_id, failed_only: nil, statuses: nil, since: nil, until: nil, limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>An Enumerator over list_connected_app_requests under the same filters, fetching a page only when the one before is drained. Given a block, it yields each call to the block instead.
Parameters
client_idStringRequiredThe app's
clientIdfromlist_connected_apps.failed_onlyBooleanOnly calls answered with a status of 400 or more.
statusesArray<Integer>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.sinceTime, Date or StringOnly calls at or after this instant. A
Timeis sent as ISO 8601 in UTC, and a String must already be ISO 8601.untilTime, Date or StringOnly calls before this instant. It has to be later than
since, or the server answers 400invalid_parameter.limitIntegerPage size for each request, 1 to 100. The server defaults to 25.
cursorStringStarts the walk from this cursor instead of the newest call.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Enumerator of Hashes, one call per step (or yields each one to a block).
Example
refused = client.account.iterate_connected_app_requests("kPzQwRtYuIoPaSdFgHjKlZxCvBnMqWeR", failed_only: true).first puts "last refused call at #{refused[:createdAt]}" if refusedAlso available in
- API
GET /account/connected-apps/{clientId}/requests- TypeScript
nextmail.account.iterateConnectedAppRequests()- Python
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
revoke_connected_app(client_id, api_key: nil) -> HashDeletes 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_idStringRequiredThe app's
clientIdfromlist_connected_apps.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with revoked set to true and tokensRevoked.
Example
revoked = client.account.revoke_connected_app("kPzQwRtYuIoPaSdFgHjKlZxCvBnMqWeR") puts revoked[:tokensRevoked]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
list_sessions(api_key: nil) -> Array<Hash>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_keyStringOverrides the client's API key for this call only.
Returns
An Array of Hashes, each with id, device, authMethod, country, city, createdAt, lastActiveAt and expiresAt.
Example
sessions = client.account.list_sessions sessions.each do |session| device = session.dig(:device, :browser) || session.dig(:device, :os) puts "#{device} #{session[:city]} #{session[:lastActiveAt]}"endNotes
lastActiveAtis accurate to within ten minutes.authMethodis nil for a device that signed in before it was recorded.
Also available in
account.revoke_session
Sign out one device
revoke_session(session_id, api_key: nil) -> HashSigns 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_idStringRequiredThe device's
idfromlist_sessions.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with revoked set to true.
Example
sessions = client.account.list_sessionsabroad = sessions.reject { |session| session[:country] == "GB" } abroad.each { |session| client.account.revoke_session(session[:id]) }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
revoke_sessions(connected_apps: nil, api_key: nil) -> HashSigns 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_appsBooleanAlso removes every connected app, apart from the one making the call. Left out, apps stay.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with sessionsRevoked and appsRevoked.
Example
swept = client.account.revoke_sessions(connected_apps: true) puts "#{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
list_security_events(limit: nil, cursor: nil, api_key: nil) -> Nextmail::PageReturns 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
limitIntegerPage size, from 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorof the previous page. Leave it out for the first page.api_keyStringOverrides the client's API key for this call only.
Returns
An Nextmail::Page of Hashes with items, has_more? and next_cursor. Each item has kind, at, device, country, city, authMethod and detail.
Example
page = client.account.list_security_events(limit: 50) page.items.each { |event| puts "#{event[:at]} #{event[:kind]} #{event[:city]}" }Notes
A sign-in from a device not seen before has
newDeviceset to true indetail, 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 Array
list_all_security_events(limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Walks every page of list_security_events. The log is never pruned, so use iterate_security_events to stop early on an old account.
Parameters
limitIntegerPage size for each request, 1 to 100. The server defaults to 25.
cursorStringStarts the walk from this cursor instead of the newest entry.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Array of Hashes, newest first.
Example
events = client.account.list_all_security_events(limit: 100)sign_ins = events.count { |event| event[:kind] == "sign-in" } puts "#{sign_ins} sign-ins on record"Notes
If any page fails, the error is raised and the entries already fetched are discarded.
Also available in
account.iterate_security_events
Stream your security log one entry at a time
iterate_security_events(limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>An Enumerator over list_security_events, fetching a page only when the one before is drained. Given a block, it yields each entry to the block instead.
Parameters
limitIntegerPage size for each request, 1 to 100. The server defaults to 25.
cursorStringStarts the walk from this cursor instead of the newest entry.
api_keyStringOverrides the client API key for every page of this walk.
Returns
An Enumerator of Hashes, newest first (or yields each one to a block).
Example
changed = client.account.iterate_security_events.find { |event| event[:kind] == "password-changed" } puts "Password last changed #{changed[:at]}" if changedNotes
Breaking out of the loop stops the walk, and no further page is fetched.
Also available in
account.list_passkeys
List your passkeys
list_passkeys(api_key: nil) -> Array<Hash>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_keyStringOverrides the client's API key for this call only.
Returns
An Array of Hashes, each with id, name, synced, transports, createdAt and lastUsedAt.
Example
passkeys = client.account.list_passkeys passkeys.each { |passkey| puts "#{passkey[:name]} #{passkey[:lastUsedAt] || "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
rename_passkey(passkey_id, name, api_key: nil) -> HashGives a passkey a name the person will recognise, such as the device that holds it.
Parameters
passkey_idStringRequiredThe passkey's
idfromlist_passkeys.nameStringRequiredThe new name, 1 to 60 characters.
api_keyStringOverrides the client's API key for this call only.
Returns
The same Hash as an item of list_passkeys, with its new name.
Example
passkey = client.account.list_passkeys.first client.account.rename_passkey(passkey[:id], "Work laptop") if passkeyNotes
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.
Also available in
account.remove_passkey
Remove a passkey
remove_passkey(passkey_id, api_key: nil) -> HashRemoves 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_idStringRequiredThe passkey's
idfromlist_passkeys.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with removed set to true.
Example
passkeys = client.account.list_passkeysunused = passkeys.select { |passkey| passkey[:lastUsedAt].nil? } unused.each { |passkey| client.account.remove_passkey(passkey[:id]) }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
list_invitations(api_key: nil) -> Array<Hash>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_keyStringOverrides the client's API key for this call only.
Returns
An Array of Hashes, each with id, workspaceName, roleName, inviterName, addresses and expiresAt.
Example
invitations = client.account.list_invitations invitations.each { |invitation| puts "#{invitation[:workspaceName]} #{invitation[:roleName]}" }Notes
addressescounts the addresses and the whole domains the invitation gives together.
Also available in
account.accept_invitation
Accept an invitation
accept_invitation(invitation_id, activate: nil, api_key: nil) -> HashJoins 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_idStringRequiredAn invitation id from
list_invitations.activateBooleanTrue to make it the workspace the app opens. Defaults to false.
api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with workspaceId, workspaceName, addressesGranted, domainsGranted and activated.
Example
first = client.account.list_invitations.first if first joined = client.account.accept_invitation(first[:id], activate: true) puts joined[:workspaceName]endNotes
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
decline_invitation(invitation_id, api_key: nil) -> HashTurns 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_idStringRequiredAn invitation id from
list_invitations.api_keyStringOverrides the client's API key for this call only.
Returns
A Hash with declined set to true.
Example
client.account.decline_invitation("winv_6bb640f5b99e47deb758f1f5")Notes
Retried automatically on network failure, since declining twice changes nothing.