@ownmail/app
v0.15.5
Published
The customizable OwnMail web app for mail, calendar, and contacts
Readme
@ownmail/app
The ready-to-use mail, calendar, and contacts web app behind
OwnMail. OwnMail creates an email
address on a domain you control—or a Nylas-provided nylas.email trial
subdomain—then deploys this app to your Cloudflare, Vercel, or Netlify account,
or runs it on a local Node server. Nylas hosts the mailbox service through
Agent Accounts.
This is the customizable half of OwnMail: a complete app codebase for developers who want their inbox to look, behave, and deploy their way.

Most people should start with the CLI:
npx ownmailThe CLI provisions the required Nylas resources, configures the chosen runtime, then deploys or starts this app. Reach for this package directly when you want to develop, customize, or host an ejected OwnMail app yourself.
Cloudflare uses its bound KV namespace for sessions and realtime counters.
Guided Vercel deployments use an Upstash Redis resource connected through the
Vercel Marketplace. Other Node deployments remain stateless unless both
UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN are configured. Shared
storage is required for sliding sessions: with it, the 14-day session window
moves forward on activity; without it there is no server-side record a sign-out
could revoke, so the window stays fixed from the last sign-in.
Sign-in uses @nylas/connect to start the authorization flow. OwnMail exchanges
the callback code and stores the verified grant in its server-owned session, so
API credentials and bearer tokens are never persisted in browser storage.
Start simple, then take control
ownmail app eject ./my-ownmail
cd my-ownmail
pnpm install
pnpm devThat starts the ejected project's own development server. Configure the
environment values in .env.example before exercising the real Nylas flow.
The repository-only mock UI is available from the repository root below.
Documentation
Local development
From the repository root, start the UI with local mock data:
pnpm --filter @ownmail/app dev:uiFor a real Nylas integration, configure the environment variables documented in the quickstart and run:
pnpm --filter @ownmail/app dev:localDo not commit credentials or deployment secrets. Production secrets belong in your hosting provider's secret manager.
