تخطَّ إلى المستندات
API

ضبط رد خارج المكتب

احفظ رد عنوان واحد أو catch-all، مستبدلًا كل ما كان محفوظًا.

PUT/out-of-office

ينفّذ الاستدعاء الحقيقي على مساحة عملك.

PUT /out-of-office

احفظ رد عنوان واحد أو catch-all، مستبدلًا كل ما كان محفوظًا.

مثال

يتطلب settings:write. يوضع address في الاستعلام، وmessage هو الحقل الإلزامي الوحيد: نص عادي من 1 إلى 10,000 حرف.

curl
curl -X PUT "$OE/[email protected]" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "startsAt": "2026-12-22T00:00:00Z",    "endsAt": "2027-01-04T08:00:00Z",    "subject": "Away until 4 January",    "message": "I am away until 4 January and will answer when I am back."  }'
الاستجابة
{  "object": "out_of_office",  "address": "[email protected]",  "enabled": true,  "active": true,  "startsAt": "2026-12-22T00:00:00.000Z",  "endsAt": "2027-01-04T08:00:00.000Z",  "subject": "Away until 4 January",  "message": "I am away until 4 January and will answer when I am back.",  "contactsOnly": false,  "updatedAt": "2026-12-22T09:14:03.117Z"}

أغفِل startsAt للبدء الآن، أو للإبقاء على بداية رد مفعَّل بالفعل، وأغفِل endsAt أو اجعله null لإبقاء الرد مفعَّلًا حتى يُوقَف. ويقبل subject 255 حرفًا على الأكثر، وإذا تُرك فارغًا أجاب الرد بـ Re: والموضوع المستلَم. وenabled: false يحتفظ بالنص ويوقف الرد مؤقتًا، وcontactsOnly: true لا يجيب إلا جهات الاتصال والأشخاص الذين راسلتهم مساحة العمل.

يحصل كل مرسِل على الرد مرة واحدة طوال فترة الغياب، داخل المحادثة نفسها، من العنوان الذي وصل إليه البريد. وتغيير startsAt يبدأ فترة جديدة يُجاب فيها الجميع مرة أخرى، أما تغيير النص أو endsAt وحده فلا يبدؤها. ومن دون endsAt يُجاب المرسِل من جديد بعد 30 يومًا. ويحمل الرد Auto-Submitted: auto-replied، بلا تتبّع ولا توقيع، ويُحتسب ضمن الإرسالات الشهرية، ويخرج مع ذلك في محادثة مكتومة.

البريد الذي ما كان لينبّه أحدًا لا يحصل على رد: البريد المزعج، والبريد الذي نقلته قاعدة إلى سلة المحذوفات، والنشرات البريدية وغيرها من البريد الجماعي، والبريد التلقائي، والارتدادات، والمرسِلون المحظورون، وعناوين مساحة العمل نفسها. ويُطبَّق أولًا الرد المحفوظ للعنوان نفسه بالضبط، ثم رد العنوان من دون وسم الزائد، ثم رد catch-all، ولا يجيب catch-all أبدًا عن عنوان أنشأه أحد يدويًا.

422 invalid_parameter يعني أن address مفقود، أو ليس عنوانًا في مساحة العمل، أو يسمّي نطاقًا كاملًا، أو أن الرسالة فارغة، أو أن endsAt ليس بعد startsAt أو قد مضى بالفعل. ولا شيء يعمل بمؤقِّت: تُفحص التواريخ عند وصول البريد.

المرجع