ドキュメント本文へスキップ
API

ルールを並べ替える

順序全体を 1 回の呼び出しで指定します。ルールの一覧は、順序があって初めて意味を持つからです。

POSTapi.openemail.uk/rules/reorder

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

POST /rules/reorder

順序全体を 1 回の呼び出しで指定します。ルールの一覧は、順序があって初めて意味を持つからです。

rules:write が必要です。ボディには、接続上の「すべての」ルールを、評価してほしい順序で並べます。新しい順序の一覧全体を返します。

curl
curl -X POST "$OE/rules/reorder" -H "$AUTH" -H "Content-Type: application/json" \  -d '{ "ruleIds": ["rul_7f3a1c94…", "rul_2b81de07…", "rul_c40a95f2…"] }'
レスポンス
{  "object": "list",  "data": [    { "object": "rule", "id": "rul_7f3a1c94…", "name": "Receipts to their own label", "position": 0 },    { "object": "rule", "id": "rul_2b81de07…", "name": "Newsletters after hours", "position": 1 },    { "object": "rule", "id": "rul_c40a95f2…", "name": "Anything from the old domain", "position": 2 }  ],  "hasMore": false,  "nextCursor": null}

部分的な一覧は incomplete_order、422 になり、何も動きません。受け入れてしまうと、省かれたルールの位置をこちらで発明することになり、それらが指定されたルールに対してどこに入るかは、あなたの指示ではなくあなたのメールボックスについての当て推量になります。

構造上冪等です。ボディが順序全体を指定するので、2 回送っても同じ結果に落ち着きます。再試行しても安全で、現在の順序を知らないスクリプトから実行しても安全です。

すべての位置が 1 つのトランザクション内の 1 つのステートメントで書き換えられるので、2 つのルールが同じ位置を共有する瞬間も、一覧が中途半端に振り直された瞬間もありません。

順序は見た目の問題ではありません。一致した 2 つのルールのどちらがメッセージの入るフォルダーを決めるか、そして stopProcessing のルールがどこで一覧を打ち切るかを決めます。