इस दस्तावेज़ में, Gmail API का इस्तेमाल करके मैसेज खोजने और उनसे जुड़ी क्वेरी करने का तरीका बताया गया है.
messages.list और threads.list तरीकों का इस्तेमाल करके, फ़ाइलें खोजी या फ़िल्टर की जा सकती हैं. इन तरीकों में q क्वेरी पैरामीटर का इस्तेमाल किया जा सकता है. इसमें Gmail के वेब इंटरफ़ेस की तरह ही, ज़्यादातर ऐडवांस खोज के सिंटैक्स का इस्तेमाल किया जा सकता है. Gmail के यूज़र इंटरफ़ेस (यूआई) और Gmail API में खोज और फ़िल्टर करने से जुड़े अंतर की सूची देखने के लिए, Gmail के यूज़र इंटरफ़ेस (यूआई) से अंतर लेख पढ़ें.
ऐडवांस खोज के इस सिंटैक्स की मदद से, क्वेरी का इस्तेमाल करके मैसेज को फ़िल्टर किया जा सकता है. इसके लिए, भेजने वाले का नाम, तारीख या लेबल जैसी प्रॉपर्टी का इस्तेमाल किया जा सकता है. उदाहरण के लिए, यहां दी गई messages.list तरीके की क्वेरी, जनवरी 2014 में उपयोगकर्ता के भेजे गए सभी मैसेज वापस लाती है:
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 के यूज़र इंटरफ़ेस (यूआई) से अंतर
Gmail API, Gmail के यूज़र इंटरफ़ेस (यूआई) में इस्तेमाल किए जाने वाले ज़्यादातर ऐडवांस खोज सिंटैक्स के साथ काम करता है. हालांकि, इनमें कुछ अंतर हैं:
Gmail का यूज़र इंटरफ़ेस (यूआई), एलियास एक्सपैंशन करता है. इससे वह Google Workspace खाते से किसी खाते के एलियास का पता लगा पाता है. उदाहरण के लिए, मान लें कि आपके पास
myprimary@cymbalgroup.comका खाता है और आपके एडमिन नेmyprimary@cymbalgroup.comके उस खाते के लिए कोई उपनाम सेट अप किया है.myalias@cymbalgroup.comअगरmyalias@cymbalgroup.comकोई ईमेल भेजता है, लेकिन आपने "from: myprimary@cymbalgroup.com" खोजा है, तोmyalias@cymbalgroup.comसे भेजा गया ईमेल, Gmail के यूज़र इंटरफ़ेस (यूआई) में खोज के नतीजों में दिखता है. हालांकि, यह एपीआई रिस्पॉन्स में नहीं दिखता.Gmail के यूज़र इंटरफ़ेस (यूआई) की मदद से, उपयोगकर्ता थ्रेड में मौजूद सभी ईमेल खोज सकते हैं. हालांकि, एपीआई में यह सुविधा उपलब्ध नहीं है.