این سند نحوه پرس و جو و یافتن پیامها با استفاده از Gmail API را توضیح میدهد.
شما میتوانید با استفاده از متدهای messages.list و threads.list فایلها را جستجو یا فیلتر کنید. این متدها پارامتر کوئری q را میپذیرند که از اکثر سینتکسهای جستجوی پیشرفته مشابه رابط وب Gmail پشتیبانی میکند. برای مشاهدهی فهرستی از تفاوتهای جستجو و فیلتر بین رابط کاربری Gmail و رابط برنامهنویسی کاربردی Gmail، به بخش تفاوتها از رابط کاربری Gmail مراجعه کنید.
این سینتکس جستجوی پیشرفته به شما امکان میدهد از کوئریها برای فیلتر کردن پیامها بر اساس ویژگیهایی مانند فرستنده، تاریخ یا برچسب استفاده کنید. برای مثال، کوئری متد messages.list زیر تمام پیامهای ارسال شده توسط کاربر در ژانویه ۲۰۱۴ را بازیابی میکند:
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 مراجعه کنید. برای اطلاعات بیشتر در مورد برچسبها، به مدیریت برچسبها مراجعه کنید.
تفاوتها با رابط کاربری جیمیل
اگرچه رابط برنامهنویسی کاربردی (API) جیمیل از اکثر سینتکسهای جستجوی پیشرفته مورد استفاده در رابط کاربری جیمیل پشتیبانی میکند، اما چند تفاوت وجود دارد:
رابط کاربری جیمیل عملیات بسط نام مستعار را انجام میدهد که به آن اجازه میدهد نام مستعار یک حساب را از یک حساب Google Workspace استنباط کند. برای مثال، فرض کنید شما یک حساب کاربری
myprimary@cymbalgroup.comدارید و مدیر شما یک نام مستعار برای آن حساب کاربریmyalias@cymbalgroup.comتنظیم میکند. اگرmyalias@cymbalgroup.comایمیلی ارسال کند، اما شما عبارت "from: myprimary@cymbalgroup.com" را جستجو کنید، ایمیل ارسال شده توسطmyalias@cymbalgroup.comدر نتایج جستجو در رابط کاربری جیمیل ظاهر میشود، اما در پاسخ API ظاهر نمیشود.رابط کاربری جیمیل به کاربران اجازه میدهد جستجوهایی در سطح کل رشته انجام دهند، اما API این امکان را ندارد.