משאב: 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: רק הכותרת של האימייל מועתקת לקובץ הייצוא.