このページは Cloud Translation API によって翻訳されました。

Gmail Service

このサービスでは、メールの送信、下書きの作成、ラベルの管理、メッセージとスレッドのマーク付け、その他さまざまな Gmail アカウント管理タスクを実行できます。メールの送信のみを許可するシンプルなサービスである Mail Service もご覧ください。

クラス

名前	概要
`GmailApp`	Gmail のスレッド、メッセージ、ラベルへのアクセスを提供します。
`GmailAttachment`	Gmail からの添付ファイル。
`GmailDraft`	ユーザーの Gmail アカウントでユーザーが作成した下書きメッセージ。
`GmailLabel`	ユーザーの Gmail アカウントでユーザーが作成したラベル。
`GmailMessage`	ユーザーの Gmail アカウント内のメッセージ。
`GmailThread`	ユーザーの Gmail アカウント内のスレッド。

`GmailApp`

メソッド

メソッド	戻り値の型	概要
`createDraft(recipient, subject, body)`	`GmailDraft`	メールメッセージの下書きを作成します。
`createDraft(recipient, subject, body, options)`	`GmailDraft`	省略可能な引数を使用して、メールメッセージの下書きを作成します。
`createLabel(name)`	`GmailLabel`	指定された名前の新しいユーザーラベルを作成します。
`deleteLabel(label)`	`GmailApp`	指定されたラベルを削除します。
`getAliases()`	`String[]`	Gmail でこのアカウントのエイリアスとして設定されているメールのリストを取得します。
`getDraft(draftId)`	`GmailDraft`	ID でメールメッセージの下書きを取得します。
`getDraftMessages()`	`GmailMessage[]`	すべての下書きメッセージを取得します。
`getDrafts()`	`GmailDraft[]`	すべての Gmail 下書きメールを取得します。
`getInboxThreads()`	`GmailThread[]`	ラベルに関係なく、受信トレイのすべてのスレッドを取得します。
`getInboxThreads(start, max)`	`GmailThread[]`	ラベルに関係なく、受信トレイのスレッドの範囲を取得します。
`getInboxUnreadCount()`	`Integer`	受信トレイ内の未読スレッドの数を取得します。
`getMessageById(id)`	`GmailMessage`	ID でメッセージを取得します。
`getMessagesForThread(thread)`	`GmailMessage[]`	指定されたスレッド内のすべてのメッセージを取得します。
`getMessagesForThreads(threads)`	`GmailMessage[][]`	指定されたスレッド内のすべてのメッセージを取得します。
`getPriorityInboxThreads()`	`GmailThread[]`	ラベルに関係なく、優先受信トレイのすべてのスレッドを取得します。
`getPriorityInboxThreads(start, max)`	`GmailThread[]`	ラベルに関係なく、優先トレイのスレッドの範囲を取得します。
`getPriorityInboxUnreadCount()`	`Integer`	優先トレイ内の未読スレッドの数を取得します。
`getSpamThreads()`	`GmailThread[]`	ラベルに関係なく、すべてのスパムスレッドを取得します。
`getSpamThreads(start, max)`	`GmailThread[]`	ラベルに関係なく、スパムスレッドの範囲を取得します。
`getSpamUnreadCount()`	`Integer`	迷惑メールの未読スレッドの数を取得します。
`getStarredThreads()`	`GmailThread[]`	ラベルに関係なく、スター付きのすべてのスレッドを取得します。
`getStarredThreads(start, max)`	`GmailThread[]`	ラベルに関係なく、スター付きスレッドの範囲を取得します。
`getStarredUnreadCount()`	`Integer`	スター付きの未読スレッドの数を取得します。
`getThreadById(id)`	`GmailThread`	ID でスレッドを取得します。
`getTrashThreads()`	`GmailThread[]`	ラベルに関係なく、すべてのゴミ箱スレッドを取得します。
`getTrashThreads(start, max)`	`GmailThread[]`	ラベルに関係なく、ゴミ箱内のスレッドの範囲を取得します。
`getUserLabelByName(name)`	`GmailLabel`	ラベル名で指定されたラベルを取得します。
`getUserLabels()`	`GmailLabel[]`	ユーザーが作成したラベルのリストを取得します。
`markMessageRead(message)`	`GmailApp`	このメッセージを既読にし、メッセージを強制的に更新します。
`markMessageUnread(message)`	`GmailApp`	このメッセージを未読としてマークし、メッセージを強制的に更新します。
`markMessagesRead(messages)`	`GmailApp`	これらのメッセージを既読にし、メッセージを強制的に更新します。
`markMessagesUnread(messages)`	`GmailApp`	これらのメッセージを未読としてマークし、メッセージを強制的に更新します。
`markThreadImportant(thread)`	`GmailApp`	このスレッドを重要としてマークし、スレッドを強制的に更新します。
`markThreadRead(thread)`	`GmailApp`	このスレッドを既読にし、スレッドを強制的に更新します。
`markThreadUnimportant(thread)`	`GmailApp`	このスレッドを重要でないとマークし、スレッドを強制的に更新します。
`markThreadUnread(thread)`	`GmailApp`	このスレッドを未読としてマークし、スレッドを強制的に更新します。
`markThreadsImportant(threads)`	`GmailApp`	これらのスレッドを重要としてマークし、スレッドを強制的に更新します。
`markThreadsRead(threads)`	`GmailApp`	これらのスレッドを既読にし、スレッドを強制的に更新します。
`markThreadsUnimportant(threads)`	`GmailApp`	これらのスレッドを重要でないとマークし、スレッドの更新を強制します。
`markThreadsUnread(threads)`	`GmailApp`	これらのスレッドを未読としてマークし、スレッドを強制的に更新します。
`moveMessageToTrash(message)`	`GmailApp`	メールをゴミ箱に移動し、メールを強制的に更新します。
`moveMessagesToTrash(messages)`	`GmailApp`	指定されたメッセージをゴミ箱に移動し、メッセージの更新を強制します。
`moveThreadToArchive(thread)`	`GmailApp`	このスレッドをアーカイブに移動し、スレッドを強制的に更新します。
`moveThreadToInbox(thread)`	`GmailApp`	このスレッドを受信トレイに移動し、スレッドを強制的に更新します。
`moveThreadToSpam(thread)`	`GmailApp`	このスレッドをスパムに移動し、スレッドを強制的に更新します。
`moveThreadToTrash(thread)`	`GmailApp`	このスレッドをゴミ箱に移動し、スレッドを強制的に更新します。
`moveThreadsToArchive(threads)`	`GmailApp`	これらのスレッドをアーカイブに移動し、スレッドを強制的に更新します。
`moveThreadsToInbox(threads)`	`GmailApp`	これらのスレッドを受信トレイに移動し、スレッドを強制的に更新します。
`moveThreadsToSpam(threads)`	`GmailApp`	これらのスレッドを迷惑メールに移動し、スレッドを強制的に更新します。
`moveThreadsToTrash(threads)`	`GmailApp`	これらのスレッドをゴミ箱に移動し、スレッドの更新を強制します。
`refreshMessage(message)`	`GmailApp`	Gmail からメッセージと関連する状態を再読み込みします（ラベルや既読状態などが変更された場合に便利です）。
`refreshMessages(messages)`	`GmailApp`	Gmail からメッセージと関連する状態を再読み込みします（ラベルや既読状態などが変更された場合に便利です）。
`refreshThread(thread)`	`GmailApp`	Gmail からスレッドと関連する状態を再読み込みします（ラベルや既読状態などが変更された場合に便利です）。
`refreshThreads(threads)`	`GmailApp`	Gmail からスレッドと関連する状態を再読み込みします（ラベルや既読状態などが変更された場合に便利です）。
`search(query)`	`GmailThread[]`	指定されたクエリで Gmail を検索します。
`search(query, start, max)`	`GmailThread[]`	指定されたクエリで Gmail を検索します。
`sendEmail(recipient, subject, body)`	`GmailApp`	メールメッセージを送信します。
`sendEmail(recipient, subject, body, options)`	`GmailApp`	省略可能な引数を使用してメールメッセージを送信します。
`setCurrentMessageAccessToken(accessToken)`	`void`	スクリプトが現在の `GmailMessage` プロパティにアクセスできるようにする現在のメッセージアクセストークンを設定します。
`starMessage(message)`	`GmailApp`	このメッセージにスターを付け、メッセージを強制的に更新します。
`starMessages(messages)`	`GmailApp`	これらのメッセージにスターを追加し、メッセージを強制的に更新します。
`unstarMessage(message)`	`GmailApp`	このメッセージからスターを外し、メッセージを強制的に更新します。
`unstarMessages(messages)`	`GmailApp`	これらのメッセージからスターを削除し、メッセージを強制的に更新します。

`GmailAttachment`

メソッド

メソッド	戻り値の型	概要
`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)`	`Blob`	UTF-8 エンコードの文字列からこの blob のデータを設定します。
`setDataFromString(string, charset)`	`Blob`	指定されたエンコードの文字列からこの BLOB のデータを設定します。
`setName(name)`	`Blob`	この BLOB の名前を設定します。

`GmailDraft`

メソッド

メソッド	戻り値の型	概要
`deleteDraft()`	`void`	この下書きメッセージを削除します。
`getId()`	`String`	この下書きメッセージの ID を取得します。
`getMessage()`	`GmailMessage`	この下書きを表す GmailMessage を返します。
`getMessageId()`	`String`	この下書きを表す `GmailMessage` の ID を返します。
`send()`	`GmailMessage`	この下書きメールメッセージを送信します。
`update(recipient, subject, body)`	`GmailDraft`	この下書きメッセージの内容を置き換えます。
`update(recipient, subject, body, options)`	`GmailDraft`	省略可能な引数を使用して、この下書きメッセージの内容を置き換えます。

`GmailLabel`

メソッド

メソッド	戻り値の型	概要
`addToThread(thread)`	`GmailLabel`	指定されたスレッドにこのラベルを追加し、スレッドを強制的に更新します（`GmailThread.refresh()`）。
`addToThreads(threads)`	`GmailLabel`	指定されたスレッドにこのラベルを追加し、スレッドを強制的に更新します。
`deleteLabel()`	`void`	このラベルを削除します。
`getId()`	`String`	このラベルの ID を取得します。
`getName()`	`String`	このラベルの名前を取得します。
`getThreads()`	`GmailThread[]`	このラベルでマークされたスレッドを取得します。
`getThreads(start, max)`	`GmailThread[]`	このラベルが付けられたスレッドの範囲を取得します。
`getUnreadCount()`	`Integer`	このラベルが付けられた未読のスレッドの数を取得します。
`removeFromThread(thread)`	`GmailLabel`	指定されたスレッドからこのラベルを削除し、スレッドを強制的に更新します。
`removeFromThreads(threads)`	`GmailLabel`	指定されたスレッドからこのラベルを削除し、スレッドを強制的に更新します。

`GmailMessage`

メソッド

メソッド	戻り値の型	概要
`createDraftReply(body)`	`GmailDraft`	返信先アドレスを使用して、このメッセージの送信者に返信する下書きメッセージを作成します。
`createDraftReply(body, options)`	`GmailDraft`	返信先アドレスを使用してこのメッセージの送信者に返信する下書きメッセージを作成します。省略可能な引数があります。
`createDraftReplyAll(body)`	`GmailDraft`	返信先アドレスとこのメッセージのすべての受信者を使用して、送信者に返信する下書きメッセージを作成します。
`createDraftReplyAll(body, options)`	`GmailDraft`	返信先アドレスとすべての受信者を使用して、このメッセージの送信者に返信する下書きメッセージを作成します。省略可能な引数を使用できます。
`forward(recipient)`	`GmailMessage`	このメッセージを新しい受信者に転送します。
`forward(recipient, options)`	`GmailMessage`	このメッセージを新しい受信者に転送します（省略可能な引数を使用）。
`getAttachments()`	`GmailAttachment[]`	このメッセージのすべての添付ファイルを取得します。
`getAttachments(options)`	`GmailAttachment[]`	このメッセージのすべての添付ファイルを取得します。
`getBcc()`	`String`	このメッセージの Bcc に追加された受信者のカンマ区切りリストを取得します。
`getBody()`	`String`	このメッセージの本文の HTML コンテンツを取得します。
`getCc()`	`String`	このメッセージの Cc に追加された受信者のカンマ区切りリストを取得します。
`getDate()`	`Date`	このメッセージの日時を取得します。
`getFrom()`	`String`	このメッセージの送信者を取得します。
`getHeader(name)`	`String`	ヘッダー名が指定された RFC 2822 ヘッダーの値を取得します。
`getId()`	`String`	このメッセージの ID を取得します。
`getPlainBody()`	`String`	HTML 形式なしでこのメッセージの本文のコンテンツを取得します。
`getRawContent()`	`String`	このメッセージの未加工のコンテンツを取得します。
`getReplyTo()`	`String`	このメッセージの返信先アドレス（通常は送信者）を取得します。
`getSubject()`	`String`	このメッセージの件名を取得します。
`getThread()`	`GmailThread`	このメッセージを含むスレッドを取得します。
`getTo()`	`String`	このメッセージの受信者をカンマ区切りで取得します。
`isDraft()`	`Boolean`	このメッセージが下書きかどうかを取得します。
`isInChats()`	`Boolean`	このメッセージがチャットかどうかを取得します。
`isInInbox()`	`Boolean`	このメッセージが受信トレイにあるかどうかを取得します。
`isInPriorityInbox()`	`Boolean`	このメッセージが優先受信トレイにある場合は `true` を返し、それ以外の場合は `false` を返します。
`isInTrash()`	`Boolean`	このメッセージがゴミ箱にあるかどうかを取得します。
`isStarred()`	`Boolean`	このメッセージにスターが付いているかどうかを取得します。
`isUnread()`	`Boolean`	このメッセージが未読かどうかを取得します。
`markRead()`	`GmailMessage`	メールが既読になります。
`markUnread()`	`GmailMessage`	メールを未読としてマークします。
`moveToTrash()`	`GmailMessage`	メールをゴミ箱に移動します。
`refresh()`	`GmailMessage`	このメッセージと関連する状態を Gmail から再読み込みします（ラベルや既読状態などが変更された場合に便利です）。
`reply(body)`	`GmailMessage`	返信先アドレスを使用して、このメッセージの送信者に返信します。
`reply(body, options)`	`GmailMessage`	返信先アドレスを使用して、このメッセージの送信者に返信します（引数は省略可）。
`replyAll(body)`	`GmailMessage`	返信先アドレスとこのメッセージのすべての受信者を使用して、送信者に返信します。
`replyAll(body, options)`	`GmailMessage`	返信先アドレスとすべての受信者を使用して、このメッセージの送信者に返信します（引数は省略可）。
`star()`	`GmailMessage`	メッセージにスターを付けます。
`unstar()`	`GmailMessage`	メッセージのスターを外します。

`GmailThread`

メソッド

メソッド	戻り値の型	概要
`addLabel(label)`	`GmailThread`	このラベルをスレッドに追加します。
`createDraftReply(body)`	`GmailDraft`	返信先アドレスを使用して、このスレッドの最後のメッセージの送信者に返信する下書きメッセージを作成します。
`createDraftReply(body, options)`	`GmailDraft`	このスレッドの最後のメッセージの送信者に返信する下書きメッセージを、返信先アドレスとオプションの引数を使用して作成します。
`createDraftReplyAll(body)`	`GmailDraft`	このスレッドの最後のメッセージの送信者に返信する下書きメッセージを、返信先アドレスとこのメッセージのすべての受信者を使用して作成します。
`createDraftReplyAll(body, options)`	`GmailDraft`	このスレッドの最後のメッセージの送信者に返信する下書きメッセージを、返信先アドレスとすべての受信者を使用して作成します。省略可能な引数も使用できます。
`getFirstMessageSubject()`	`String`	スレッド内の最初のメッセージの件名を取得します。
`getId()`	`String`	このスレッドの ID を取得します。
`getLabels()`	`GmailLabel[]`	このスレッドのユーザー作成ラベルを返します。
`getLastMessageDate()`	`Date`	このスレッドの最新のメッセージの日付を取得します。
`getMessageCount()`	`Integer`	スレッド内のメッセージ数を返します。
`getMessages()`	`GmailMessage[]`	このスレッドのメッセージを取得します。
`getPermalink()`	`String`	このスレッドのパーマリンクを取得します。
`hasStarredMessages()`	`Boolean`	スレッドにスター付きのメッセージがあるかどうかを返します。
`isImportant()`	`Boolean`	スレッドに重要マークが付いているかどうかを返します。
`isInChats()`	`Boolean`	スレッドにチャットのラベルが付いているかどうかを返します。
`isInInbox()`	`Boolean`	スレッドが受信トレイにあるかどうかを返します。
`isInPriorityInbox()`	`Boolean`	このスレッドが優先受信トレイにある場合は true を返し、それ以外の場合は false を返します。
`isInSpam()`	`Boolean`	スレッドがスパムとしてマークされているかどうかを返します。
`isInTrash()`	`Boolean`	スレッドがゴミ箱にあるかどうかを返します。
`isUnread()`	`Boolean`	スレッドに未読のメッセージがあるかどうかを返します。
`markImportant()`	`GmailThread`	このスレッドに重要マークを付けます。
`markRead()`	`GmailThread`	このスレッドを既読にします。
`markUnimportant()`	`GmailThread`	このスレッドを重要でないとマークします。
`markUnread()`	`GmailThread`	このスレッドを未読にします。
`moveToArchive()`	`GmailThread`	このスレッドをアーカイブに移動します。
`moveToInbox()`	`GmailThread`	このスレッドを受信トレイに移動します。
`moveToSpam()`	`GmailThread`	このスレッドを迷惑メールに移動します。
`moveToTrash()`	`GmailThread`	このスレッドをゴミ箱に移動します。
`refresh()`	`GmailThread`	このスレッドと関連する状態を Gmail から再読み込みします（ラベルや既読状態などが変更された場合に便利です）。
`removeLabel(label)`	`GmailThread`	スレッドからこのラベルを削除します。
`reply(body)`	`GmailThread`	replyTo アドレスを使用して、このスレッドの最後のメッセージの送信者に返信します。
`reply(body, options)`	`GmailThread`	このスレッドの最後のメッセージの送信者に、replyTo アドレスを使用して返信します（引数は省略可）。
`replyAll(body)`	`GmailThread`	送信者（replyTo アドレスを使用）と、このスレッドの最後のメッセージのすべての受信者に返信します。
`replyAll(body, options)`	`GmailThread`	このスレッドの最後のメッセージの送信者（`replyTo` アドレスを使用）とすべての受信者に、オプションの引数を指定して返信します。

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

クラス

GmailApp

メソッド

GmailAttachment

メソッド

GmailDraft

メソッド

GmailLabel

メソッド

GmailMessage

メソッド

GmailThread

メソッド

Gmail Service

`GmailApp`

`GmailAttachment`

`GmailDraft`

`GmailLabel`

`GmailMessage`

`GmailThread`