GAS（Google Apps Script）はさまざまなGoogleサービスと連携でき、多くの作業を自動化できます。しかし、実際に実装しようと思うと、どのような「クラス(class)」や「関数(function)」、「メソッド(method)」が用意されているのか分からず、苦戦している人も多いのではないでしょうか？
そこで今回は、「Gmailで使えるGASの関数一覧」というテーマで、Gmailを操作するための便利なメソッドを紹介します。各メソッドの具体的な使用方法とコードの例を交えて、わかりやすく解説していきます。
GmailAppクラス
createDraftメソッド
メールの下書きを作成するためには、createDraftメソッドを使用します。このメソッドは、宛先、件名、本文などを引数に取り、新しいメールの下書きを作成することができます。
// 下書きを作成する例
var draft = GmailApp.createDraft('recipient@example.com', '下書きの件名', 'ここに本文を記入');getThreadメソッド
スレッドオブジェクトを取得するには、getThreadメソッドを利用します。このメソッドを使用することで、特定のメールスレッドにアクセスし、そのスレッド内のメッセージに対してさまざまな操作を行うことができます。
// スレッドオブジェクトを取得する例
var thread = GmailApp.getThreadById(threadId);getMessagesForThreadsメソッド
メッセージをスレッドごとに配列として取得するには、getMessagesForThreadsメソッドを使用します。このメソッドは、複数のスレッドを一度に処理し、それぞれのスレッドに含まれるメッセージのリストを取得できます。
// スレッドごとのメッセージを取得する例
var threads = GmailApp.getInboxThreads(0, 10); // 最初の10スレッドを取得
var messages = GmailApp.getMessagesForThreads(threads);moveThreadsToArchiveメソッド
スレッドをアーカイブするには、moveThreadsToArchiveメソッドを使用します。このメソッドにより、不要になったメールスレッドを受信トレイからアーカイブに移動させることができます。
// スレッドをアーカイブする例
var threads = GmailApp.getInboxThreads(0, 1); // 最初のスレッドを取得
GmailApp.moveThreadsToArchive(threads);searchメソッド
メールを検索するには、searchメソッドを使用します。このメソッドを利用することで、特定の条件に一致するメールスレッドを検索し、取得することができます。
// 特定の条件でメールを検索する例
var threads = GmailApp.search('from:example@example.com');sendEmailメソッド
メールを送信するには、sendEmailメソッドを利用します。このメソッドは、宛先、件名、本文を指定してメールを送信することができます。
// メールを送信する例
GmailApp.sendEmail('recipient@example.com', '件名', 'ここに本文を記入');GmailThreadクラス
getPermalinkメソッド
スレッドのパーマリンクを取得するには、getPermalinkメソッドを使用します。このメソッドにより、スレッドに直接アクセスするためのURLを取得することができます。
// スレッドのパーマリンクを取得する例
var thread = GmailApp.getInboxThreads(0, 1)[0]; // 最初のスレッドを取得
var permalink = thread.getPermalink();GmailMessageクラス
getAttachmentsメソッド
メールの添付ファイルをすべて取得するには、getAttachmentsメソッドを利用します。このメソッドを使用することで、メッセージに添付されているすべてのファイルを配列として取得することができます。
// メールの添付ファイルを取得する例
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; // 最初のメッセージを取得
var attachments = message.getAttachments();getDateメソッド
メールの送信日を取得するには、getDateメソッドを使用します。このメソッドにより、メッセージの送信日時をDateオブジェクトとして取得することができます。
// メールの送信日を取得する例
var sendDate = message.getDate();getFromメソッド
メールの送信元を取得するためには、getFromメソッドを利用します。このメソッドにより、メッセージの送信元アドレスを文字列として取得することができます。
// メールの送信元を取得する例
var sender = message.getFrom();以上で、「Gmailで使えるGASの関数一覧」というテーマでの解説を終わります。これらのメソッドを使いこなすことで、Gmailの操作を自動化し、日々の業務を効率化することが可能です。GASを活用して、さまざまな作業を自動化してみましょう。