आईएमएपी एक्सटेंशन

इस दस्तावेज़ में, Gmail के ज़रिए दिए गए आईएमएपी एक्सटेंशन के बारे में बताया गया है. साथ ही, यह भी बताया गया है कि डेवलपर इनका इस्तेमाल कैसे कर सकते हैं. इस दस्तावेज़ में यह माना गया है कि आपको आईएमएपी प्रोटोकॉल के बारे में जानकारी है.

खास जानकारी

Gmail, आईएमएपी एक्सटेंशन का एक सेट उपलब्ध कराता है. इससे आईएमएपी क्लाइंट के डेवलपर, आईएमएपी के ज़रिए Gmail जैसा अनुभव दे पाते हैं. जो डेवलपर अपने वेब या मोबाइल ऐप्लिकेशन में Gmail की सुविधाओं को इंटिग्रेट करना चाहते हैं वे RESTful Gmail API का इस्तेमाल कर सकते हैं.

स्टैंडर्ड आईएमएपी प्रोटोकॉल के ज़रिए Gmail को ऐक्सेस करते समय या OAuth से कनेक्ट करते समय, एक्सटेंशन का इस्तेमाल किया जा सकता है.

एक्सटेंशन की मौजूदगी की जांच करना

Gmail, CAPABILITY कमांड के जवाब में, एक्सटेंशन के साथ काम करने की सुविधा का विज्ञापन करता है. इस दस्तावेज़ में एक्सटेंशन के साथ काम करने की सुविधाओं की सूची में X-GM-EXT-1 मौजूद होने का मतलब है कि एक्सटेंशन काम करेंगे.

क्लाइंट को IMAP आईडी कमांड (RFC 2971) का इस्तेमाल करके, अपने बारे में जानकारी देने का सुझाव दिया जाता है. साथ ही, इन एक्सटेंशन में बदलाव करने की ज़रूरत पड़ने पर, फ़ॉलबैक के तौर पर संपर्क पता शामिल करें.

यहां Gmail के आईएमएपी एंडपॉइंट पर, हैंडशेक और CAPABILITY कमांड के इस्तेमाल का उदाहरण दिया गया है:

* OK Gimap ready for requests from 127.0.0.1 k2if6111336rvb.0
a001 LOGIN username@gmail.com password
a001 OK username@gmail.com authenticated (Success)
a001 OK Login successful
a002 CAPABILITY
* CAPABILITY IMAP4rev1 UNSELECT LITERAL+ IDLE NAMESPACE QUOTA ID XLIST CHILDREN X-GM-EXT-1
a002 OK Success
a003 ID ("name" "clientname" "version" "1.2.3" "vendor" "companyname" "contact" "foo@example.com")
* ID ("name" "GImap" "vendor" "Google, Inc." "support-url" "http://mail.google.com/support" "remote-host" "127.0.0.1")
a003 OK Success

LIST कमांड का खास इस्तेमाल वाला एक्सटेंशन

Gmail में खास तौर पर इस्तेमाल किए जाने वाले मेलबॉक्स के लिए आईएमएपी सूची एक्सटेंशन काम करता है. इससे खास फ़ोल्डर के लिए नए एट्रिब्यूट मिलते हैं. इन एट्रिब्यूट की मदद से, क्लाइंट को यह पता चलता है कि कौनसे फ़ोल्डर खास हैं. जैसे, \All). खास फ़ोल्डर की मौजूदा सूची में ये शामिल हैं: स्टार के निशान वाले, ज़रूरी, भेजे गए आइटम, ड्राफ़्ट, स्पैम, सभी ईमेल, और ट्रैश. सभी LIST जवाबों में, खास तौर पर इस्तेमाल किए जाने वाले ये एट्रिब्यूट शामिल होते हैं. यह कोई नया CAPABILITY नहीं है या ऐसा कुछ नहीं है जिसे क्लाइंट को ENABLEd करना ज़रूरी है.

LIST को किए गए कॉल की ट्रांसक्रिप्ट का उदाहरण यहां दिया गया है:

a004 LIST "" "*"
* LIST (\HasNoChildren) "/" "INBOX"
* LIST (\Noselect \HasChildren) "/" "[Gmail]"
* LIST (\HasNoChildren \All) "/" "[Gmail]/All Mail"
* LIST (\HasNoChildren \Drafts) "/" "[Gmail]/Drafts"
* LIST (\HasNoChildren \Important) "/" "[Gmail]/Important"
* LIST (\HasNoChildren \Sent) "/" "[Gmail]/Sent Mail"
* LIST (\HasNoChildren \Junk) "/" "[Gmail]/Spam"
* LIST (\HasNoChildren \Flagged) "/" "[Gmail]/Starred"
* LIST (\HasNoChildren \Trash) "/" "[Gmail]/Trash"
a004 OK Success

जवाब, खास तौर पर इस्तेमाल किए जाने वाले स्टैंडर्ड के मुताबिक है. इसमें Gmail के प्राथमिकता वाले इनबॉक्स (यानी "[Gmail]/Important") के लिए, एक अतिरिक्त \Important एट्रिब्यूट जोड़ा गया है.

XLIST का इस्तेमाल नहीं किया जा सकता

Gmail के लिए खास तौर पर बने XLIST कमांड को 2013 में बंद कर दिया गया था. इसकी जगह, आईएमएपी के लिए खास तौर पर बनी सूची का स्टैंडर्ड इस्तेमाल किया जा रहा है. हमारा सुझाव है कि क्लाइंट XLIST से, खास तौर पर इस्तेमाल किए जाने वाले इंडस्ट्री स्टैंडर्ड पर जल्द से जल्द माइग्रेट कर लें. ध्यान दें कि खास तौर पर इस्तेमाल किए जाने वाले स्टैंडर्ड एट्रिब्यूट के नाम, लेगसी XLIST एट्रिब्यूट के नामों से मिलते-जुलते हैं, लेकिन एक जैसे नहीं हैं.

SEARCH निर्देश का एक्सटेंशन: X-GM-RAW

Gmail के पूरे खोज सिंटैक्स का ऐक्सेस देने के लिए, Gmail X-GM-RAW खोज एट्रिब्यूट उपलब्ध कराता है. SEARCH या UID SEARCH निर्देशों को लागू करते समय, X-GM-RAW एट्रिब्यूट के साथ पास किए गए आर्ग्युमेंट का विश्लेषण, Gmail के वेब इंटरफ़ेस में किए गए विश्लेषण के तरीके से ही किया जाएगा.

X-GM-RAW एट्रिब्यूट का इस्तेमाल करके, SEARCH को किए गए कॉल की ट्रांसक्रिप्ट का उदाहरण यहां दिया गया है:

a005 SEARCH X-GM-RAW "has:attachment in:unread"
* SEARCH 123 12344 5992
a005 OK SEARCH (Success)

Gmail के यूनीक मैसेज आईडी का ऐक्सेस: X-GM-MSGID

Gmail हर ईमेल के लिए एक यूनीक मैसेज आईडी उपलब्ध कराता है, ताकि एक यूनीक मैसेज की पहचान कई फ़ोल्डर में की जा सके. इस मैसेज आईडी को वापस पाने के लिए, FETCH कमांड में X-GM-MSGID एट्रिब्यूट का इस्तेमाल किया जा सकता है. मैसेज आईडी, 64-बिट का बिना साइन वाला पूर्णांक होता है. यह वेब इंटरफ़ेस और Gmail API में इस्तेमाल की जाने वाली आईडी हेक्स स्ट्रिंग के बराबर होता है.

FETCH निर्देश की मदद से, किसी मैसेज का X-GM-MSGID फ़ील्ड वापस पाने के लिए, कॉल की ट्रांसक्रिप्ट का यह उदाहरण देखें:

a006 FETCH 1 (X-GM-MSGID)
* 1 FETCH (X-GM-MSGID 1278455344230334865)
a006 OK FETCH (Success)

X-GM-MSGID एट्रिब्यूट का इस्तेमाल, SEARCH या UID SEARCH निर्देशों में भी किया जा सकता है. इससे, Gmail के मैसेज आईडी वाले किसी मैसेज का क्रम संख्या या UID पता लगाया जा सकता है. यहां UID SEARCH कमांड का इस्तेमाल करके, किसी मैसेज का UID वापस पाने के लिए किए गए कॉल की ट्रांसक्रिप्ट का उदाहरण दिया गया है:

a007 UID SEARCH X-GM-MSGID 1278455344230334865
* SEARCH 1
a007 OK SEARCH (Success)

Gmail थ्रेड आईडी का ऐक्सेस: X-GM-THRID

Gmail, मैसेज के ग्रुप को उसी तरह से जोड़ने के लिए थ्रेड आईडी उपलब्ध कराता है जिस तरह से Gmail के वेब इंटरफ़ेस में किया जाता है. इस थ्रेड आईडी को वापस पाने के लिए, FETCH कमांड में X-GM-THRID एट्रिब्यूट का इस्तेमाल किया जा सकता है. थ्रेड आईडी, 64-बिट का बिना साइन वाला पूर्णांक होता है. यह वेब इंटरफ़ेस और Gmail API में इस्तेमाल की जाने वाली आईडी हेक्स स्ट्रिंग के बराबर होता है.

यहां FETCH कमांड की मदद से, दो थ्रेड में मौजूद कई मैसेज के X-GM-THRID को वापस पाने के लिए, कॉल की ट्रांसक्रिप्ट का उदाहरण दिया गया है:

a008 FETCH 1:4 (X-GM-THRID)
* 1 FETCH (X-GM-THRID 1278455344230334865)
* 2 FETCH (X-GM-THRID 1266894439832287888)
* 3 FETCH (X-GM-THRID 1266894439832287888)
* 4 FETCH (X-GM-THRID 1266894439832287888)
a008 OK FETCH (Success)

X-GM-THRID एट्रिब्यूट का इस्तेमाल, SEARCH या UID SEARCH निर्देशों में भी किया जा सकता है. इससे किसी थ्रेड में मैसेज के क्रम के नंबर या UID ढूंढे जा सकते हैं. यहां UID SEARCH कमांड का इस्तेमाल करके, कई मैसेज के UID वापस पाने के लिए, कॉल की ट्रांसक्रिप्ट का उदाहरण दिया गया है:

a009 UID SEARCH X-GM-THRID 1266894439832287888
* SEARCH 2 3 4
a009 OK Search (Success)

Gmail लेबल का ऐक्सेस: X-GM-LABELS

Gmail, आईएमएपी के लिए लेबल को फ़ोल्डर के तौर पर इस्तेमाल करता है. इसलिए, फ़ोल्डर पर काम करने वाले स्टैंडर्ड आईएमएपी निर्देशों, CREATE, RENAME, और DELETE का इस्तेमाल करके, लेबल में बदलाव किया जा सकता है. सिस्टम लेबल, Gmail के बनाए गए लेबल होते हैं. ये लेबल, लेबल की सूची में "[Gmail]" या "[GoogleMail]" से शुरू होते हैं और ये लेबल रिज़र्व होते हैं. किसी मेलबॉक्स के लेबल की पूरी सूची पाने के लिए, XLIST निर्देश का इस्तेमाल करें.

किसी मैसेज के लेबल, FETCH कमांड के साथ X-GM-LABELS एट्रिब्यूट का इस्तेमाल करके वापस पाए जा सकते हैं. यह एट्रिब्यूट, ASTRING की सूची के तौर पर दिखाया जाता है. इसे ज़रूरत के मुताबिक UTF-7 में एन्कोड किया जाता है. आरएफ़सी के मुताबिक, ASTRING एक एटम या स्ट्रिंग है.

यहां FETCH कमांड की मदद से, कई मैसेज के X-GM-LABELS को वापस पाने के लिए किए गए कॉल की ट्रांसक्रिप्ट का उदाहरण दिया गया है:

a010 FETCH 1:4 (X-GM-LABELS)
* 1 FETCH (X-GM-LABELS (\Inbox \Sent Important "Muy Importante"))
* 2 FETCH (X-GM-LABELS (foo))
* 3 FETCH (X-GM-LABELS ())
* 4 FETCH (X-GM-LABELS (\Drafts))
a010 OK FETCH (Success)

X-GM-LABELS एट्रिब्यूट के साथ STORE कमांड का इस्तेमाल करके, मैसेज में लेबल जोड़े जा सकते हैं. यहां किसी मैसेज में लेबल जोड़ने की ट्रांसक्रिप्ट का उदाहरण दिया गया है:

a011 STORE 1 +X-GM-LABELS (foo)
* 1 FETCH (X-GM-LABELS (\Inbox \Sent Important "Muy Importante" foo))
a011 OK STORE (Success)

X-GM-LABELS एट्रिब्यूट का इस्तेमाल, SEARCH या UID SEARCH निर्देशों में भी किया जा सकता है. इससे, किसी लेबल वाले फ़ोल्डर में मौजूद सभी मैसेज के क्रम के नंबर या UID ढूंढे जा सकते हैं. यहां SEARCH कमांड का इस्तेमाल करके, कई मैसेज के क्रम के नंबर वापस पाने के लिए, कॉल की ट्रांसक्रिप्ट का उदाहरण दिया गया है:

a012 SEARCH X-GM-LABELS foo
* SEARCH 1 2
a012 OK SEARCH (Success)

रेफ़रंस