mail domain

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

openship mail domain

Manage mail domains, their dependencies and DNS

openship mail domain [options] [command]

Subcommand	Purpose
`list <server>`	List configured mail domains
`create [options] <id> [file]`	Create a domain; inspect any returned DNS warning
`update [options] <parent> <id> [file]`	Update domain capacity and enabled state
`get <server> <domain>`	Read a mail domain
`dependents <server> <domain>`	Count affected mailboxes and aliases before deletion
`dns <server> <domain>`	Read required records and their acknowledgment
`dns-plan <server> <domain>`	Preview DNS changes without writing records
`dns-apply [options] <server> <domain>`	Apply the domain's DNS records using its connected provider
`dns-ack [options] <server> <domain>`	Confirm that you have published the required records
`pending-dns <server>`	List domains still needing DNS configuration
`remove [options] <server> <domain>`	Delete a domain; --cascade also deletes dependent accounts

Create a domain; inspect any returned DNS warning

openship mail domain create [options] <id> [file]

Argument	Meaning
`id`	Resource ID
`file`	JSON input file, or - for stdin

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request

Count affected mailboxes and aliases before deletion

openship mail domain dependents [options] <server> <domain>

Read required records and their acknowledgment

openship mail domain dns [options] <server> <domain>

Confirm that you have published the required records

openship mail domain dns-ack [options] <server> <domain>

Option	Meaning
`-y, --yes`	Confirm DNS operation

Apply the domain's DNS records using its connected provider

openship mail domain dns-apply [options] <server> <domain>

Option	Meaning
`-y, --yes`	Confirm DNS operation

Preview DNS changes without writing records

openship mail domain dns-plan [options] <server> <domain>

Read a mail domain

openship mail domain get [options] <server> <domain>

List configured mail domains

openship mail domain list [options] <server>

List domains still needing DNS configuration

openship mail domain pending-dns [options] <server>

Delete a domain; --cascade also deletes dependent accounts

openship mail domain remove [options] <server> <domain>

Option	Meaning
`--cascade`	Also remove dependent mailboxes and aliases
`-y, --yes`	Confirm deletion

Update domain capacity and enabled state

openship mail domain update [options] <parent> <id> [file]

Option	Meaning
`--schema`	Print the accepted JSON schema without making a request