Introduction

One API for Gmail and IMAP mailboxes.

PigeonPost lets your application work with your users’ mailboxes through a single REST API, whatever their email provider. Your users connect a mailbox once; the engine keeps it in sync and tells your app about new mail through webhooks.

How can PigeonPost help?

Skip building email integrations yourself. With a few API calls, you can add to your app:

• Conversation history with a contact: every email exchanged with a person, across Gmail and IMAP mailboxes.
• New email notifications: webhooks tell your app about new and sent emails in real time.
• Sending and replying: send from your user’s own address, reply in the same thread, save drafts.
• Open and click tracking: know when a sent email is opened or a link is clicked.
• Contacts: the people each mailbox has emailed with.

To try it, follow the Quickstart.

What you can do

Connect mailboxes

Gmail, Yahoo, iCloud and every other provider through IMAP, with an email address and password, from your app or the dashboard.

Read and search email

List, filter and page through synced emails, folders, threads and contacts.

Send and reply

Send from the user’s own address, reply in the same thread, save drafts, attach files.

Get webhooks

Signed, retried events for new mail, changes, folders, opens, clicks and account status.

Supported providers

Provider	How users connect	New mail arrives
Gmail and Google Workspace	Address + app password (IMAP), from your app or the dashboard	Within seconds in the Inbox (IMAP IDLE)
Other IMAP / SMTP (Yahoo, iCloud, AOL, Zoho, GMX, Fastmail, company servers, on-premises Exchange with IMAP…)	Address + password; servers filled in for well-known providers	Within seconds in the Inbox (IMAP IDLE)

Microsoft 365 and Outlook.com aren’t supported yet.

How it works

1. Your user enters their email address and password (an app password for Gmail) in your app. Your app sends them to the engine with POST /api/v1/auth/intent. The engine signs in to the mailbox before saving it.
2. The engine stores the connection as an account (acc_…) and syncs the mailbox: every new email and change from that moment on.
3. Your app reads emails through the API, sends and replies on the user’s behalf, and receives webhooks when something changes.

Each workspace runs on its own server, with its own database: your mailboxes and emails are never stored with another customer’s. Sign up, then manage access tokens, accounts and webhooks in your workspace’s dashboard.

Next steps

Quickstart

Connect a mailbox and receive your first webhook in about 10 minutes.

API reference

Every endpoint, parameter and response.