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

Gmail Service

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

クラス

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

`GmailApp`

Methods

メソッド	戻り値の型	概要
`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`

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 ファイル（スプレッドシート、ドキュメントなど）かどうかを返します。
`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`

Methods

メソッド	戻り値の型	概要
`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`

Methods

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

`GmailMessage`

Methods

メソッド	戻り値の型	概要
`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`

Methods

メソッド	戻り値の型	概要
`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`	rememberTo アドレスを使用して、このスレッドの最後のメッセージの送信者に返信します。
`reply(body, options)`	`GmailThread`	rememberTo アドレスとオプションの引数を使用して、このスレッドの最後のメッセージの送信者に返信します。
`replyAll(body)`	`GmailThread`	送信者（ReplyTo アドレスを使用して）と、このスレッドの最後のメッセージのすべての受信者に返信します。
`replyAll(body, options)`	`GmailThread`	送信者（`replyTo` アドレスを使用）と、このスレッドの最後のメッセージのすべての受信者に返信し、オプションの引数を指定します。