Skip to main content
The Paubox CLI is a command-line tool for the Paubox Email API and Paubox Forms. Use it to send and schedule encrypted email, check delivery status, manage inbound email and webhooks, work with forms, and manage configuration directly from your terminal or shell scripts, with no HTTP client required.

What you can do

  • Send encrypted, HIPAA compliant email with a single command
  • Schedule, reschedule, and cancel email for future delivery
  • Check delivery and open status for any sent message
  • Manage receiving domains and mailboxes, and read inbound email and attachments
  • Manage Email API webhook endpoints
  • Retrieve and submit Paubox Forms responses from the terminal
  • Manage Paubox Forms, export submissions, and subscribe to Forms webhooks with a Forms API key
  • Store API credentials securely in the OS keychain
  • Use --json output for scripting and automation
  • Set a default sender address so you don’t repeat --from on every send

Requirements

  • Node.js ≥ 20.12.0: download at nodejs.org
  • Linux only: libsecret-1-dev is required for OS keychain support. Without it, credentials fall back to ~/.config/paubox/config.json with 0600 permissions.

Get started

Quickstart

Install, authenticate, and send your first email in under five minutes.

Installation

Full install guide for macOS, Windows, and Linux.

Authentication

Store and manage API credentials with the CLI.

Commands

Full reference for every command and flag.

Community & support

Q&A

Ask usage questions in the Paubox Community.

Ideas

Propose features and improvements.
Never post PHI, recipient addresses, or message content in public threads. Account, billing, or anything sensitive goes to support@paubox.com.