משאב: export

בדף הזה מפורטים הפרמטרים שזמינים למשאב export של Email Audit API כשמורידים תיבת דואר.

שדות תיאור
beginDate

זה שינוי אופציונלי.

התאריך של הודעת האימייל הראשונה שכלולה בתיבת הדואר המיוצאת. אם רוצים לקבל את כל האימיילים החל מהתאריך שבו החשבון נוצר, לא מזינים ערך בשדה הזה.פורמט התאריך הוא YYYY-MM-dd HH:mm, כאשר HH הוא השעה ביום (0 עד 23) ו-mm הוא מספר הדקות בשעה (0 עד 59).

אזור הזמן הוא בפורמט של זמן אוניברסלי מתואם (UTC). ממירים את הזמן לפורמט UTC לפני שמתחילים לייצא את תיבת הדואר.

endDate

זה שינוי אופציונלי.

התאריך של הודעת האימייל האחרונה שכלולה בתיבת הדואר המיוצאת. אם לא מציינים את הערך הזה, הודעות האימייל שיוצאו יישלחו בתאריך הנוכחי. פורמט התאריך הוא YYYY-MM-dd HH:mm, כאשר HH הוא השעה ביום (0 עד 23) ו-mm הוא הדקות בשעה (0 עד 59).

אזור הזמן הוא בפורמט של זמן אוניברסלי מתואם (UTC). ממירים את הזמן לפורמט UTC לפני שמתחילים לייצא את תיבת הדואר.

searchQuery

זה שינוי אופציונלי.

תיבת הדואר תסונן לפי הערך searchQuery, ותוכלו להוריד רק את תוצאות החיפוש המסוננות. שאילתות החיפוש האלה פועלות לפי אותם כללי חיפוש כמו החיפוש המתקדם ב-Gmail.

הפרמטרים searchQuery ו-includeDeleted הם בלעדיים זה לזה. לא ניתן להזין שאילתה אם includeDeleted = "true".

includeDeleted

זה שינוי אופציונלי.

קובע אם הודעות שנמחקו נכללות בקובץ הייצוא של תיבת הדואר. כברירת מחדל, הערך הוא "false" והודעות שנמחקו לא נכללות.

הפרמטרים searchQuery ו-includeDeleted הם בלעדיים זה לזה. לא ניתן להזין שאילתה אם includeDeleted = "true".

packageContent

חובה.

קובע אם קובץ הייצוא של תיבת הדואר יכלול את הודעת האימייל המלאה או רק את הכותרת שלה.

  • FULL_MESSAGE: תוכן האימייל המלא, כולל הקובצים המצורפים, מועתק לקובץ הייצוא. זוהי הגדרת ברירת המחדל.
  • HEADER_ONLY: רק הכותרת של האימייל מועתקת לקובץ הייצוא.