Integration
CLI
Manage inboxes, send email, read messages, and check usage from the command line. Included with the Python SDK.
Installation
The dse CLI is included with the Python SDK. Install it and set your API key:
terminal
pip install deadsimple export DSE_API_KEY=dse_your_api_key
Quick Start
Create an inbox, send an email, and check your messages -- all from the terminal:
terminal
export DSE_API_KEY=dse_your_api_key # Create an inbox dse inboxes create --name "Support Bot" # → Created inbox inb_a1b2c3 (support-bot@yourco.deadsimple.email) # Send an email dse send --inbox inb_a1b2c3 --to user@example.com --subject "Hello" --body "Hi there" # → Message sent (msg_x7y8z9) # List messages dse messages list inb_a1b2c3 # → msg_x7y8z9 2026-03-29 To: user@example.com Subject: Hello
Commands
| Command | Description |
|---|---|
dse inboxes list |
List all inboxes |
dse inboxes create --name "Name" |
Create an inbox |
dse inboxes get <id> |
Get inbox details |
dse inboxes delete <id> |
Delete an inbox |
dse send --inbox <id> --to <email> --subject <s> --body <b> |
Send an email |
dse messages list <inbox_id> |
List messages |
dse messages get <inbox_id> <msg_id> |
Read a message |
dse webhooks list |
List webhooks |
dse webhooks create --url <url> --events <events> |
Create a webhook |
dse usage |
Show account usage |
Inbox Management
Create, list, inspect, and delete inboxes:
terminal
# List all inboxes dse inboxes list # → inb_a1b2c3 support-bot@yourco.deadsimple.email Support Bot # → inb_d4e5f6 sales@yourco.deadsimple.email Sales Agent # Get details for a specific inbox dse inboxes get inb_a1b2c3 # → Inbox ID: inb_a1b2c3 # → Email: support-bot@yourco.deadsimple.email # → Display Name: Support Bot # → Created: 2026-03-29T10:00:00Z # Delete an inbox dse inboxes delete inb_a1b2c3 # → Deleted inbox inb_a1b2c3
Sending Email
Send emails with subject, body, and optional HTML:
terminal
# Simple text email dse send --inbox inb_a1b2c3 \ --to user@example.com \ --subject "Weekly Report" \ --body "Here is your weekly summary." # HTML email dse send --inbox inb_a1b2c3 \ --to user@example.com \ --subject "Welcome" \ --html "<h1>Welcome!</h1><p>Thanks for signing up.</p>" # Multiple recipients dse send --inbox inb_a1b2c3 \ --to user1@example.com,user2@example.com \ --subject "Team Update" \ --body "Meeting at 3pm."
Reading Messages
List and read messages in any inbox:
terminal
# List recent messages dse messages list inb_a1b2c3 # → msg_x7y8z9 2026-03-29 From: user@example.com Subject: Re: Hello # → msg_w1v2u3 2026-03-28 To: user@example.com Subject: Hello # Read full message content dse messages get inb_a1b2c3 msg_x7y8z9 # → From: user@example.com # → To: support-bot@yourco.deadsimple.email # → Subject: Re: Hello # → Date: 2026-03-29T14:30:00Z # → # → Thanks for reaching out! I have a question about...
Webhooks
Register and manage webhook endpoints:
terminal
# Create a webhook for new messages dse webhooks create \ --url https://myapp.com/webhooks/email \ --events message.received,message.sent # List all webhooks dse webhooks list
Usage
Check your current plan usage at a glance:
terminal
dse usage # → Plan: Pro # → Inboxes: 23 / 100 # → Emails sent: 1,247 / 10,000 # → Period: 2026-03-01 to 2026-03-31
Output Formats
All commands support JSON output for scripting and piping:
terminal
# JSON output dse inboxes list --json # Pipe to jq for filtering dse inboxes list --json | jq '.[].email'