השעיית כניסה לתיבת דואר באמצעות API
חסמו את כניסת הבעלים בלי לעצור את קבלת הדואר, בעזרת קריאת REST אחת או כלי MCP לתיבה אחת, לדומיין שלם או לכל התיבות בחשבון.
פרטי המאמר
סוג, רמת קושי, תוכניות ומידע על עדכון אחרון.
▼
פרטי המאמר
סוג, רמת קושי, תוכניות ומידע על עדכון אחרון.
- סוג
- חומר עזר
- רמת קושי
- בינוני
- תוכניות
- Pro · Agency
- עודכן לאחרונה
- 10 בספט׳ 2026
השעיית הכניסה מונעת מאדם להיכנס לתיבת דואר, אך התיבה עצמה ממשיכה לעבוד. הדואר נמסר כרגיל וממתין למשתמש; דבר אינו מוחזר לשולח או אובד. דף זה הוא מדריך העזר לפקודות שמגדירות אפשרות זו.
אותה בקרה נמצאת בלוח הבקרה תחת תיבות דואר ← (תיבת דואר) ← מגבלות. היא זמינה בכל תוכנית ואינה כרוכה בתשלום נוסף.
השעיית כניסה והשהיית תיבה הן קריאות שונות
:suspend-login |
:pause |
|
|---|---|---|
| כניסה, שליחה והפעלות | נעצרות | נעצרות |
| דואר נכנס | נמסר כרגיל | נדחה ומוחזר לשולחים |
| אפשר לבטל | :resume-login |
:resume |
| נספר במסגרת התוכנית | כן | כן |
השתמשו ב-:suspend-login עבור לקוח שלא שילם, אדם שנמצא בין חוזים או כל משתמש שעדיין תרצו לקבל עבורו דואר. השתמשו ב-:pause כאשר תיבת הדואר צריכה להפסיק לפעול לחלוטין, כולל קבלת דואר משולחים.
קיים מצב שלישי שאף אחת מהקריאות אינה מגדירה. אם פעילות יוצאת מרמזת שנעשה שימוש לרעה בסיסמה של תיבת דואר, TrekMail יכולה לעצור את השליחה מאותה תיבה ולהשאיר את הכניסה והמסירה ללא שינוי. ניסיונות שליחה יחזירו אז 403 mailbox_sending_paused. לא :resume ולא :resume-login מסירות את המצב הזה, וגם חזרה על הקריאה לא תעזור: צריך לשנות את הסיסמה, ולאחר מכן התמיכה מפעילה שוב את השליחה. ראו למה אי אפשר לשלוח דואר אלקטרוני?.
היקף ההרשאה הנדרש
mailboxes:write, אותו היקף הרשאה שמאפשר לעדכן כל שדה אחר בתיבת הדואר. כל ה-endpoints שלהלן מקבלים כותרת Idempotency-Key.
תיבת דואר אחת
curl -s -X POST "https://trekmail.net/api/v1/mailboxes/{MAILBOX_ID}:suspend-login" \
-H "Authorization: Bearer tm_live_your_token" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: suspend-{MAILBOX_ID}-invoice-42" \
-d '{"reason":"Unpaid invoice 42"}'
{ "status": "login_suspended", "message": "Sign-in has been suspended. The mailbox keeps receiving mail." }
השדה reason הוא אופציונלי ומוגבל ל-255 תווים. הוא מוצג לכם בלוח הבקרה ומוחזר על ידי ה-API; המשתמש שכניסתו הושעתה לעולם אינו רואה אותו.
כדי להסיר את ההשעיה:
curl -s -X POST "https://trekmail.net/api/v1/mailboxes/{MAILBOX_ID}:resume-login" \
-H "Authorization: Bearer tm_live_your_token" \
-H "Idempotency-Key: resume-{MAILBOX_ID}"
קריאת המצב
גם GET /api/v1/mailboxes/{id} וגם endpoint הרשימה כוללים את המצב, כך שאפשר לבצע ביקורת בלי לשנות דבר:
{ "data": { "id": 1701, "email": "sam@example.com", "status": "active",
"login_suspended": true,
"login_suspended_at": "2026-08-16T14:02:11+00:00",
"login_suspended_reason": "Unpaid invoice 42", "...": "..." } }
שימו לב שהערך של status נשאר active. זו אינה שגיאה שצריך לעקוף: התיבה פעילה ומקבלת דואר. קראו את login_suspended כדי לבדוק את הכניסה, ואת status כדי לדעת אם התיבה עצמה פועלת.
תיבות דואר רבות בבת אחת
curl -s -X POST "https://trekmail.net/api/v1/mailboxes:login-access" \
-H "Authorization: Bearer tm_live_your_token" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: suspend-domain-123-august" \
-d '{"domain_id":123,"login_suspended":true,"reason":"Unpaid invoice 42"}'
העבירו בורר אחד בדיוק:
| בורר | מתי להשתמש בו |
|---|---|
"mailbox_ids": [12, 34] |
קבוצה מוגדרת, עד 1000 בכל קריאה |
"domain_id": 123 |
דומיין שלם. השתמשו באפשרות זו כשדומיין אחד שייך ללקוח אחד |
"all": true |
כל תיבות הדואר בחשבון |
התגובה מספרת מה קרה:
{ "data": { "login_suspended": true, "matched": 24, "updated": 21, "skipped": 3 } }
matched הוא מספר התיבות שהבורר מצא, updated הוא מספר התיבות שהשתנו בפועל, ו-skipped הוא מספר התיבות שלא היה אפשר להחיל עליהן את הקריאה. תיבות שכבר נמצאות במצב המבוקש נספרות כהתאמה, אך אינן מתעדכנות. לכן אפשר לחזור על הקריאה בבטחה, למשל אם משימת חיוב מריצה אותה מדי לילה.
הגדירו "login_suspended": false כדי לשחזר את אותה קבוצה.
באמצעות סוכן MCP
suspend_mailbox_login(mailbox_id=1701, reason="Unpaid invoice 42")
resume_mailbox_login(mailbox_id=1701)
set_mailboxes_login_access(domain_id=123, login_suspended=true, reason="Unpaid invoice 42")
כל שלושת הכלים זמינים לסוכן בעל היקף ההרשאה הנדרש. בשרת MCP שמתארח באופן מקומי, מנהל המערכת יכול לדרוש אישור מפורש לפעולות כתיבה. כך נמנע מהסוכן לחסום משתמשים בטעות.
מה עושה תיבת דואר שהכניסה אליה הושעתה
ההשעיה נאכפת בכל נקודת כניסה ואינה רק מוסתרת בממשק:
- הכניסה לדואר האינטרנט נדחית, וכל הפעלה שכבר פתוחה מסתיימת
- אימות IMAP, POP ו-SMTP נדחה, לכן יישומי הדואר מפסיקים לעבוד ואי אפשר לשלוח דבר
- CalDAV ו-CardDAV נדחים, לכן היומן ואנשי הקשר מפסיקים להסתנכרן לטלפונים ולמחשבים ניידים
- אסימוני הודעות (
tm_msg_) של התיבה מחזירים422 mailbox_login_suspended. הם אינם מבוטלים, ולכן יחזרו לפעול לאחר שחזור הכניסה - סיסמאות מכשיר לסנכרון קבצים מבוטלות לצמיתות; לאחר הסרת ההשעיה נוצרתנה סיסמאות חדשות
- קישורים לאיפוס סיסמה וקודי שחזור מפסיקים לפעול, ואי אפשר להנפיק חדשים; איפוס הסיסמה אינו משחזר את הגישה, מפני שהסיסמה אינה הגורם שחוסם אותה
- הדואר הנכנס נמסר כרגיל, וכללי העברה ומסננים ממשיכים לפעול
שום דבר אינו נמחק. כל הודעה, איש קשר, אירוע ביומן וקובץ נשארים במקומם, ותיבת הדואר ממשיכה להיספר במסגרת התוכנית ונפח האחסון שלה. היא ממשיכה לקבל דואר.
העברות לתיבה שהכניסה אליה הושעתה
אי אפשר להתחיל העברה לתיבת דואר שהכניסה אליה הושעתה: POST /api/v1/migrations מחזיר 422 mailbox_login_suspended. כלי הייבוא נכנס כדי למסור את הדואר שהוא מעתיק, ולכן המשימה תיכשל באמצע. שחזרו את הכניסה, הפעילו את ההעברה והשעו אותה שוב אם עדיין יש בכך צורך.
תיבות דואר משותפות
ה-endpoint היחיד דוחה תיבות דואר משותפות עם 422 mailbox_unavailable, וה-endpoint הקבוצתי מדלג עליהן אך עדיין סופר אותן. איש אינו נכנס ישירות לתיבת דואר משותפת: הצוות פותח אותה מתוך התיבות האישיות שלו. לכן השעיית התיבה של אותו אדם היא שסוגרת את הדלת, גם לתיבה המשותפת. שמירת השעיה ברשומה המשותפת תיראה כאילו היא עושה משהו, אך לא תשנה דבר.
שגיאות אפשריות
| תגובה | משמעות |
|---|---|
409 |
כבר מושהית (או כבר פעילה), אין מה לעשות |
422 mailbox_unavailable |
תיבה משותפת, או תיבה מושהית או בתהליך מחיקה |
403 mailbox_sending_paused |
מוחזר על ידי endpoints השליחה, לא על ידי אלה: השליחה נעצרה עבור התיבה ורק התמיכה יכולה להפעיל אותה מחדש |
שגיאת אימות 422 |
יותר מבורר אחד, או ללא בורר, ב-endpoint הקבוצתי |
403 |
לאסימון חסר mailboxes:write |
404 |
התיבה אינה בחשבון הזה, או שהיקף האסימון אינו מאפשר גישה אליה |
מאמרים קשורים
קפצו למדריכים הסמוכים שממשיכים את זרימת העבודה.