get_sieve

get_sieve

The get_sieve call retrieves all sieve rulesets for the user.

Note that multipule rulesets can be defined but only one ruleset is active at any given time. The default active sieve ruleset name is "managesieve".

Syntax

Request

{
    <credentials object>,
    "user": <mailbox_name>
}

Response

{
	"rulesets": {
		"managesieve": "require [\"fileinto\"];\nif header :contains \"from\" \"@\"\n{\n\tkeep;\n}\n",
		"someruleset": "/* empty ___ script */\n",
		"schoolset": "require [\"fileinto\"];\nif header :contains \"from\" \"[email protected]"\n{\n\tfileinto \"school\";\n\tstop;\n}\nif header :contains [\"to\",\"cc\"] \"[email protected]\"\n{\n\tfileinto \"school\";\n\tstop;\n}\n}\n"
	},
	"active_rule": "managesieve",
	"success": true,
	"audit": "owl84_617842a312"
}

Here, the user has 3 sieve rulesets, but only the one named "managesieve" is active.