Python
Etiketat
`labels.list`, `list_all`, `iterate`, `list_colors`, `get`, `create`, `update` dhe `delete`.
Çdo metodë
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 kthen një Page me etiketa të renditura sipas emrit, dhe list_all e iterate kalojnë nëpër çdo faqe. Çdo etiketë mban ngjyrën e saj, threadCount dhe kur u krijua e u ndryshua për herë të fundit. list_colors kthen paletën që ofron aplikacioni, katërmbëdhjetë ngjyra të plota dhe shtatë gradientë, si një listë të thjeshtë. type është gjithmonë user. ID-ja vjen nga emri me të cilin u krijua etiketa, kështu që Invoices është USER_INVOICES, dhe nuk ndryshon kurrë.
Një etiketë i përket hapësirës së punës, prandaj një riemërtim, ringjyrosje ose fshirje e ndryshon për çdo anëtar dhe çdo çelës. threads.update vendos dhe heq etiketa në një bisedë, dhe threads.list(folder='USER_INVOICES') liston çdo bisedë që ka një të tillë.
Parametrat: labels.create dhe labels.update
namestr- Emri i dukshëm i etiketës, i shkurtuar para se të matet, kështu që kufiri është 1 deri në 225 karaktere pas shkurtimit. I detyrueshëm te `create` dhe opsional te `update`, ku lënia jashtë e mban emrin. Vetëm hapësira është një 422. Një emër që e ka tashmë një etiketë tjetër, i krahasuar pa dallim shkronjash, është një 409 `label_name_taken`, dhe `create` refuzon sapo hapësira e punës ka 50 etiketa, me një 422 `label_limit_reached`.
colorLabelColorInput | None- Opsional te të dyja thirrjet. Lënia jashtë te `update` e mban ngjyrën e ruajtur, dhe `None` e pastron. Trupi është strikt, pra një çelës gati i njëjtë si `colour` është një 422 dhe jo një veprim i heshtur pa efekt.
color.backgroundColorstre detyrueshme- Një ngjyrë hex (`#RGB`, `#RGBA`, `#RRGGBB` ose `#RRGGBBAA`, e ruajtur me shkronja të mëdha) ose një token gradienti: `gradient:sunset`, `gradient:ember`, `gradient:meadow`, `gradient:lagoon`, `gradient:aurora`, `gradient:berry` ose `gradient:midnight`. Një varg bosh do të thotë pa ngjyrë, dhe çdo gjë tjetër është një 422 `invalid_parameter`.
color.textColorstr- Pranohet dhe shpërfillet. Ngjyra e tekstit llogaritet nga `backgroundColor`, njësoj si në aplikacion.
Përgjigjja: LabelResource
objectLiteral['label']- Gjithmonë vargu `label`. `create` dhe `update` kthejnë të njëjtin tip, të lexuar ashtu siç ruhet.
idstr- ID-ja e etiketës, dhe ajo që marrin `get`, `update`, `delete` dhe `threads.update`. Nuk ndryshon kurrë, as pas një riemërtimi.
namestr- Ajo që sheh përdoruesi.
typestr- Gjithmonë `user`. Etiketat e sistemit nuk shërbehen kurrë këtu, dhe një ID sistemi te `get` është një 404.
colorLabelColor | None- `None` kur etiketa nuk ka ngjyrë.
color.backgroundColorstr- Ngjyra e ruajtur: një vlerë hex ose një token gradienti. `list_colors` jep dy skajet e një gradienti.
color.textColorstr- Ngjyra e tekstit që aplikacioni vizaton mbi ngjyrë, `#18181B` ose `#FFFFFF`, e llogaritur në server dhe jo e ruajtur.
threadCountint- Sa biseda e mbajnë etiketën tani. Për një çelës të kufizuar në adresa të caktuara, numërohen vetëm bisedat e dorëzuara te ato.
createdAtstr | None- Kur u krijua etiketa, si ISO 8601, ose `None` për një etiketë të krijuar para se këto kohë të regjistroheshin.
updatedAtstr | None- Riemërtimi ose ringjyrosja e fundit, si ISO 8601, ose `None` për një etiketë të krijuar para se këto kohë të regjistroheshin.
Përgjigjja: LabelColorResource
kindLiteral['solid', 'gradient']- Nëse kampioni është një ngjyrë e vetme apo një gradient.
namestr- Emri i kampionit, si `red` ose `sunset`.
valuestr- Çfarë të dërgohet si `color.backgroundColor` për të përdorur këtë kampion.
solidstr- Një hex i vetëm për vendet ku nuk mund të vizatohet një gradient. I njëjtë me `value` te një ngjyrë e plotë.
fromstr | None- Ku fillon një gradient, i vizatuar në 135 gradë. `None` te një ngjyrë e plotë.
tostr | None- Ku mbaron një gradient. `None` te një ngjyrë e plotë.
textColorstr- Ngjyra e tekstit që aplikacioni vizaton mbi këtë kampion.