مرجع API
التصنيفات وقواعد الفرز
نظّم البريد المرسل والمستلَم في مجلدات تلقائيًا أو يدويًا.
لا توجد عمليات تطابق عامل التصفية هذا.
/emails/:id/labelsإضافة تصنيفات إلى رسالة أو إزالتها منها
أضف التصنيفات وأزلها بالاسم أو بمعرّف lbl_. تُنشأ الأسماء غير المعروفة في `add` ما لم تكن `create` مساوية لـ false. يمكن أن تحمل الرسالة 10 تصنيفات على الأكثر.
curl https://sendhq.cc/api/v1/emails/id_value/labels \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"add":["Billing"],"remove":["Support"]}'{
"id": "em_…",
"labels": [
{
"id": "lbl_…",
"name": "Billing",
"color": "#188038"
}
]
}/labelsعرض التصنيفات مع أعداد الرسائل وقواعد الفرز
عرض التصنيفات مع أعداد الرسائل وقواعد الفرز
curl https://sendhq.cc/api/v1/labels \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0,
"mailbox": {
"inboxUnread": 0,
"updatesUnread": 0,
"spamTotal": 0,
"importantUnread": 0,
"resortPending": 0
}
}/labelsإنشاء تصنيف، مع قواعد فرز تلقائي اختيارية
أنشئ تصنيفًا على هيئة مجلد. اضبط `skip_inbox: true` لتحويله إلى مجموعة: يُؤرشَف البريد المستلَم الذي يحصل على هذا التصنيف (من قاعدة، أو من ردّ على محادثة أُرسلت بهذا التصنيف، أو بإضافته يدويًا) فيظهر داخل التصنيف فقط ولا يظهر أبدًا في صندوق الوارد. تفرز `rules` الاختيارية البريد المرسل أو المستلَم الجديد تلقائيًا: يجب أن تتحقق كل الشروط المضبوطة في القاعدة (inbox_id وdirection، ومقاطع نصية من from/to/subject دون مراعاة حالة الأحرف). اضبط `apply_to_existing` لفرز البريد المحفوظ أيضًا.
curl https://sendhq.cc/api/v1/labels \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Agent/Orders","color":"#188038","skip_inbox":true,"rules":[{"inbox_id":"inb_…"}],"apply_to_existing":true}'{
"id": "lbl_…",
"name": "Agent/Orders",
"color": "#188038",
"skipInbox": true,
"totalCount": 0,
"unreadCount": 0,
"rules": []
}/labels/:idاسترجاع تصنيف بمعرّفه أو اسمه
استرجاع تصنيف بمعرّفه أو اسمه
curl https://sendhq.cc/api/v1/labels/id_value \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"id": "lbl_…",
"name": "Billing",
"color": "#188038",
"skipInbox": false,
"totalCount": 0,
"unreadCount": 0,
"rules": []
}/labels/:idإعادة تسمية تصنيف أو تغيير لونه أو تحويله إلى مجموعة
غيّر `name` أو `color` أو `skip_inbox`. يؤدي تفعيل `skip_inbox` أيضًا إلى أرشفة البريد المستلَم الموجود أصلًا في التصنيف ما لم تكن `apply_to_existing` مساوية لـ false.
curl https://sendhq.cc/api/v1/labels/id_value \
-X PATCH \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Finance/Billing","color":"#1a73e8","skip_inbox":true}'{
"id": "lbl_…",
"name": "Finance/Billing",
"color": "#1a73e8",
"skipInbox": true
}/labels/:idحذف تصنيف دون حذف رسائله
حذف تصنيف دون حذف رسائله
curl https://sendhq.cc/api/v1/labels/id_value \
-X DELETE \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"ok": true
}/labels/:id/rulesإضافة قاعدة فرز تلقائي إلى تصنيف
إضافة قاعدة فرز تلقائي إلى تصنيف
curl https://sendhq.cc/api/v1/labels/id_value/rules \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"direction":"in","from":"@stripe.com","subject":"invoice","skip_inbox":true,"apply_to_existing":false}'{
"id": "lrule_…",
"labelId": "lbl_…",
"direction": "in",
"inboxId": null,
"from": "@stripe.com",
"to": null,
"subject": "invoice",
"skipInbox": true
}/labels/:id/rules/:rule_idحذف قاعدة فرز تلقائي
حذف قاعدة فرز تلقائي
curl https://sendhq.cc/api/v1/labels/id_value/rules/rule_id_value \
-X DELETE \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"ok": true
}