Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Update a mailbox

See Mailboxes for what a mailbox is and the settings it holds. This page covers the sithbit mailbox update command.

sithbit mailbox update \
  [--keypair <keypair>] \
  [--default-postage <lamports>] \
  [--domain <name or address>] \
  [--no-ipfs <true|false>] \
  [--skip-preflight]

All of --default-postage, --domain, and --no-ipfs are optional — only the ones you supply are changed. For example, raising the default postage to price out a recent wave of spam:

sithbit mailbox update --default-postage 2000000000

…or moving to a different domain:

sithbit mailbox update --domain sithbit.net

The new domain must already be registered on-chain and active — updating a mailbox to reference an unregistered or deactivated domain is refused.

…or toggling the IPFS opt-out: --no-ipfs true opts out (your operator keeps bodies in its own store, off public IPFS), and --no-ipfs false clears it so new mail is pinned to IPFS again. Omitting the flag leaves the current setting untouched. The change applies to mail delivered after it lands — bodies already pinned stay where they are.

sithbit mailbox update --no-ipfs true

Arguments

  • --keypair <path> (optional) — the mailbox owner’s keypair. Defaults to the keypair in your Solana CLI config when omitted.
  • --default-postage <lamports> (optional) — the new default postage for the mailbox, in lamports. Omitted leaves the stored value unchanged.
  • --domain <name or address> (optional) — the domain that can send mail to this mailbox, by name (e.g. sithbit.net) or by its account address. Omitted leaves the stored domain unchanged.
  • --no-ipfs <true|false> (optional) — true opts the mailbox out of public IPFS body storage, false clears the opt-out. Omitted leaves the stored flag unchanged. See Opting out of IPFS storage.
  • --skip-preflight (optional) — submits the transaction without a local simulation pass first.

Examples

Raise the default postage to price out a recent wave of spam:

sithbit mailbox update --default-postage 2000000000

Move to a different domain:

sithbit mailbox update --domain sithbit.net

Opt a mailbox out of public IPFS storage, then opt back in later:

sithbit mailbox update --no-ipfs true
sithbit mailbox update --no-ipfs false

When a mailbox is no longer needed, see Closing accounts for mailbox close and mailbox key close.