Class GmailAttachment

קובץ מצורף ב-Gmail

קובץ מצורף מ-Gmail. זהו Blob רגיל, רק שיש לו שיטה נוספת getSize() שהיא מהירה יותר מקריאה ל-getBytes().length ולא נספרת במכסת הקריאה של Gmail. 

// Logs information about any attachments in the first 100 inbox threads.
const threads = GmailApp.getInboxThreads(0, 100);
const msgs = GmailApp.getMessagesForThreads(threads);
for (let i = 0; i < msgs.length; i++) {
  for (let j = 0; j < msgs[i].length; j++) {
    const attachments = msgs[i][j].getAttachments();
    for (let k = 0; k < attachments.length; k++) {
      Logger.log(
          'Message "%s" contains the attachment "%s" (%s bytes)',
          msgs[i][j].getSubject(),
          attachments[k].getName(),
          attachments[k].getSize(),
      );
    }
  }
}

Methods

שיטהסוג הערך שמוחזרתיאור קצר
copyBlob()Blobמחזירה עותק של ה-blob הזה.
getAs(contentType)Blobהחזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין.
getBytes()Byte[]מקבל את הנתונים שמאוחסנים ב-blob הזה.
getContentType()String|nullמחזירה את סוג התוכן של הבייטים ב-blob הזה.
getDataAsString()Stringמחזירה את הנתונים של ה-blob הזה כמחרוזת עם קידוד UTF-8.
getDataAsString(charset)Stringהפונקציה מחזירה את הנתונים של ה-blob הזה כמחרוזת עם הקידוד שצוין.
getHash()Stringהפונקציה מחזירה את גיבוב SHA1 של התוכן של הקובץ המצורף הזה.
getName()String|nullהפונקציה מחזירה את השם של ה-blob הזה.
getSize()Integerהפונקציה מחזירה את הגודל של הקובץ המצורף.
isGoogleType()Booleanהפונקציה מחזירה אם ה-blob הזה הוא קובץ Google Workspace (Sheets,‏ Docs וכו').
setBytes(data)Blobמגדיר את הנתונים שמאוחסנים ב-blob הזה.
setContentType(contentType)Blobמגדיר את סוג התוכן של הבייטים ב-blob הזה.
setContentTypeFromExtension()Blobההגדרה קובעת את סוג התוכן של הבייטים ב-blob הזה על סמך סיומת הקובץ.
setDataFromString(string)Blobהפונקציה מגדירה את הנתונים של ה-blob הזה ממחרוזת עם קידוד UTF-8.
setDataFromString(string, charset)Blobמגדירה את הנתונים של ה-blob הזה ממחרוזת עם הקידוד שצוין.
setName(name)Blobמגדיר את השם של ה-blob הזה.

תיעוד מפורט

copyBlob()

מחזירה עותק של ה-blob הזה.

חזרה

‫Blob — העותק החדש.

getAs(contentType)

החזרת הנתונים בתוך האובייקט הזה כ-blob שהומר לסוג התוכן שצוין. בשיטה הזו, הסיומת המתאימה מתווספת לשם הקובץ – לדוגמה, 'myfile.pdf'. עם זאת, המערכת מניחה שחלק משם הקובץ שאחרי הנקודה האחרונה (אם יש כזו) הוא סיומת קיימת שצריך להחליף. לכן, 'ShoppingList.12.25.2014' הופך ל-'ShoppingList.12.25.pdf'.

כדי לראות את המכסות היומיות להמרות, אפשר לעיין במאמר בנושא מכסות לשירותי Google. יכול להיות שדומיינים חדשים שנוצרו ב-Google Workspace יהיו כפופים באופן זמני למכסות מחמירות יותר.

פרמטרים

שםסוגתיאור
contentTypeStringסוג ה-MIME שאליו רוצים להמיר. ברוב ה-blob, ‏ 'application/pdf' היא האפשרות התקפה היחידה. אם התמונות בפורמט BMP,‏ GIF,‏ JPEG או PNG, אפשר להשתמש גם באחד מהערכים 'image/bmp', 'image/gif', 'image/jpeg' או 'image/png'. במסמך Google Docs, הערך 'text/markdown' תקף גם כן.

חזרה

‫Blob — הנתונים כ-blob.

getBytes()

מקבל את הנתונים שמאוחסנים ב-blob הזה.

חזרה

‫Byte[] – הבייטים המאוחסנים.

getContentType()

מקבל את סוג התוכן של הבייטים ב-Blob הזה.

חזרה

‫String|null — סוג התוכן של הנתונים האלה, אם ידוע, או null.

getDataAsString()

מחזירה את הנתונים של ה-blob הזה כמחרוזת עם קידוד UTF-8.

חזרה

‫String — הנתונים כמחרוזת.

getDataAsString(charset)

הפונקציה מחזירה את הנתונים של ה-blob הזה כמחרוזת עם הקידוד שצוין.

פרמטרים

שםסוגתיאור
charsetStringערכת התווים שבה יש להשתמש כדי לקודד את הנתונים ב-blob הזה כמחרוזת.

חזרה

‫String — הנתונים כמחרוזת.

getHash()

הפונקציה מחזירה את גיבוב SHA1 של התוכן של הקובץ המצורף הזה. השיטה הזו לא נכללת במכסת הקריאה של Gmail.

חזרה

‫String – גיבוב התוכן מסוג SHA1, כמחרוזת.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מההיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

  • https://mail.google.com/

getName()

הפונקציה מחזירה את השם של ה-blob הזה.

חזרה

‫String|null — השם של הנתונים האלה, אם ידוע, או null.

getSize()

הפונקציה מחזירה את הגודל של הקובץ המצורף. השיטה הזו מהירה יותר מהתקשרות אל getBytes().length והיא לא נספרת במכסת הקריאה של Gmail.

חזרה

‫Integer — גודל הקובץ המצורף בבייטים.

אישור

סקריפטים שמשתמשים ב-method הזה צריכים הרשאה עם אחת או יותר מההיקפים הבאים או היקפים מתאימים מה-API בארכיטקטורת REST שקשור:

  • https://mail.google.com/

isGoogleType()

הפונקציה מחזירה אם ה-blob הזה הוא קובץ Google Workspace (Sheets,‏ Docs וכו').

חזרה

‫Boolean — true אם ה-blob הוא קובץ Google Workspace;‏ false אם לא.

setBytes(data)

מגדיר את הנתונים שמאוחסנים ב-blob הזה.

פרמטרים

שםסוגתיאור
dataByte[]הנתונים החדשים.

חזרה

‫Blob – ה-blob הזה, לשרשור.

setContentType(contentType)

מגדיר את סוג התוכן של הבייטים ב-Blob הזה.

פרמטרים

שםסוגתיאור
contentTypeStringהערך החדש של contentType.

חזרה

‫Blob – ה-blob הזה, לשרשור.

setContentTypeFromExtension()

ההגדרה קובעת את סוג התוכן של הבייטים ב-blob הזה על סמך סיומת הקובץ. הערך של contentType הוא null אם אי אפשר לנחש אותו מהסיומת.

חזרה

‫Blob – ה-blob הזה, לשרשור.

setDataFromString(string)

הפונקציה מגדירה את הנתונים של ה-blob הזה ממחרוזת עם קידוד UTF-8.

פרמטרים

שםסוגתיאור
stringStringנתוני המחרוזת.

חזרה

‫Blob – ה-blob הזה, לשרשור.

setDataFromString(string, charset)

מגדירה את הנתונים של ה-blob הזה ממחרוזת עם הקידוד שצוין.

פרמטרים

שםסוגתיאור
stringStringנתוני המחרוזת.
charsetStringערכת התווים שמשמשת לפרש את המחרוזת כבייטים.

חזרה

‫Blob – ה-blob הזה, לשרשור.

setName(name)

מגדיר את השם של ה-blob הזה.

פרמטרים

שםסוגתיאור
nameStringהשם החדש.

חזרה

‫Blob – ה-blob הזה, לשרשור.

שיטות שהוצאו משימוש