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הפונקציה מקבלת את סוג התוכן של הבייטים ב-blob הזה.
getDataAsString()Stringהפונקציה מקבלת את הנתונים של ה-blob הזה כמחרוזת עם קידוד UTF-8.
getDataAsString(charset)Stringהפונקציה מקבלת את הנתונים של ה-blob הזה כמחרוזת עם הקידוד שצוין.
getHash()Stringהפונקציה מקבלת את גיבוב התוכן של SHA1 עבור הקובץ המצורף הזה.
getName()Stringהפונקציה מקבלת את השם של ה-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 שאליו רוצים להמיר. ברוב ה-blobs, '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.


getDataAsString()

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

חזרה

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


getDataAsString(charset)

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

פרמטרים

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

חזרה

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


getHash()

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

חזרה

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

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מההיקפי הגישה הבאים, או עם היקפי גישה מתאימים מה-API ל-REST הקשור:

  • https://mail.google.com/

getName()

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

חזרה

String – השם של הנתונים האלה, אם ידוע, או null.


getSize()

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

חזרה

Integer – הגודל של הקובץ המצורף, בבייטים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מההיקפי הגישה הבאים, או עם היקפי גישה מתאימים מה-API ל-REST הקשור:

  • https://mail.google.com/

isGoogleType()

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

חזרה

Booleantrue אם ה-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 הזה, לצורך קישור.

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