molted rules

Command	Description
`molted rules list`	List rules for a mailbox
`molted rules create`	Create a mailbox rule
`molted rules get`	Get a rule by ID
`molted rules update`	Update a rule
`molted rules delete`	Delete a rule
`molted rules reorder`	Reorder rules for a mailbox

Agent context

Mailbox rules automatically label inbound emails or archive them based on conditions like sender domain, sender email, or subject keywords.

Rules run once per thread, on the inbound message that starts a new thread; later messages on that thread are not evaluated. They run in position order. When a rule matches and stop_processing is true (the default: the server stores true unless --no-stop-processing is passed), no further rules are evaluated.

Create a rule to label emails from a domain

molted rules create --mailbox <mbxId> --name "Acme to Sales" \
  --condition-type sender_domain --condition-operator equals \
  --condition-value acme.com --action-type apply_label \
  --action-value <labelId>

Auto-archive newsletters

molted rules create --mailbox <mbxId> --name "Archive newsletters" \
  --condition-type subject --condition-operator contains \
  --condition-value "newsletter" --action-type auto_archive

List and reorder rules

molted rules list --mailbox <mbxId>
molted rules reorder --mailbox <mbxId> --rule-ids id1,id2,id3

Condition types: sender_domain, sender_email, subject
Operators: equals, contains, ends_with, matches_pattern (all case-insensitive; matches_pattern is a SQL LIKE pattern over the whole value: % matches any run of characters, _ matches one character)
Action types: apply_label (requires --action-value <labelId>, a label of the rule's mailbox; see molted labels), move_to_folder (its old name), auto_archive

Commands

molted rules list

List rules for a mailbox

molted rules list [options]

Option	Description	Default
`--mailbox <id>`	Mailbox ID (required) (required)

molted rules create

Create a mailbox rule

molted rules create [options]

Option	Description	Default
`--mailbox <id>`	Mailbox ID (required) (required)
`--name <name>`	Rule name (required) (required)
`--condition-type <type>`	Condition type (required; one of: sender_domain, sender_email, subject)
`--condition-operator <op>`	Operator (required; one of: equals, contains, ends_with, matches_pattern)
`--condition-value <val>`	Value to match (required) (required)
`--action-type <type>`	Action type (required; one of: apply_label, move_to_folder, auto_archive)
`--action-value <val>`	Action value (label ID for apply_label / move_to_folder)
`--position <n>`	Position in rule order	`0`
`--stop-processing`	Stop processing after match (the default when neither flag is passed)
`--no-stop-processing`	Continue processing after match

molted rules get

Get a rule by ID

molted rules get <id>

Argument	Description	Required
`<id>`		yes

molted rules update

Update a rule

molted rules update [options] <id>

Argument	Description	Required
`<id>`		yes

Option	Description	Default
`--name <name>`	Rule name
`--condition-type <type>`	Condition type (one of: sender_domain, sender_email, subject)
`--condition-operator <op>`	Condition operator (one of: equals, contains, ends_with, matches_pattern)
`--condition-value <val>`	Condition value
`--action-type <type>`	Action type (one of: apply_label, move_to_folder, auto_archive)
`--action-value <val>`	Action value
`--enabled`	Enable the rule
`--no-enabled`	Disable the rule
`--position <n>`	Position
`--stop-processing`	Stop processing after match
`--no-stop-processing`	Continue processing after match

molted rules delete

Delete a rule

molted rules delete <id>

Argument	Description	Required
`<id>`		yes

molted rules reorder

Reorder rules for a mailbox

molted rules reorder [options]

Option	Description	Default
`--mailbox <id>`	Mailbox ID (required) (required)
`--rule-ids <ids>`	Comma-separated rule IDs in desired order (required) (required)

See CLI overview for global options, credentials and output format.

On this page