Docs
Powered by

Getting Started

Pick the path that matches what you want to do.

Choose Your Path

Use Nmail, the reference client, or build your own app with an SDK.

Nmail | SDKs

Deploy a bridge to connect legacy email with Nostr.

Bridge Setup

Read the protocol specification to learn how it works.

Protocol

For End Users

Open Nmail

  1. Open the web app, or install it from ZapStore or the releases page.

  2. Generate a key, or sign in with a signer you already use.

  3. Back up your key, then start writing.

Your address is <npub>@nostr out of the box. A readable address like alice@example.com comes from a NIP-05 provider, and is also what lets people on ordinary email reach you.

For Developers

Dart and Flutter

dart pub add nostr_mail
final client = await NostrMailClient.create(
  ndk: ndk,
  database: database,
  db: db,
  blossomCache: blossomCache,
  syncEngine: syncEngine,
);

await client.send(
  to: [NostrRecipient.fromPubkey(bobPubkey)],
  subject: 'Hello from Nostr!',
  body: 'This email was sent over the Nostr protocol.',
);

client.onEmail.listen((email) {
  print('New email: ${email.mime.decodeSubject()}');
});

Full SDK documentation

JavaScript and TypeScript

npm install nostr-mail
const client = new NostrMailClient(secretKey);

await client.sendEmail({
  to: 'npub1...',
  subject: 'Hello from Nostr',
  text: 'Hey! This is a private email sent over Nostr.',
});

JavaScript SDK

For Bridge Operators

Prerequisites

  • A server with Docker, or Node.js and Dart
  • A domain with MX records configured
  • A Nostr private key for the bridge

Quick Start with Docker

git clone https://github.com/nogringo/nostr-mail-bridge
cd nostr-mail-bridge
cp .env.example .env
# Edit .env with your configuration
docker compose up -d

Full bridge setup

Email Address Formats

Format Example Best For
NIP-05 alice@example.com Human-readable, reachable from legacy email
npub@domain npub1...@bridge.com Sovereign identity with legacy compatibility
npub@nostr npub1...@nostr Nostr-to-Nostr communication

Next Steps