Apps and agents

Browser extension

See who is at the door from any tab, decide about senders, and get a notice when mail arrives.

imbox docs

The extension panel: the senders at the door with a tick and a cross each, the day's events, the latest in the Imbox, and Search, Write and Event along the bottom

The extension shows how many new senders are waiting in your Screener on the browser toolbar, and lets you decide about them without opening imbox. It works in Chrome, Edge and Firefox.

It talks to your server with its own token. It never gets your password or your session, and it can't read the pages you visit.

What it shows

  • The badge. A number is how many senders wait in the Screener. A dash means the extension is not connected yet. An exclamation mark means it can't reach your server. Nothing means no one is waiting.
  • The side panel (Chrome and Edge), and the smaller popup when the panel is closed:
    • At the door: the next three senders, each with a button to let in or keep out.
    • Today: your calendar, with a Join button for video calls.
    • Recent Imbox: the latest threads from all your mailboxes.
    • Along the bottom: Search, Write, open imbox, and add an event.
  • Notices. A system notice when a new sender arrives or mail lands in your Imbox. Choose which in the extension's settings. Clicking one opens that sender in imbox.
  • Right-click menu. On an email address or a mailto: link: write to this address, or show their mail in imbox.

Install

Your server offers the extension as a download on its Apps page. The file is /downloads/imbox-extension.zip. The same code is in the repository under apps/extension.

Chrome and Edge

  1. Unzip imbox-extension.zip.
  2. Open chrome://extensions (or edge://extensions) and turn on Developer mode.
  3. Choose Load unpacked and select the unzipped folder.

Firefox

  1. Open about:debugging#/runtime/this-firefox.
  2. Choose Load Temporary Add-on and select manifest.json in the unzipped folder.

Firefox removes a temporary add-on when it closes, so you add it again next time.

Connect it

  1. In imbox, open Settings → Integrations → Browser extension.
  2. Name the token, for example MacBook Chrome, and choose Make a token.
  3. Copy the token. It starts with imx_ and is shown once.
  4. Click the extension icon, enter your server address, such as https://imbox.example.com, paste the token and choose Connect.

Your browser asks to allow the extension on your server's address only. To disconnect a browser, delete its token in the same place in Settings.

What a token can do

The server accepts only these requests from an extension token. Anything else is refused with 403.

RequestUsed for
GET /api/countsThe badge and the counts
GET /api/screener/waitingThe senders at the door
POST /api/screener/decideLetting a sender in or keeping them out
GET /api/imbox/recentThe latest threads
GET /api/calendar/agendaToday's events and meeting links
GET /api/notificationsUnread notices
POST /api/notifications/seenMarking notices as seen

Tokens are stored as a SHA-256 hash, so a copy of the database does not give anyone a working token.

If it does not work

  • A dash on the badge: it is not connected. Do the steps under Connect it.
  • An exclamation mark: check the server address, and that the site opens in the browser. A revoked token also shows this. Make a new one.
  • No notices: check the browser allows notices from the extension, and that they are switched on in its settings.