CLICommand referencemailinbound
mail inbound
Commands, arguments, and options for openship mail inbound.
See the workflow guide for examples. Global flags such as --json go before the command; see global options.
openship mail inbound
Manage inbound-mail notification rules
openship mail inbound [options] [command]| Subcommand | Purpose |
|---|---|
list <server> | List rules and paused state |
create [options] <id> [file] | Create a rule for existing notification channels |
update [options] <parent> <id> [file] | Update a rule; pausedReason=null explicitly clears its pause |
remove [options] <server> <rule> | Remove a rule and release unneeded capture |
test <server> | Preview matches without sending notifications or deleting captured mail |
openship mail inbound create
Create a rule for existing notification channels
openship mail inbound 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 |
openship mail inbound list
List rules and paused state
openship mail inbound list [options] <server>openship mail inbound remove
Remove a rule and release unneeded capture
openship mail inbound remove [options] <server> <rule>| Option | Meaning |
|---|---|
-y, --yes | Confirm removal |
openship mail inbound test
Preview matches without sending notifications or deleting captured mail
openship mail inbound test [options] <server>openship mail inbound update
Update a rule; pausedReason=null explicitly clears its pause
openship mail inbound update [options] <parent> <id> [file]| Argument | Meaning |
|---|---|
parent | Parent resource ID |
id | Resource ID or name |
file | JSON input file, or - for stdin |
| Option | Meaning |
|---|---|
--schema | Print the accepted JSON schema without making a request |