Python
लेबल
`labels.list`, `list_all`, `iterate`, `list_colors`, `get`, `create`, `update` और `delete`।
हर मेथड
from openemail import openemail page = openemail.labels.list(limit=50)every = openemail.labels.list_all()colors = openemail.labels.list_colors() created = openemail.labels.create({ 'name': 'Invoices', 'color': {'backgroundColor': 'gradient:sunset'},}) openemail.labels.update(created['id'], {'name': 'Invoices 2027'})openemail.labels.update(created['id'], {'color': {'backgroundColor': '#3B82F6'}})openemail.labels.delete(created['id'])list नाम के क्रम में लेबलों का एक Page लौटाता है, और list_all व iterate हर पेज से गुज़रते हैं। हर लेबल में उसका रंग, threadCount और उसके बनने व आख़िरी बार बदलने का समय होता है। list_colors ऐप का पैलेट, चौदह ठोस रंग और सात ग्रेडिएंट, एक सादी list के रूप में लौटाता है। type हमेशा user होता है। id उस नाम से बनती है जिससे लेबल बनाया गया था, इसलिए Invoices का मतलब USER_INVOICES है, और यह कभी नहीं बदलती।
लेबल workspace का होता है, इसलिए नाम बदलना, रंग बदलना या हटाना उसे हर सदस्य और हर key के लिए बदल देता है। threads.update किसी बातचीत पर लेबल लगाता और हटाता है, और threads.list(folder='USER_INVOICES') किसी लेबल वाली हर बातचीत दिखाता है।
पैरामीटर: labels.create और labels.update
namestr- लेबल का दिखने वाला नाम, जिसे मापने से पहले छाँटा जाता है, इसलिए सीमा छाँटने के बाद 1 से 225 अक्षर है। `create` पर ज़रूरी और `update` पर वैकल्पिक, जहाँ इसे छोड़ देने से नाम वही रहता है। केवल खाली जगह 422 देती है। किसी दूसरे लेबल का पहले से मौजूद नाम, छोटे-बड़े अक्षरों का फ़र्क किए बिना, 409 `label_name_taken` देता है, और workspace में 50 लेबल हो जाने पर `create` 422 `label_limit_reached` के साथ मना कर देता है।
colorLabelColorInput | None- दोनों कॉल पर वैकल्पिक। `update` पर इसे छोड़ देने से संग्रहीत रंग वही रहता है, और `None` उसे मिटा देता है। body सख्त है, इसलिए `colour` जैसी लगभग-सही key 422 है, चुपचाप कुछ न करने वाला कॉल नहीं।
color.backgroundColorstrआवश्यक- एक hex रंग (`#RGB`, `#RGBA`, `#RRGGBB` या `#RRGGBBAA`, बड़े अक्षरों में सहेजा जाता है) या एक ग्रेडिएंट टोकन: `gradient:sunset`, `gradient:ember`, `gradient:meadow`, `gradient:lagoon`, `gradient:aurora`, `gradient:berry` या `gradient:midnight`। खाली string का मतलब है कोई रंग नहीं, और बाकी कुछ भी 422 `invalid_parameter` देता है।
color.textColorstr- लिया जाता है और अनदेखा किया जाता है। स्याही `backgroundColor` से निकाली जाती है, ठीक वैसे ही जैसे app करता है।
प्रतिक्रिया: LabelResource
objectLiteral['label']- हमेशा string `label`। `create` और `update` भी यही प्रकार लौटाते हैं, जैसा सहेजा गया है वैसा पढ़कर।
idstr- लेबल की id, और वही जो `get`, `update`, `delete` और `threads.update` लेते हैं। यह कभी नहीं बदलती, नाम बदलने के बाद भी नहीं।
namestr- जो उपयोगकर्ता देखता है।
typestr- हमेशा `user`। सिस्टम लेबल यहाँ कभी नहीं दिए जाते, और `get` पर सिस्टम id 404 देती है।
colorLabelColor | None- जब लेबल का कोई रंग न हो तो `None`।
color.backgroundColorstr- सहेजा गया रंग: एक hex मान या ग्रेडिएंट टोकन। `list_colors` किसी ग्रेडिएंट के दोनों सिरे देता है।
color.textColorstr- वह स्याही जो app रंग पर खींचता है, `#18181B` या `#FFFFFF`, जो सहेजी नहीं जाती बल्कि सर्वर पर निकाली जाती है।
threadCountint- अभी कितनी बातचीतों पर यह लेबल है। कुछ पतों तक सीमित key के लिए केवल उन्हीं पतों पर पहुँची बातचीतें गिनी जाती हैं।
createdAtstr | None- लेबल कब बना, ISO 8601 में, या इन समयों के दर्ज होने से पहले बने लेबल के लिए `None`।
updatedAtstr | None- आख़िरी बार नाम या रंग कब बदला, ISO 8601 में, या इन समयों के दर्ज होने से पहले बने लेबल के लिए `None`।
रिस्पॉन्स: LabelColorResource
kindLiteral['solid', 'gradient']- स्वॉच एक रंग है या ग्रेडिएंट।
namestr- स्वॉच का नाम, जैसे `red` या `sunset`।
valuestr- इस स्वॉच को इस्तेमाल करने के लिए `color.backgroundColor` के रूप में क्या भेजें।
solidstr- उन जगहों के लिए एक अकेला hex जहाँ ग्रेडिएंट नहीं खींचा जा सकता। ठोस रंग में `value` के बराबर।
fromstr | None- ग्रेडिएंट कहाँ से शुरू होता है, 135 डिग्री पर खींचा गया। ठोस रंग में `None`।
tostr | None- ग्रेडिएंट कहाँ ख़त्म होता है। ठोस रंग में `None`।
textColorstr- वह स्याही जो app इस स्वॉच पर खींचता है।