Skip to content

Inbox Commands

Inbox commands let you create temporary email addresses, list existing inboxes, and manage their lifecycle.

All inbox commands support these global flags:

FlagDescription
--configConfig file (default is $HOME/.config/vsb/config.yaml)
-o, --outputOutput format: pretty, json

Create a new temporary inbox with an auto-generated email address.

Terminal window
vsb inbox create [flags]
FlagDescriptionDefault
--ttlTime-to-live duration (e.g., 1h, 24h, 7d)24h
Terminal window
# Create inbox with default 24h TTL
vsb inbox create
# Create inbox with custom TTL
vsb inbox create --ttl 1h
vsb inbox create --ttl 7d
# Create inbox and output JSON (useful for scripting)
vsb inbox create -o json
Inbox Ready!
Expires: 24h
Run 'vsb' to see emails arrive live.

JSON output:

{
"email": "[email protected]",
"expiresAt": "2024-01-16T14:30:00Z",
"createdAt": "2024-01-15T14:30:00Z"
}

List all stored inboxes.

Terminal window
vsb inbox list [flags]
vsb inbox ls [flags]
FlagDescription
-a, --allInclude expired inboxes
Terminal window
# List active inboxes
vsb inbox list
vsb inbox ls
# Include expired inboxes
vsb inbox list -a
# Output as JSON
vsb inbox list -o json
EMAIL EXPIRES

The > marker indicates the active inbox. Expired inboxes are shown with dimmed styling.

JSON output:

[
{
"email": "[email protected]",
"expiresAt": "2024-01-16T14:30:00Z",
"isActive": true,
"isExpired": false
}
]

Show detailed information about an inbox.

Terminal window
vsb inbox info [email]

If no email is specified, shows info for the active inbox.

ArgumentDescription
emailEmail address (optional, uses active inbox if omitted)
Terminal window
# Show info for active inbox
vsb inbox info
# Show info for specific inbox
vsb inbox info [email protected]
# Partial matching works
vsb inbox info abc123
# JSON output
vsb inbox info -o json
ID: abc123
Created: 2024-01-15 14:30
Expires: 2024-01-16 14:30 (14h)
Emails: 3

JSON output:

{
"email": "[email protected]",
"expiresAt": "2024-01-16T14:30:00Z",
"isActive": true,
"isExpired": false,
"id": "abc123",
"createdAt": "2024-01-15T14:30:00Z",
"emailCount": 3,
"syncError": "error message"
}

Note: syncError is only included when the server sync fails.


Set the active inbox for subsequent commands.

Terminal window
vsb inbox use <email>
ArgumentDescription
emailEmail address or partial match
Terminal window
# Set active inbox by full address
vsb inbox use [email protected]
# Partial matching
vsb inbox use abc123
vsb inbox use abc
# Now commands use this inbox by default
vsb email list

Delete an inbox and all its emails.

Terminal window
vsb inbox delete <email> [flags]
vsb inbox rm <email> [flags]
ArgumentDescription
emailEmail address or partial match
FlagDescription
-l, --localOnly remove from local keystore (don’t delete on server)
Terminal window
# Delete inbox
vsb inbox delete [email protected]
vsb inbox rm abc123
# Remove from local keystore only
vsb inbox delete abc123 --local
vsb inbox delete abc123 -l