このページは 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 と C をカンマ区切りで取得します。
`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`	返信先アドレスを使用して、このスレッドの最後のメッセージの送信者に返信します。
`reply(body, options)`	`GmailThread`	返信先アドレス（この引数は省略可）を使用して、このスレッドの最後のメッセージの送信者に返信します。
`replyAll(body)`	`GmailThread`	送信者（replyTo アドレスを使用）と、このスレッドの最後のメッセージの受信者に返信します。
`replyAll(body, options)`	`GmailThread`	送信者（`replyTo` アドレスを使用）と、このスレッドの最後のメッセージの受信者全員に返信し、オプションの引数を指定します。