SDK
लेबल
`labels.list`, `get`, `create`, `update` और `delete`।
हर method
const labels = await openemail.labels.list()const label = await openemail.labels.get('USER_INVOICES') const created = await openemail.labels.create({ name: 'Invoices', color: { backgroundColor: '#e8eaed', textColor: '#3c4043' },}) await openemail.labels.update(created.id!, { name: 'Invoices 2027' })await openemail.labels.delete(created.id!)list एक सादे array में resolve होता है, क्योंकि लेबल पेज नहीं किए जाते। color पढ़ने पर छोड़ा नहीं बल्कि लौटाया जाता है, ताकि क्लाइंट लेबल को वैसे ही दिखा सके जैसे उपयोगकर्ता देखता है। type हमेशा user होता है, इसलिए उस पर शाखा बनाने को कुछ नहीं है। id नाम से बनती हैं, इसलिए Invoices की id USER_INVOICES होती है।
पैरामीटर: labels.create और labels.update
namestringआवश्यक- लेबल का प्रदर्शित नाम, मापे जाने से पहले trim किया जाता है, इसलिए सीमा trim के बाद 1 से 225 वर्ण है। केवल whitespace 422 है, न कि रंग की बिंदी और पढ़ने या क्लिक करने को कुछ नहीं वाली बेनाम पंक्ति। `create` इसके अलावा तब भी इनकार करता है जब मेलबॉक्स में पहले से 50 user लेबल हों — तब 422 `label_limit_reached` आता है जो `name` का नाम लेता है।
colorLabelColor- दोनों कॉल पर वैकल्पिक, और `update` पर इसे छोड़ देने से संग्रहीत रंग मिटता नहीं बल्कि जैसा है वैसा रहता है। body सख्त है, इसलिए `colour` जैसी लगभग-सही key 422 है, चुपचाप कुछ न करने वाला कॉल नहीं।
color.backgroundColorstringआवश्यक- `color` दिए जाने पर आवश्यक, और अधिकतम 32 वर्ण। नेटिव मेलबॉक्स पर यही आधा हिस्सा रखा जाता है: पंक्ति एक ही रंग संग्रहीत करती है।
color.textColorstringआवश्यक- `color` दिए जाने पर आवश्यक, और अधिकतम 32 वर्ण।
रिस्पॉन्स: Label
object'label'- हमेशा string `label`। लिखने वाला कॉल भी इसे लौटाता है, पर `SavedLabelResource` पर, इस type पर नहीं।
idstring- मेलबॉक्स की अपनी id, और वही जो `get`, `update` और `delete` लेते हैं। लिखने वाले कॉल पर यह `SavedLabelResource.id` के रूप में आती है, जो nullable है। जब यह null हो, तो लेबल को सूची बनाकर ढूँढें।
namestring- जो उपयोगकर्ता देखता है, और जब मेलबॉक्स बिना नाम वाला लेबल लौटाता है तो null के बजाय खाली string। नेटिव मेलबॉक्स पर id इसी नाम से बनती है (`Follow up` से `USER_FOLLOW_UP`), इसलिए दूसरा लेबल जो उसी id पर normalise होता है, पहले को अधिलेखित करने के बजाय 409 `label_name_taken` के साथ अस्वीकार कर दिया जाता है।
typestring- हमेशा `user`। यहाँ केवल user लेबल परोसे जाते हैं: रिस्पॉन्स बनने से पहले मानक फ़ोल्डर id छान दी जाती हैं, और `get` पर कोई सिस्टम id 404 है। मेलबॉक्स यह फ़ील्ड छोड़ दे तो route `user` पर लौट आता है, और `LabelInput` में कुछ भी इसे सेट नहीं करता।
colorLabelColor | null- null तब, जब मेलबॉक्स लेबल के लिए कोई रंग नहीं बताता। रेंडर करने से पहले object के बजाय string जाँचें। खाली जोड़ी और अनुपस्थित जोड़ी एक बात नहीं हैं।
color.backgroundColorstring- लेबल की पृष्ठभूमि, जैसी मेलबॉक्स उसे रखता है। छोड़ी नहीं बल्कि लौटाई जाती है, ताकि क्लाइंट लेबल को वैसे ही दिखा सके जैसे उपयोगकर्ता उसे ऐप में देखता है।
color.textColorstring- अग्रभूमि का रंग। नेटिव मेलबॉक्स में इसके लिए कोई column नहीं है: जो भी लिखा गया हो, पढ़ने पर `#ffffff` लौटता है, इसलिए हल्की पृष्ठभूमि उसके सामने अपठनीय टेक्स्ट के साथ आती है।