Skip to content

Receiving Email

Agent mailboxes accept inbound email from any sender on the internet. Messages are delivered to the mailbox and can be retrieved via the CLI, any IMAP client, or the REST API (coming soon).

When someone sends an email to a Broodnet mailbox address:

  1. The message arrives at the Broodnet mail server via standard SMTP
  2. The server routes it to the correct mailbox based on the address
  3. The message is stored and becomes available for retrieval
  4. An audit event is recorded (sender address, subject, timestamp)

No configuration is needed — inbound delivery works from the moment a mailbox reaches synced status. Any email address on the internet can send to a Broodnet mailbox.

Terminal window
broodnet mail inbox

This shows a summary table of recent messages with UID, flags, sender, subject, and date.

OptionDefaultDescription
--limit20Messages per page
--offset0Pagination offset
--sortnewestSort order: newest or oldest
--unreadShow only unread messages
--readShow only read messages
--importantShow only flagged messages
--answeredShow only replied-to messages
--jsonOutput as JSON
Terminal window
broodnet mail open <uid>

Opens a message by its UID (shown in the inbox listing). Displays the full message — headers, subject, and body. Opening a message marks it as read.

OptionDescription
--rawPrint the raw RFC 822 source instead of formatted output
--jsonOutput structured JSON (headers, body, flags, attachments)
Terminal window
broodnet mail watch

A convenience command designed for OTP and verification code workflows. It checks the inbox for a message that arrived within the last 60 seconds. If none is found, it polls every 3 seconds for up to 60 seconds, then opens the first new message that arrives.

Any standard IMAP client can connect to a Broodnet mailbox. Use the connection details from the CLI or the connect endpoint:

  • Host: your Broodnet IMAP server
  • Port: 993 (IMAPS / TLS)
  • Username: the mailbox email address
  • Password: the mailbox token

This means tools like mutt, neomutt, or any email client can read a Broodnet mailbox. See the CLI alternatives guide for setup examples.

Messages support standard IMAP flags:

FlagMeaningCLI display
SeenMessage has been read○ (unread) / ● (read)
AnsweredMessage has been replied to
FlaggedMessage marked as important
ForwardedMessage has been forwarded

Check storage usage and message counts:

Terminal window
broodnet mail status

Shows the mailbox address, quota usage, total message count, and whether IMAP/SMTP access is active. Use --sync to refresh the data from the mail server.

Push-based notification for new messages via webhooks is on the roadmap but not yet available. Currently, the recommended approach is polling via the CLI watch command or IMAP IDLE for real-time notification.