client.connected_mailboxes
Every method in this namespace: its signature, its parameters, what it returns and an example.
Methods
Mailboxes that stay at Gmail, Yahoo, iCloud or another provider and are worked from Nextmail: find their mail servers, connect one with an app password, see whether it syncs, pause, resume or rename it, give it a new password, sync it now and disconnect it. New mail is copied in, what is done to it here goes back to the provider, and mail written as its address is sent through the provider.
connected_mailboxes.list
List the connected mailboxes
list(api_key: nil) -> Array<Hash>Returns every mailbox connected to the workspace in one Array, newest first. The list comes whole and is never paged. A connected mailbox stays at its provider, such as Gmail or Yahoo, and is worked from Nextmail: its new mail is copied in, what is done to it here goes back to the provider, and mail written as its address is sent through the provider.
status is active while it syncs and sends, paused while a person stopped it, needs-sign-in when the provider stopped accepting its password, and failing when the last five syncs failed and it keeps trying less often. Nextmail::CONNECTED_MAILBOX_STATUSES holds the values.
Parameters
api_keyStringOverrides the client API key for this call only.
Returns
An Array of Hashes. Each item has id, addressId, email, label, provider, method, status, pauseReason, lastError, lastSyncedAt, createdAt, connectedBy, username, imap, smtp and historyImportId. method is one of Nextmail::CONNECTED_MAILBOX_METHODS, status one of Nextmail::CONNECTED_MAILBOX_STATUSES, and pauseReason nil or one of Nextmail::CONNECTED_MAILBOX_PAUSE_REASONS. imap and smtp are nil or a Hash with host, port and security.
Example
client.connected_mailboxes.list.each do |mailbox| puts "#{mailbox[:email]} #{mailbox[:status]} #{mailbox[:lastSyncedAt]}"endNotes
A key or an app limited to particular addresses sees only the mailboxes of those addresses.
pauseReasonsays why a mailbox is notactive:by-person,sign-inorunreachable, the values ofNextmail::CONNECTED_MAILBOX_PAUSE_REASONS. It is nil while the mailbox is active.lastErroris what the mail server said the last time something went wrong, and nil while nothing is wrong.Read only, so the SDK retries it after a network failure like any other read.
Also available in
connected_mailboxes.get
Read one connected mailbox by id
get(id, api_key: nil) -> HashLooks up one connected mailbox and returns it in the same shape as a row of list: whether it is syncing, when it last finished, and what went wrong if it did not.
Parameters
idStringRequiredConnected mailbox id such as
cmb_5c1e9a7b3d2f48e6a0b4c7d1, aslistreturns it.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with id, addressId, email, label, provider, method, status, pauseReason, lastError, lastSyncedAt, createdAt, connectedBy, username, imap, smtp and historyImportId. method is one of Nextmail::CONNECTED_MAILBOX_METHODS, status one of Nextmail::CONNECTED_MAILBOX_STATUSES, and pauseReason nil or one of Nextmail::CONNECTED_MAILBOX_PAUSE_REASONS.
Example
mailbox = client.connected_mailboxes.get("cmb_5c1e9a7b3d2f48e6a0b4c7d1") puts "Send a new app password with update" if mailbox[:status] == Nextmail::CONNECTED_MAILBOX_STATUSES[:NEEDS_SIGN_IN]Notes
A missing mailbox, or one whose address the caller cannot reach, raises
Nextmail::ApiErrorwithnot_found?true and codeconnected_mailbox_not_found.Read only, so the SDK retries it after a network failure like any other read.
Also available in
connected_mailboxes.discover
Find the mail servers for a mailbox
discover(email, api_key: nil) -> HashLooks up where the mailbox behind an address lives and what it signs in with, so the right password can be asked for before connect. Nothing is stored and no sign-in is attempted.
signIn is app-password for Gmail, Yahoo, iCloud and the other providers that want one, password where the everyday password works, and microsoft for Outlook.com and Microsoft 365, which only the Microsoft sign-in in the app can connect. imap is nil when nothing was found: pass host to connect. smtp is nil when the outgoing server is found while connecting, or can be passed as smtpHost.
Parameters
emailStringRequiredThe address of the mailbox.
api_keyStringOverrides the client API key for this call only.
Returns
A Hash with object, email, provider, one of Nextmail::MAILBOX_PROVIDERS, signIn, one of Nextmail::MAILBOX_SIGN_INS, imap and smtp. imap and smtp are nil or a Hash with host, port and security.
Example
settings = client.connected_mailboxes.discover("[email protected]") if settings[:signIn] == "app-password" puts "Make an app password at #{settings[:provider]}"else puts settings[:signIn], settings.dig(:imap, :host)endNotes
Something that is not an email address is a 400
mailbox_address_invalid.Too many lookups in an hour is a 429
mailbox_checks_limited.A GET is retried automatically on network failure and on 408, 500, 502, 503 and 504 responses, up to the client's
max_retries, and on a 429 only when it carries aRetry-Afterof a minute or less.
Also available in
connected_mailboxes.connect
Connect a mailbox at another provider
connect(body = nil, api_key: nil, **fields) -> HashConnects a mailbox that stays at Gmail, Yahoo, iCloud or another provider, so its address becomes an address of the workspace while its mail stays where it is. It signs in to the incoming and the outgoing server with the password, keeps the password sealed, adds the address and starts copying new mail in within a minute.
From then on read, starred, archived, spam and deleted go back to the provider, and mail written as the address goes out through the provider, so it lands in its Sent folder too. With importHistory: true it also starts an import of the mail already in the mailbox, which imports.get follows by historyImportId.
Most providers want an app password, made in the account's security settings, not the everyday password. Leave host and smtpHost out to have the servers found from the address, as discover shows.
Parameters
emailStringRequiredThe address of the mailbox, such as
[email protected].passwordStringRequiredThe app password of the mailbox, or its password where the provider has no app passwords.
hostStringThe IMAP server. Left out, it is looked up from the address.
portIntegerThe IMAP port: 993 with TLS, or 143 with STARTTLS.
securityStringHow the IMAP connection is encrypted:
tlsorstarttls, the values ofNextmail::MAILBOX_SECURITIES.usernameStringThe name to sign in with, when it is not the address.
smtpHostStringThe SMTP server mail is sent through. Left out, it is found.
smtpPortIntegerThe SMTP port: 465 with TLS, or 587 with STARTTLS.
smtpSecurityStringHow the SMTP connection is encrypted:
tlsorstarttls, the values ofNextmail::MAILBOX_SECURITIES.labelString or nilA name for the address, shown beside it in the app, up to 120 characters.
importHistoryBooleanWhether to copy the mail already in the mailbox as well. Left out, only mail that arrives from now on comes in.
api_keyStringOverrides the client API key for this call only.
Returns
A Hash with a new id, the addressId the mailbox appears as, and status active.
Example
mailbox = client.connected_mailboxes.connect( email: "[email protected]", password: ENV["GMAIL_APP_PASSWORD"], label: "Ada (Gmail)", importHistory: true) puts mailbox[:id], mailbox[:addressId], mailbox[:status]Notes
Mail from a connected address is sent through the provider, never through Nextmail's servers, and only to people. Broadcasts, automations, sign-up forms and
emails.sendwith an API key refuse it as the sender.A wrong password is a 400
mailbox_login_failed, and an outgoing server that refuses it a 400connected_mailbox_send_sign_in_failed. No server found is a 400mailbox_settings_unknownorconnected_mailbox_send_server_unknown. An Outlook.com or Microsoft 365 mailbox is a 400mailbox_uses_microsoft: connect it with the Microsoft sign-in in the app, and manage it from here after that.An address whose mail already comes to Nextmail is a 400
connected_mailbox_domain_hosted. A mailbox already connected here is a 409connected_mailbox_already_connected, and one connected to another workspace a 409connected_mailbox_connected_elsewhere.The address counts toward the addresses of the plan, and a full plan is a 422
workspace_limit_reached. A key or an app limited to particular addresses or domains is refused with 422capability_unsupported.Each person may make 10 sign-in attempts an hour across this call,
updatewith a password and the imports calls, and more is a 429mailbox_checks_limited.Not retried automatically: a retry after a lost response answers 409
connected_mailbox_already_connected, which then means the first call went through.
Also available in
connected_mailboxes.update
Pause, resume or rename a connected mailbox, or give it a new password
update(id, patch = nil, api_key: nil, **fields) -> HashChanges a connected mailbox and returns it as it is now. Send only what changes: a field left out stays as it is.
paused: true stops syncing and sending through the mailbox, and paused: false starts both again. The mail already copied in stays either way. password gives it a new app password after the provider stopped accepting the old one: it is checked against both servers before it is kept, and a mailbox that needed signing in starts syncing again. label renames its address, and label: nil clears the name.
Parameters
idStringRequiredConnected mailbox id such as
cmb_5c1e9a7b3d2f48e6a0b4c7d1, aslistreturns it.pausedBooleantruepauses the mailbox andfalseresumes it. Left out, it stays as it is.passwordStringA new app password. Left out, the password stays.
labelString or nilA name for the address, up to 120 characters, or
nilto clear it. Left out, the name stays.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with the unchanged id, and status, pauseReason and label as they are now.
Example
mailbox = client.connected_mailboxes.update("cmb_5c1e9a7b3d2f48e6a0b4c7d1", password: ENV["GMAIL_APP_PASSWORD"]) puts mailbox[:status]Notes
A mailbox that needs signing in cannot be paused or resumed until it has a new password, or until a
microsoftone is signed in again in the app.A password the mail server refuses is a 400
mailbox_login_failedorconnected_mailbox_send_sign_in_failed, and the old one stays. Amicrosoftmailbox has no password to change, which is a 400connected_mailbox_no_password: it signs in again in the app. A missing mailbox is a 404connected_mailbox_not_found.A value of the wrong type or length is 422
invalid_parameter, and a key the patch does not take 422unknown_parameter.Not retried automatically. Read it with
getbefore you try again.
Also available in
connected_mailboxes.sync
Sync a connected mailbox now
sync(id, api_key: nil) -> HashAsks for a sync straight away instead of at the next interval, and returns the mailbox at once. The sync follows within seconds, and lastSyncedAt moves when it has finished.
A mailbox is synced every 30 seconds while mail comes in, and less often after it has been quiet for a while, down to every five minutes. A paused mailbox, or one that needs signing in, is not synced.
Parameters
idStringRequiredConnected mailbox id such as
cmb_5c1e9a7b3d2f48e6a0b4c7d1, aslistreturns it.api_keyStringOverrides the client API key for this call only.
Returns
A Hash: the mailbox as it was when the sync was asked for, in the shape get returns.
Example
mailbox = client.connected_mailboxes.sync("cmb_5c1e9a7b3d2f48e6a0b4c7d1") puts mailbox[:status], mailbox[:lastSyncedAt]Notes
A missing mailbox is a 404
connected_mailbox_not_found.Asking twice does no harm, so the SDK retries this call after a network failure.
Also available in
connected_mailboxes.disconnect
Disconnect a mailbox
disconnect(id, api_key: nil) -> HashStops syncing and sending through the mailbox, forgets its password and removes its address from the workspace. The mail already copied in stays in Nextmail, and nothing is changed at the provider. An import of its history that is still running is cancelled.
To stop it for a while and keep it, use update with paused: true. To use it again later, start over with connect.
Parameters
idStringRequiredConnected mailbox id such as
cmb_5c1e9a7b3d2f48e6a0b4c7d1, aslistreturns it.api_keyStringOverrides the client API key for this call only.
Returns
A Hash with object set to connected_mailbox, the id, the addressId it appeared as, its email, and deleted set to true.
Example
removed = client.connected_mailboxes.disconnect("cmb_5c1e9a7b3d2f48e6a0b4c7d1") puts removed[:email], removed[:deleted]Notes
A missing mailbox is a 404
connected_mailbox_not_found.The SDK retries this call after a network failure. When the first attempt went through and only its answer was lost, the retry answers 404
connected_mailbox_not_found, which then means the mailbox is disconnected.
Also available in
- API
DELETE /connected-mailboxes/{id}- TypeScript
nextmail.connectedMailboxes.disconnect()- Python
connected_mailboxes.disconnect()- PHP
connectedMailboxes->disconnect- Go
ConnectedMailboxes.Disconnect- Java
connectedMailboxes().disconnect- C#
ConnectedMailboxes.DisconnectAsync- CLI
openemail connected-mailboxes disconnect