CLICommand referencemailmailbox

mail mailbox

Commands, arguments, and options for openship mail mailbox.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship mail mailbox

Manage mailbox accounts and storage limits

openship mail mailbox [options] [command]
SubcommandPurpose
list [options] <server>List mailboxes for a domain without passwords
get <server> <email>Read mailbox configuration
create [options] <id> [file]Create an account; read its password from JSON file or stdin
update [options] <parent> <id> [file]Update a mailbox; omit password to preserve it
remove [options] <server> <email>Remove an account; retain stored mail unless --hard is supplied

openship mail mailbox create

Create an account; read its password from JSON file or stdin

openship mail mailbox create [options] <id> [file]
ArgumentMeaning
idResource ID
fileJSON input file, or - for stdin
OptionMeaning
--schemaPrint the accepted JSON schema without making a request

openship mail mailbox get

Read mailbox configuration

openship mail mailbox get [options] <server> <email>

openship mail mailbox list

List mailboxes for a domain without passwords

openship mail mailbox list [options] <server>
OptionMeaning
--domain <domain>Mail domain

openship mail mailbox remove

Remove an account; retain stored mail unless --hard is supplied

openship mail mailbox remove [options] <server> <email>
OptionMeaning
--hardPermanently delete stored mail too
-y, --yesConfirm removal

openship mail mailbox update

Update a mailbox; omit password to preserve it

openship mail mailbox update [options] <parent> <id> [file]
ArgumentMeaning
parentParent resource ID
idResource ID or name
fileJSON input file, or - for stdin
OptionMeaning
--schemaPrint the accepted JSON schema without making a request

On this page