Class GmailAttachment

GmailAttachment

Gmail 中的附件。這是一般的 Blob，但其有額外的 getSize() 方法比呼叫快速 getBytes().length (不會佔用 Gmail 讀取配額)。 

// Logs information about any attachments in the first 100 inbox threads.
var threads = GmailApp.getInboxThreads(0, 100);
var msgs = GmailApp.getMessagesForThreads(threads);
for (var i = 0 ; i < msgs.length; i++) {
  for (var j = 0; j < msgs[i].length; j++) {
    var attachments = msgs[i][j].getAttachments();
    for (var 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());
    }
  }
}

方法

方法傳回類型簡短說明
copyBlob()Blob傳回這個 blob 的副本。
getAs(contentType)Blob以 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 檔案 (試算表、文件等)。
setBytes(data)Blob設定儲存在這個 blob 中的資料。
setContentType(contentType)Blob設定這個 blob 中的位元組內容類型。
setContentTypeFromExtension()Blob根據副檔名設定這個 blob 中的位元組內容類型。
setDataFromString(string)Blob從使用 UTF-8 編碼的字串設定這個 blob 的資料。
setDataFromString(string, charset)Blob從使用指定編碼的字串設定這個 blob 的資料。
setName(name)Blob設定這個 blob 的名稱。

內容詳盡的說明文件

copyBlob()

傳回這個 blob 的副本。

回攻員

Blob：新的副本。

getAs(contentType)

以 blob 的形式傳回這個物件中的資料，做為轉換成指定內容類型的 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 文件，'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 內容雜湊，以字串表示。

授權

使用這個方法的指令碼需要授權下列一或多個範圍或相關 REST API 中的適當範圍：

  • https://mail.google.com/

getName()

取得這個 blob 的名稱。

回攻員

String — 這項資料的名稱 (如果已知)，或 null。

getSize()

取得這個附件的大小。這個方法比呼叫 getBytes().length 更快，且不會計入 Gmail 讀取配額。

回攻員

Integer：附件的大小，以位元組為單位。

授權

使用這個方法的指令碼需要授權下列一或多個範圍或相關 REST API 中的適當範圍：

  • https://mail.google.com/

isGoogleType()

傳回這個 blob 是否為 Google Workspace 檔案 (試算表、文件等)。

回攻員

Boolean - 如果這個 blob 是 Google Workspace 檔案，則為 true；false 表示不需要。

setBytes(data)

設定儲存在這個 blob 中的資料。

參數

名稱類型說明
dataByte[]新資料，

回攻員

Blob — 用於鏈結的 blob。

setContentType(contentType)

設定這個 blob 中的位元組內容類型。

參數

名稱類型說明
contentTypeString新的 contentType。

回攻員

Blob — 用於鏈結的 blob。

setContentTypeFromExtension()

根據副檔名設定這個 blob 中的位元組內容類型。contentType 為 如果無法從擴充功能中猜到，則為 null。

回攻員

Blob — 用於鏈結的 blob。

setDataFromString(string)

從使用 UTF-8 編碼的字串設定這個 blob 的資料。

參數

名稱類型說明
stringString字串資料。

回攻員

Blob — 用於鏈結的 blob。

setDataFromString(string, charset)

從使用指定編碼的字串設定這個 blob 的資料。

參數

名稱類型說明
stringString字串資料。
charsetString用來將字串解讀為位元組的字元集。

回攻員

Blob — 用於鏈結的 blob。

setName(name)

設定這個 blob 的名稱。

參數

名稱類型說明
nameString新名稱。

回攻員

Blob — 用於鏈結的 blob。

已淘汰的方法