इस दस्तावेज़ की मदद से, अपने ऐप्लिकेशन को बंद किए जा चुके ईमेल सेटिंग एपीआई से Gmail API पर माइग्रेट किया जा सकता है.
अनुरोधों को अनुमति दें
Email Settings API की तरह, Gmail API भी अनुरोधों को अनुमति देने के लिए OAuth 2.0 प्रोटोकॉल का इस्तेमाल करता है. इन दोनों के बीच मुख्य अंतर यह है कि Gmail API की अनुमतियां, पूरे डोमेन के बजाय किसी एक उपयोगकर्ता के लिए तय की जाती हैं. इसका मतलब है कि डोमेन एडमिन खाते को अनुमति देने से, आपको डोमेन के अन्य उपयोगकर्ताओं के लिए ईमेल माइग्रेट करने की सुविधा नहीं मिलती. इसके बजाय, आपको डोमेन-वाइड अथॉरिटी वाले स्टैंडर्ड सेवा खातों का इस्तेमाल करना होगा. इन्हें Google Admin console में, अनुमति वाली सूची में जोड़ा जाता है, ताकि सही पुष्टि करने वाला टोकन जनरेट किया जा सके.
ईमेल सेटिंग वाले एपीआई ने इस स्कोप का इस्तेमाल किया:
https://apps-apis.google.com/a/feeds/emailsettings/2.0/
Gmail API में, मिलते-जुलते स्कोप ये हैं:
https://www.googleapis.com/auth/gmail.settings.basic
https://www.googleapis.com/auth/gmail.settings.sharing
प्रोटोकॉल में बदलाव
Email Settings API, एक्सएमएल पर आधारित GDATA प्रोटोकॉल का इस्तेमाल करता है. Gmail API, JSON का इस्तेमाल करता है. सेटिंग में ज़्यादातर मुख्य वैल्यू वाले जोड़े होते हैं. इसलिए, पेलोड कॉन्सेप्ट के हिसाब से वर्शन के बीच एक जैसे होते हैं.
लेबल बनाने का उदाहरण:
Email Settings API
POST https://apps-apis.google.com/a/feeds/emailsettings/2.0/{domain name}/{username}/label
<?xml version="1.0" encoding="utf-8"?>
<atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name="label" value="status updates" />
</atom:entry>
Gmail API
POST https://www.googleapis.com/gmail/v1/users/{username}/labels
{
"name": "status updates"
}
प्रोटोकॉल को सीधे तौर पर लागू करने के बजाय, दी गई क्लाइंट लाइब्रेरी का इस्तेमाल करें.
लेबल मैनेज करें
Gmail API में लेबल मैनेज करने के लिए, labels रिसॉर्स का इस्तेमाल करें.
| पुरानी सेटिंग | नई सेटिंग | नोट |
|---|---|---|
| labelId | आईडी | |
| लेबल | नाम | |
| unreadCount | messagesUnread | |
| कैसा दिखाई दे | labelListVisibility | SHOW अब labelShowHIDE अब labelHide है |
अन्य बदलाव:
- लेबल अपडेट करते समय या मिटाते समय, Gmail API लेबल को नाम के बजाय आईडी से रेफ़रंस करता है.
फ़िल्टर मैनेज करना
Gmail API में फ़िल्टर मैनेज करने के लिए, settings.filters रिसॉर्स का इस्तेमाल करें.
| पुरानी सेटिंग | नई सेटिंग | नोट |
|---|---|---|
| से | criteria.from | |
| से | criteria.to | |
| subject | criteria.subject | |
| hasTheWord | criteria.query | |
| doesNotHaveTheWord | criteria.negatedQuery | |
| hasAttachment | criteria.hasAttachment | |
| shouldArchive | action.removeLabelIds | INBOX को लेबल आईडी के तौर पर इस्तेमाल करें |
| shouldMarkAsRead | action.removeLabelIds | UNREAD को लेबल आईडी के तौर पर इस्तेमाल करें |
| shouldStar | action.addLabelIds | STARRED को लेबल आईडी के तौर पर इस्तेमाल करें |
| लेबल | action.addLabelIds | जोड़ने के लिए लेबल के आईडी का इस्तेमाल करना |
| forwardTo | action.forward | |
| shouldTrash | action.addLabelIds | TRASH को लेबल आईडी के तौर पर इस्तेमाल करें |
| neverSpam | action.removeLabelIds | SPAM को लेबल आईडी के तौर पर इस्तेमाल करें |
अन्य बदलाव:
- अगर उपयोगकर्ता लेबल जोड़ने की सुविधा पहले से मौजूद नहीं है, तो इसे
labels.createतरीके का इस्तेमाल करके साफ़ तौर पर बनाना होगा.
'इस पते से भेजें' सुविधा के लिए इस्तेमाल किए जाने वाले ईमेल पते मैनेज करना
Gmail API में, 'इस पते से भेजें' सुविधा के लिए इस्तेमाल किए जाने वाले ईमेल पतों को मैनेज करने के लिए, settings.sendAs संसाधन का इस्तेमाल करें.
| पुरानी सेटिंग | नई सेटिंग |
|---|---|
| नाम | displayName |
| पता | sendAsEmail |
| replyTo | replyToAddress |
| makeDefault | isDefault |
वेब क्लिप मैनेज करना
Gmail API में, वेब क्लिप की सेटिंग उपलब्ध नहीं हैं.
मैसेज अपने-आप फ़ॉरवर्ड होने की सुविधा मैनेज करना
Gmail API में ईमेल अपने-आप फ़ॉरवर्ड होने की सुविधा को मैनेज करने के लिए, settings संसाधन का इस्तेमाल करें.
| पुरानी सेटिंग | नई सेटिंग | नोट |
|---|---|---|
| चालू करें | चालू किया गया | |
| forwardTo | emailAddress | |
| ऐक्शन गेम | disposition | KEEP अब leaveInInboxARCHIVE अब archiveDELETE अब trashMARK_READ अब markRead |
अन्य बदलाव:
- फ़ॉरवर्ड करने के लिए पते बनाने और उनकी पुष्टि करने के बाद ही उनका इस्तेमाल किया जा सकता है.
- फ़ॉरवर्डिंग पतों को मैनेज करने के लिए,
settings.forwardingAddressesरिसोर्स का इस्तेमाल किया जा सकता है.
POP सेटिंग मैनेज करना
Gmail API में पीओपी ऐक्सेस को मैनेज करने के लिए, settings रिसॉर्स का इस्तेमाल करें.
| पुरानी सेटिंग | नई सेटिंग | नोट |
|---|---|---|
| चालू करें | accessWindow | disabled पर सेट होने पर बंद हो जाता है |
| enableFor | accessWindow | ALL_MAIL अब allMailMAIL_FROM_NOW_ON अब fromNowOn है |
| ऐक्शन गेम | disposition | KEEP अब leaveInInboxARCHIVE अब archiveDELETE अब trashMARK_READ अब markRead |
आईएमएपी सेटिंग मैनेज करना
Gmail API में आईएमएपी ऐक्सेस को मैनेज करने के लिए, settings रिसॉर्स का इस्तेमाल करें.
| पुरानी सेटिंग | नई सेटिंग |
|---|---|
| चालू करें | चालू किया गया |
छुट्टी के दौरान अपने-आप जवाब देने की सुविधा की सेटिंग मैनेज करना
Gmail API में, छुट्टी के दौरान अपने-आप जवाब देने की सुविधा को मैनेज करने के लिए, settings संसाधन का इस्तेमाल करें.
| पुरानी सेटिंग | नई सेटिंग |
|---|---|
| contactsOnly | restrictToContacts |
| domainOnly | restrictToDomain |
| चालू करें | enableAutoReply |
| endDate | endTime |
| मैसेज | responseBodyHtml responseBodyPlainText |
| startDate | startTime |
| subject | responseSubject |
हस्ताक्षर की सेटिंग मैनेज करना
Gmail API में ईमेल के हस्ताक्षर मैनेज करने के लिए, settings.sendAs रिसोर्स का इस्तेमाल करें.
| पुरानी सेटिंग | नई सेटिंग |
|---|---|
| signature | signature |
अन्य बदलाव:
- अब हर उपनाम के लिए अलग-अलग हस्ताक्षर मैनेज किए जा सकते हैं.
भाषा की सेटिंग मैनेज करना
Gmail API में भाषा की सेटिंग मैनेज करने के लिए, settings रिसोर्स का इस्तेमाल करें.
| पुरानी सेटिंग | नई सेटिंग |
|---|---|
| भाषा | displayLanguage |
ज़्यादा जानकारी के लिए, भाषा की सेटिंग मैनेज करना लेख पढ़ें.
प्रतिनिधि सेटिंग प्रबंधित करना
Gmail API में ईमेल भेजने का अधिकार मैनेज करने के लिए, settings.delegates रिसॉर्स का इस्तेमाल करें.
| पुरानी सेटिंग | नई सेटिंग |
|---|---|
| पता | delegateEmail |
| स्थिति | verificationStatus |
अन्य बदलाव:
- सामान्य
- प्रतिनिधि को ईमेल ऐक्सेस करने की अनुमति देने के किसी भी तरीके (इसमें
settings.delegates.createभी शामिल है) का इस्तेमाल करने के लिए, यह ज़रूरी है कि प्रतिनिधि को Gmail इस्तेमाल करने की अनुमति मिली हो. इसका मतलब है कि उदाहरण के लिए, Google Workspace में प्रतिनिधि के तौर पर काम करने वाले उपयोगकर्ता के खाते को निलंबित नहीं किया जा सकता. - किसी भी नए तरीके के लिए, ईमेल के उपनाम का इस्तेमाल, डेलिगेट के ईमेल इनपुट के तौर पर नहीं किया जा सकता. प्रतिनिधि उपयोगकर्ता को उसके प्राइमरी ईमेल पते से रेफ़र किया जाना चाहिए.
- प्रतिनिधि को ईमेल ऐक्सेस करने की अनुमति देने के किसी भी तरीके (इसमें
settings.delegates.create- अब इस तरीके का इस्तेमाल, एक ही Google Workspace संगठन के कई डोमेन के बीच डेलिगेट के तौर पर काम करने की सुविधा सेट अप करने के लिए किया जा सकता है.
- अब इस तरीके का इस्तेमाल उन उपयोगकर्ताओं के लिए किया जा सकता है जिन्हें अगली बार साइन इन करने पर पासवर्ड बदलना होगा.
- अगर यह तरीका काम करता है, तो यह जवाब के मुख्य हिस्से में
settings.delegatesरिसॉर्स दिखाता है. इसके बजाय, जवाब के मुख्य हिस्से में कोई जानकारी नहीं दिखाता. - अगर डेलिगेटर या डेलिगेट किए गए उपयोगकर्ता में से किसी एक का खाता बंद कर दिया जाता है (उदाहरण के लिए, Google Workspace में निलंबित कर दिया गया है), तो यह तरीका काम नहीं करता. साथ ही, HTTP 500 गड़बड़ी के बजाय HTTP 4XX गड़बड़ी दिखती है.
settings.delegates.delete- इस तरीके का इस्तेमाल अब किसी भी
VerificationStatusवाले डेलिगेट को मिटाने के लिए किया जा सकता है. पहले इसका इस्तेमाल सिर्फ़acceptedयाexpiredवाले डेलिगेट को मिटाने के लिए किया जा सकता था.
- इस तरीके का इस्तेमाल अब किसी भी
settings.delegates.get- यह एक नया तरीका है. ज़रूरत के हिसाब से, यह
settings.delegates.listतरीके से बेहतर हो सकता है.
- यह एक नया तरीका है. ज़रूरत के हिसाब से, यह
सामान्य सेटिंग प्रबंधित करें
Gmail API में सामान्य सेटिंग उपलब्ध नहीं हैं.