Class GmailAttachment

Gmail からの添付ファイル。これは通常の Blob ですが、getBytes().length の呼び出しよりも高速で、Gmail の読み取り割り当てにカウントされない getSize() メソッドが追加されています。

// 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(),
      );
    }
  }
}

メソッド

メソッド	戻り値の型	概要
`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 ファイル（スプレッドシート、ドキュメントなど）かどうかを返します。
`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 の名前を設定します。

サポート終了のメソッド

メソッド	戻り値の型	概要
`getAllBlobs()`	`Blob[]`	この（複合）Blob に含まれるすべての Blob を取得します。

詳細なドキュメント

`copyBlob()`

この blob のコピーを返します。

戻る

Blob - 新しいコピー。

`getAs(contentType)`

このオブジェクト内のデータを、指定されたコンテンツタイプに変換された blob として返します。このメソッドは、ファイル名に適切な拡張子（例: 「myfile.pdf」）を追加します。ただし、最後のピリオドの後に続くファイル名の一部（存在する場合）は、置き換える必要がある既存の拡張子であると想定されます。その結果、「ShoppingList.12.25.2014」は「ShoppingList.12.25.pdf」になります。

コンバージョンの 1 日あたりの割り当てを確認するには、Google サービスの割り当てをご覧ください。新しく作成された Google Workspace ドメインには、一時的に厳しい割り当てが適用されることがあります。

パラメータ

名前	型	説明
`contentType`	`String`	変換先の 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 - このデータのコンテンツタイプ（判明している場合）または null。

`getDataAsString()`

この blob のデータを UTF-8 エンコードの文字列として取得します。

戻る

String - 文字列としてのデータ。

`getDataAsString(charset)`

この blob のデータを指定されたエンコードで文字列として取得します。

パラメータ

名前	型	説明
`charset`	`String`	この Blob のデータを文字列としてエンコードする際に使用する文字セット。

戻る

String - 文字列としてのデータ。

`getHash()`

この添付ファイルの SHA1 コンテンツハッシュを取得します。このメソッドは、Gmail の読み取り割り当ての対象にはなりません。

戻る

String - 文字列としての SHA1 コンテンツハッシュ。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API の適切なスコープによる承認が必要です。

https://mail.google.com/

`getName()`

この BLOB の名前を取得します。

戻る

String|null - このデータの名前（わかっている場合）、または null。

`getSize()`

この添付ファイルのサイズを取得します。この方法は getBytes().length を呼び出すよりも高速で、Gmail の読み取り割り当てにはカウントされません。

戻る

Integer - 添付ファイルのサイズ（バイト単位）。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープまたは関連する REST API の適切なスコープによる承認が必要です。

https://mail.google.com/

`isGoogleType()`

この Blob が Google Workspace ファイル（スプレッドシート、ドキュメントなど）かどうかを返します。

戻る

Boolean - この BLOB が Google Workspace ファイルの場合は true、それ以外の場合は false。

`setBytes(data)`

この blob に保存されているデータを設定します。

パラメータ

名前	型	説明
`data`	`Byte[]`	新しいデータ。

戻る

Blob - チェーン用のこの blob。

`setContentType(contentType)`

この blob のバイトのコンテンツタイプを設定します。

パラメータ

名前	型	説明
`contentType`	`String`	新しい contentType。

戻る

Blob - チェーン用のこの blob。

`setContentTypeFromExtension()`

ファイル拡張子に基づいて、この Blob のバイトのコンテンツタイプを設定します。拡張子から推測できない場合、contentType は null になります。

戻る

Blob - チェーン用のこの blob。

`setDataFromString(string)`

UTF-8 エンコードの文字列からこの blob のデータを設定します。

パラメータ

名前	型	説明
`string`	`String`	文字列データ。

戻る

Blob - チェーン用のこの blob。

`setDataFromString(string, charset)`

指定されたエンコードの文字列からこの BLOB のデータを設定します。

パラメータ

名前	型	説明
`string`	`String`	文字列データ。
`charset`	`String`	文字列をバイトとして解釈する際に使用する文字セット。

戻る

Blob - チェーン用のこの blob。

`setName(name)`

この BLOB の名前を設定します。

パラメータ

名前	型	説明
`name`	`String`	新しい名前です。

戻る

Blob - チェーン用のこの blob。

サポート終了のメソッド

`getAllBlobs()`

非推奨。この関数は非推奨であり、新しいスクリプトでは使用しないでください。

この（複合）Blob に含まれるすべての Blob を取得します。

戻る

Blob[] - blob に含まれる blob。

Class GmailAttachment コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メソッド

サポート終了のメソッド

詳細なドキュメント

copyBlob()

戻る

getAs(contentType)

パラメータ

戻る

getBytes()

戻る

getContentType()

戻る

getDataAsString()

戻る

getDataAsString(charset)

パラメータ

戻る

getHash()

戻る

承認

getName()

戻る

getSize()

戻る

承認

isGoogleType()

戻る

setBytes(data)

パラメータ

戻る

setContentType(contentType)

パラメータ

戻る

setContentTypeFromExtension()

戻る

setDataFromString(string)

パラメータ

戻る

setDataFromString(string, charset)

パラメータ

戻る

setName(name)

パラメータ

戻る

サポート終了のメソッド

getAllBlobs()

戻る

Class GmailAttachment

`copyBlob()`

`getAs(contentType)`

`getBytes()`

`getContentType()`

`getDataAsString()`

`getDataAsString(charset)`

`getHash()`

`getName()`

`getSize()`

`isGoogleType()`

`setBytes(data)`

`setContentType(contentType)`

`setContentTypeFromExtension()`

`setDataFromString(string)`

`setDataFromString(string, charset)`

`setName(name)`

`getAllBlobs()`