Class GmailAttachment

Gmail添付ファイル

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この 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)BlobUTF-8 エンコードの文字列からこの blob のデータが設定されます。
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 ドキュメント ドキュメントの場合は、'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 コンテンツ ハッシュ（文字列）。

承認

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

  • https://mail.google.com/

getName()

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

戻る

String - このデータの名前（既知の場合）または 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 に保存されるデータを設定します。

パラメータ

名前型説明
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。

サポート終了のメソッド