Connected mailboxes
Mailboxes that stay at Gmail or another provider and are worked from here.
Connected mailboxes tools
| Tool | What it does |
|---|---|
| listConnectedMailboxes | The mailboxes connected to the workspace, newest first: the address of each, its provider, whether it syncs and when it last did. |
| getConnectedMailbox | One connected mailbox by its id, with what went wrong if it stopped syncing. |
| getConnectedMailboxSettings | Look up the mail servers of an address and whether it takes an app password, a password or a Microsoft sign-in. Nothing is connected. |
| updateConnectedMailbox | Pause or resume a connected mailbox, or rename its address. A chat asks first unless you asked for it. |
| syncConnectedMailbox | Sync a connected mailbox now instead of at the next interval. A chat asks first unless you asked for it. |
| disconnectConnectedMailbox | Stop syncing and sending through a mailbox and remove its address. The mail already here stays, and nothing changes at the provider. In the app’s chat it always asks first. |
Reading needs threads:read, and syncing threads:write. Pausing, renaming and disconnecting need domains:write. A client limited to some addresses sees only the mailboxes of those addresses.
Connecting a mailbox takes its app password, which never passes through a tool: the person enters it in the app, or a script sends it with POST /connected-mailboxes. A new password after the old one stopped working goes the same way.
Reference
listConnectedMailboxes
The outside mailboxes connected to this workspace (Gmail, Outlook, Yahoo, iCloud and other accounts), newest first, as Settings, Connected mailboxes lists them: the address, the provider, whether it is syncing, paused or needs its sign-in again, and when it last synced. Mail arrives from each one about once a minute, and what a person does here (read, archive, delete, spam) is done there too. A member sees the mailboxes they reach.
Inputs
Takes no input.
Also available in
getConnectedMailbox
One connected mailbox by its id: its address, provider, status, servers and last sync.
Inputs
idstringRequired- 1 to 64 characters
Also available in
getConnectedMailboxSettings
The servers and the kind of sign-in an address needs before it can be connected: the provider, the incoming IMAP server and the outgoing SMTP server. The connection itself needs a password and happens in the app or over the REST API, never through a tool. An Outlook.com or Microsoft 365 address connects in the app with a Microsoft sign-in.
Inputs
emailstringRequired- 3 to 320 characters
Also available in
updateConnectedMailbox
Pause or resume a connected mailbox, or rename how its address shows. A paused mailbox neither syncs nor sends. A new password, or a new Microsoft sign-in for an Outlook mailbox, is given in the app, never through a tool. A chat asks first unless the person asked for it.
Inputs
idstringRequired- 1 to 64 characters
pausedbooleanlabelstring- Can be nullUp to 120 characters
Also available in
syncConnectedMailbox
Ask a connected mailbox to sync now instead of at its next minute.
Inputs
idstringRequired- 1 to 64 characters
Also available in
disconnectConnectedMailbox
Disconnect an outside mailbox. It stops syncing and can no longer send from here; the mail already here stays, and nothing is deleted at the provider. A chat always asks first.
Inputs
idstringRequired- 1 to 64 characters