Gmail API

Gmail API की मदद से, Gmail मेलबॉक्स का डेटा देखा और मैनेज किया जा सकता है. जैसे, थ्रेड, मैसेज, और लेबल.

Service: gmail.googleapis.com

इस सेवा को कॉल करने के लिए, हमारा सुझाव है कि आप Google की ओर से उपलब्ध कराई गई क्लाइंट लाइब्रेरी का इस्तेमाल करें. अगर आपके ऐप्लिकेशन को इस सेवा को कॉल करने के लिए, अपनी लाइब्रेरी का इस्तेमाल करना है, तो एपीआई अनुरोध करते समय यहां दी गई जानकारी का इस्तेमाल करें.

डिस्कवरी दस्तावेज़

जानकारी देने वाला दस्तावेज़, मशीन से पढ़े जा सकने वाले फ़ॉर्मैट में होता है. इसमें REST API के बारे में जानकारी दी जाती है और उन्हें इस्तेमाल करने का तरीका बताया जाता है. इसका इस्तेमाल क्लाइंट लाइब्रेरी, आईडीई प्लगिन, और Google API के साथ इंटरैक्ट करने वाले अन्य टूल बनाने के लिए किया जाता है. एक सेवा, एपीआई के बारे में ज़रूरी जानकारी देने वाले कई दस्तावेज़ उपलब्ध करा सकती है. यह सेवा इन एपीआई के बारे में ज़रूरी जानकारी देने वाला दस्तावेज़ उपलब्ध कराती है:

सेवा का एंडपॉइंट

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

  • https://gmail.googleapis.com

REST रिसॉर्स: v1.users

तरीके
getProfile GET /gmail/v1/users/{userId}/profile
इससे मौजूदा उपयोगकर्ता की Gmail प्रोफ़ाइल मिलती है.
stop POST /gmail/v1/users/{userId}/stop
इस कमांड से, किसी उपयोगकर्ता के मेलबॉक्स के लिए पुश नोटिफ़िकेशन पाने की सुविधा बंद हो जाती है.
watch POST /gmail/v1/users/{userId}/watch
दिए गए उपयोगकर्ता के मेलबॉक्स पर पुश नोटिफ़िकेशन की सुविधा सेट अप या अपडेट करें.

REST रिसॉर्स: v1.users.drafts

तरीके
create POST /gmail/v1/users/{userId}/drafts
POST /upload/gmail/v1/users/{userId}/drafts
इससे DRAFT लेबल वाला ड्राफ़्ट बनता है.
delete DELETE /gmail/v1/users/{userId}/drafts/{id}
यह कमांड, चुने गए ड्राफ़्ट को तुरंत और हमेशा के लिए मिटा देती है.
get GET /gmail/v1/users/{userId}/drafts/{id}
इससे तय किया गया ड्राफ़्ट मिलता है.
list GET /gmail/v1/users/{userId}/drafts
इससे उपयोगकर्ता के मेलबॉक्स में मौजूद ड्राफ़्ट की सूची दिखती है.
send POST /gmail/v1/users/{userId}/drafts/send
POST /upload/gmail/v1/users/{userId}/drafts/send
यह To, Cc, और Bcc हेडर में मौजूद लोगों को, तय किया गया मौजूदा ड्राफ़्ट भेजता है.
update PUT /gmail/v1/users/{userId}/drafts/{id}
PUT /upload/gmail/v1/users/{userId}/drafts/{id}
ड्राफ़्ट के कॉन्टेंट को बदलता है.

REST रिसॉर्स: v1.users.history

तरीके
list GET /gmail/v1/users/{userId}/history
इससे दिए गए मेलबॉक्स में किए गए सभी बदलावों का इतिहास दिखता है.

REST रिसॉर्स: v1.users.labels

तरीके
create POST /gmail/v1/users/{userId}/labels
इससे एक लेबल बनाया जाता है.
delete DELETE /gmail/v1/users/{userId}/labels/{id}
यह विकल्प, चुने गए लेबल को तुरंत और हमेशा के लिए मिटा देता है. साथ ही, इसे उन सभी मैसेज और थ्रेड से हटा देता है जिन पर यह लागू किया गया है.
get GET /gmail/v1/users/{userId}/labels/{id}
इससे तय किया गया लेबल मिलता है.
list GET /gmail/v1/users/{userId}/labels
इससे उपयोगकर्ता के मेलबॉक्स में मौजूद सभी लेबल की सूची मिलती है.
patch PATCH /gmail/v1/users/{userId}/labels/{id}
बताए गए लेबल में बदलाव करें.
update PUT /gmail/v1/users/{userId}/labels/{id}
यह फ़ंक्शन, तय किए गए लेबल को अपडेट करता है.

REST रिसॉर्स: v1.users.messages

तरीके
batchDelete POST /gmail/v1/users/{userId}/messages/batchDelete
यह मैसेज आईडी के हिसाब से कई मैसेज मिटाता है.
batchModify POST /gmail/v1/users/{userId}/messages/batchModify
इससे चुने गए मैसेज के लेबल में बदलाव होता है.
delete DELETE /gmail/v1/users/{userId}/messages/{id}
यह विकल्प, चुने गए मैसेज को तुरंत और हमेशा के लिए मिटा देता है.
get GET /gmail/v1/users/{userId}/messages/{id}
इससे तय किया गया मैसेज मिलता है.
import POST /gmail/v1/users/{userId}/messages/import
POST /upload/gmail/v1/users/{userId}/messages/import
यह मैसेज को सिर्फ़ इस उपयोगकर्ता के मेलबॉक्स में इंपोर्ट करता है. इसमें ईमेल डिलीवरी के लिए स्टैंडर्ड स्कैनिंग और क्लासिफ़िकेशन की सुविधा मिलती है. यह सुविधा, एसएमटीपी के ज़रिए ईमेल पाने की सुविधा की तरह ही होती है.
insert POST /gmail/v1/users/{userId}/messages
POST /upload/gmail/v1/users/{userId}/messages
यह सिर्फ़ इस उपयोगकर्ता के मेलबॉक्स में सीधे तौर पर मैसेज डालता है. यह IMAP APPEND की तरह काम करता है. इसमें ज़्यादातर स्कैनिंग और क्लासिफ़िकेशन को अनदेखा किया जाता है.
list GET /gmail/v1/users/{userId}/messages
इससे उपयोगकर्ता के मेलबॉक्स में मौजूद मैसेज की सूची दिखती है.
modify POST /gmail/v1/users/{userId}/messages/{id}/modify
इससे चुने गए मैसेज के लेबल में बदलाव किया जाता है.
send POST /gmail/v1/users/{userId}/messages/send
POST /upload/gmail/v1/users/{userId}/messages/send
यह कमांड, To, Cc, और Bcc हेडर में मौजूद लोगों को चुना गया मैसेज भेजती है.
trash POST /gmail/v1/users/{userId}/messages/{id}/trash
इस कमांड से, चुने गए मैसेज को ट्रैश में ले जाया जाता है.
untrash POST /gmail/v1/users/{userId}/messages/{id}/untrash
यह विकल्प, ट्रैश से चुने गए मैसेज को हटाता है.

REST रिसॉर्स: v1.users.messages.attachments

तरीके
get GET /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id}
इससे मैसेज का चुना गया अटैचमेंट मिलता है.

REST रिसॉर्स: v1.users.settings

तरीके
getAutoForwarding GET /gmail/v1/users/{userId}/settings/autoForwarding
इससे चुने गए खाते के लिए, ईमेल अपने-आप फ़ॉरवर्ड होने की सेटिंग मिलती है.
getImap GET /gmail/v1/users/{userId}/settings/imap
आईएमएपी सेटिंग मिलती हैं.
getLanguage GET /gmail/v1/users/{userId}/settings/language
भाषा की सेटिंग मिलती हैं.
getPop GET /gmail/v1/users/{userId}/settings/pop
इससे पीओपी सेटिंग मिलती हैं.
getVacation GET /gmail/v1/users/{userId}/settings/vacation
छुट्टी के दौरान ऑटोमैटिक रिप्लाई देने की सुविधा की सेटिंग मिलती हैं.
updateAutoForwarding PUT /gmail/v1/users/{userId}/settings/autoForwarding
यह कमांड, चुने गए खाते के लिए ईमेल अपने-आप फ़ॉरवर्ड होने की सेटिंग को अपडेट करती है.
updateImap PUT /gmail/v1/users/{userId}/settings/imap
आईएमएपी सेटिंग अपडेट करता है.
updateLanguage PUT /gmail/v1/users/{userId}/settings/language
भाषा की सेटिंग अपडेट करता है.
updatePop PUT /gmail/v1/users/{userId}/settings/pop
पीओपी सेटिंग अपडेट करता है.
updateVacation PUT /gmail/v1/users/{userId}/settings/vacation
छुट्टी के दौरान ऑटोमैटिक रिप्लाई देने की सुविधा की सेटिंग अपडेट करता है.

REST रिसॉर्स: v1.users.settings.cse.identities

तरीके
create POST /gmail/v1/users/{userId}/settings/cse/identities
यह कुकी, क्लाइंट-साइड एन्क्रिप्शन की ऐसी आइडेंटिटी बनाती और कॉन्फ़िगर करती है जिसे उपयोगकर्ता खाते से ईमेल भेजने की अनुमति मिली होती है.
delete DELETE /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
क्लाइंट-साइड एन्क्रिप्शन की पहचान मिटाता है.
get GET /gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
क्लाइंट-साइड एन्क्रिप्शन के आइडेंटिटी कॉन्फ़िगरेशन को वापस पाता है.
list GET /gmail/v1/users/{userId}/settings/cse/identities
यह कुकी, पुष्टि किए गए उपयोगकर्ता के लिए क्लाइंट-साइड पर एन्क्रिप्ट की गई पहचानों की सूची दिखाती है.
patch PATCH /gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
यह मौजूदा क्लाइंट-साइड एन्क्रिप्शन आइडेंटिटी के साथ, किसी दूसरे कुंजी जोड़े को जोड़ता है.

REST रिसॉर्स: v1.users.settings.cse.keypairs

तरीके
create POST /gmail/v1/users/{userId}/settings/cse/keypairs
यह पुष्टि किए गए उपयोगकर्ता के लिए, क्लाइंट-साइड एन्क्रिप्शन एस/एमआईएमई सार्वजनिक पासकोड सर्टिफ़िकेट चेन और निजी पासकोड मेटाडेटा बनाता है और उसे अपलोड करता है.
disable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
क्लाइंट-साइड एन्क्रिप्शन की कुंजियों के जोड़े को बंद करता है.
enable POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
क्लाइंट-साइड एन्क्रिप्शन की उस कुंजी के जोड़े को चालू करता है जिसे बंद कर दिया गया था.
get GET /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
क्लाइंट-साइड एन्क्रिप्शन की मौजूदा कुंजियों के जोड़े को वापस लाता है.
list GET /gmail/v1/users/{userId}/settings/cse/keypairs
यह पुष्टि किए गए उपयोगकर्ता के लिए, क्लाइंट-साइड एन्क्रिप्शन की कुंजियों के जोड़े दिखाता है.
obliterate POST /gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
यह क्लाइंट-साइड एन्क्रिप्शन की कुंजियों के जोड़े को हमेशा के लिए और तुरंत मिटा देता है.

REST रिसॉर्स: v1.users.settings.delegates

तरीके
create POST /gmail/v1/users/{userId}/settings/delegates
यह विकल्प, पुष्टि करने वाला कोई प्रतिनिधि जोड़ता है. इसके लिए, पुष्टि की स्थिति को सीधे तौर पर accepted पर सेट किया जाता है. साथ ही, पुष्टि करने वाला कोई ईमेल नहीं भेजा जाता.
delete DELETE /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
यह विकल्प, चुने गए डेलिगेट (जिसकी पुष्टि किसी भी स्थिति में हो सकती है) को हटा देता है. साथ ही, पुष्टि करने की उस प्रक्रिया को भी रद्द कर देता है जो डेलिगेट के तौर पर काम करने के लिए ज़रूरी हो सकती है.
get GET /gmail/v1/users/{userId}/settings/delegates/{delegateEmail}
इससे, चुने गए डेलिगेट की जानकारी मिलती है.
list GET /gmail/v1/users/{userId}/settings/delegates
यह कमांड, चुने गए खाते के लिए उन लोगों की सूची दिखाती है जिन्हें ऐक्सेस दिया गया है.

REST रिसॉर्स: v1.users.settings.filters

तरीके
create POST /gmail/v1/users/{userId}/settings/filters
इससे फ़िल्टर बनाया जाता है.
delete DELETE /gmail/v1/users/{userId}/settings/filters/{id}
यह विकल्प, चुने गए फ़िल्टर को तुरंत और हमेशा के लिए मिटा देता है.
get GET /gmail/v1/users/{userId}/settings/filters/{id}
इससे फ़िल्टर मिलता है.
list GET /gmail/v1/users/{userId}/settings/filters
इससे Gmail का इस्तेमाल करने वाले व्यक्ति के मैसेज फ़िल्टर की सूची मिलती है.

REST रिसॉर्स: v1.users.settings.forwardingAddresses

तरीके
create POST /gmail/v1/users/{userId}/settings/forwardingAddresses
इससे फ़ॉरवर्ड करने का पता बनाया जाता है.
delete DELETE /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
इससे, फ़ॉरवर्ड करने के लिए दिया गया पता मिट जाता है. साथ ही, पुष्टि करने की ज़रूरत को भी रद्द कर दिया जाता है.
get GET /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail}
इससे फ़ॉरवर्ड करने के लिए तय किया गया पता मिलता है.
list GET /gmail/v1/users/{userId}/settings/forwardingAddresses
इससे चुने गए खाते के लिए, ईमेल फ़ॉरवर्ड करने के पतों की सूची मिलती है.

REST रिसॉर्स: v1.users.settings.sendAs

तरीके
create POST /gmail/v1/users/{userId}/settings/sendAs
यह "भेजने वाला" फ़ील्ड के लिए, पसंद के मुताबिक कोई उपनाम बनाता है.
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
यह कमांड, 'इस पते से भेजें' सुविधा के लिए सेट किए गए किसी उपनाम को मिटाती है.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
इससे, भेजे गए ईमेल के लिए तय किया गया उपनाम मिलता है.
list GET /gmail/v1/users/{userId}/settings/sendAs
यह कमांड, चुने गए खाते के लिए, 'इस पते से भेजें' सुविधा के तहत इस्तेमाल किए जाने वाले ईमेल पतों की सूची दिखाती है.
patch PATCH /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
भेजने के लिए इस्तेमाल किए जाने वाले तय किए गए उपनाम को पैच करता है.
update PUT /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}
यह विकल्प, 'इस पते से भेजें' के तौर पर इस्तेमाल किए जाने वाले ईमेल पते को अपडेट करता है.
verify POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify
यह विकल्प चुनने पर, 'इस पते से भेजें' के तौर पर इस्तेमाल किए जाने वाले ईमेल पते पर पुष्टि करने के लिए ईमेल भेजा जाता है.

REST रिसॉर्स: v1.users.settings.sendAs.smimeInfo

तरीके
delete DELETE /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
यह सेटिंग, 'इस पते से भेजें' सुविधा के लिए कॉन्फ़िगर किए गए S/MIME कॉन्फ़िगरेशन को मिटा देती है.
get GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}
यह फ़ंक्शन, 'इस पते से भेजें' सुविधा के लिए तय किए गए उपनाम के लिए, तय किया गया एस/एमआईएमई कॉन्फ़िगरेशन पाता है.
insert POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
'इसके तौर पर भेजें' सुविधा के लिए दिए गए S/MIME कॉन्फ़िगरेशन को डालें (अपलोड करें).
list GET /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo
यह कमांड, 'इस पते से ईमेल भेजें' सुविधा के लिए तय किए गए उपनाम के लिए, S/MIME कॉन्फ़िगरेशन की सूची दिखाती है.
setDefault POST /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault
यह सेटिंग, 'इस पते से भेजें' सुविधा के लिए चुने गए ईमेल पते के लिए, डिफ़ॉल्ट एस/एमआईएमई कॉन्फ़िगरेशन सेट करती है.

REST रिसॉर्स: v1.users.threads

तरीके
delete DELETE /gmail/v1/users/{userId}/threads/{id}
यह विकल्प, चुनी गई थ्रेड को तुरंत और हमेशा के लिए मिटा देता है.
get GET /gmail/v1/users/{userId}/threads/{id}
इससे तय की गई थ्रेड मिलती है.
list GET /gmail/v1/users/{userId}/threads
इससे उपयोगकर्ता के मेलबॉक्स में मौजूद थ्रेड की सूची मिलती है.
modify POST /gmail/v1/users/{userId}/threads/{id}/modify
इस थ्रेड पर लागू किए गए लेबल में बदलाव करता है.
trash POST /gmail/v1/users/{userId}/threads/{id}/trash
इस थ्रेड को ट्रैश में ले जाता है.
untrash POST /gmail/v1/users/{userId}/threads/{id}/untrash
यह फ़ंक्शन, ट्रैश से चुनी गई थ्रेड को हटाता है.