CLICommand referencemailalias

mail alias

Commands, arguments, and options for openship mail alias.

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

openship mail alias

Manage forwards and catch-all addresses

openship mail alias [options] [command]
SubcommandPurpose
list [options] <server>List aliases for a domain
create [options] <id> [file]Create a forwarding or catch-all address
update [options] <parent> <id> [file]Enable or disable an alias
remove [options] <server> <alias>Remove an alias by its numeric ID

openship mail alias create

Create a forwarding or catch-all address

openship mail alias 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 alias list

List aliases for a domain

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

openship mail alias remove

Remove an alias by its numeric ID

openship mail alias remove [options] <server> <alias>
OptionMeaning
-y, --yesConfirm removal

openship mail alias update

Enable or disable an alias

openship mail alias 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