nextmail connected-mailboxes

Resolves 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.

Looks 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.

Looks 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 null when nothing was found: pass host to connect. smtp is null when the outgoing server is found while connecting, or can be passed as smtpHost.

Connects 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 --smtp-host out to have the servers found from the address, as discover shows.

Changes a connected mailbox and resolves with 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 null clears the name.

Asks for a sync straight away instead of at the next interval, and resolves at once with the mailbox. 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.

Stops 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.