messages.list
メソッドと threads.list
メソッドを使用して、ファイルを検索またはフィルタできます。これらのメソッドでは q
パラメータを使用できます。このパラメータは、Gmail ウェブ インターフェースとほぼ同じ検索オプション構文をサポートしています。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 ではできません。