messages.list
メソッドと threads.list
メソッドを使用して、ファイルを検索またはフィルタリングできます。これらのメソッドは、Gmail ウェブ インターフェースとほぼ同じ検索オプション構文をサポートする q
パラメータを受け入れます。Gmail UI と Gmail API の検索フィルタの違いについては、検索フィルタの違い: Gmail UI と Gmail API をご覧ください。
この高度な構文を使用すると、検索クエリを使用して送信者、日付、ラベルなどのプロパティでメッセージをフィルタリングし、いくつかの可能性を示すことができます。たとえば、次のクエリは、2014 年 1 月にユーザーが送信したすべてのメッセージを取得します。
GET https://www.googleapis.com/gmail/v1/users/me/messages?q=in:sent after:2014/01/01 before:2014/02/01
検索クエリに加え、labelIds
パラメータを使用して、メッセージとスレッドをラベルでフィルタすることもできます。これにより、指定したシステムラベルまたはユーザーラベルが適用されたメッセージとスレッドを検索できます。詳細については、messages.list
または threads.list
メソッド リファレンスをご覧ください。
検索とフィルタの違い: Gmail UI と Gmail API
Gmail UI ではエイリアス拡張が実行され、Google Workspace アカウントからアカウント エイリアスを推測できます。たとえば、
myprimary@mycompany.net
というアカウントがあり、管理者がそのアカウントにmyalias@mycompany.net
のエイリアスを設定したとします。myalias@mycompany.net
がメールを送信する際に「from: myprimary@mycompany.net)
」を検索すると、myalias@mycompany.net
から送信されたメールが Gmail の UI には検索結果として表示されますが、API レスポンスには表示されなくなります。Gmail UI ではスレッド全体の検索が行えますが、API ではできません。