Etiketat
`labels->list`, `listAll`, `iterate`, `listColors`, `get`, `create`, `update` dhe `delete`.
Çdo metodë
$page = $client->labels->list(limit: 50);$every = $client->labels->listAll();$colors = $client->labels->listColors();echo count($page), ' ', count($every), ' ', count($colors), PHP_EOL; foreach ($client->labels->iterate() as $row) { echo $row['name'], ' ', $row['threadCount'], PHP_EOL;} $created = $client->labels->create([ 'name' => 'Invoices', 'color' => ['backgroundColor' => 'gradient:sunset'],]); $client->labels->update($created['id'], ['name' => 'Invoices 2027']);$client->labels->update($created['id'], ['color' => ['backgroundColor' => '#3B82F6']]); $label = $client->labels->get($created['id']);echo $label['name'], ' ', $label['color']['backgroundColor'] ?? 'no colour', PHP_EOL; $client->labels->delete($created['id']);list kthen një OpenEmail\Result\Page me etiketa të renditura sipas emrit, dhe listAll e iterate përshkojnë çdo faqe. listAll kthen një array të vetëm, dhe iterate kthen një Generator që jep etiketat një nga një. Çdo etiketë është një array me çelësa në camelCase që mban ngjyrën e saj, threadCount dhe kur u krijua e u ndryshua për herë të fundit. listColors kthen paletën që ofron aplikacioni, katërmbëdhjetë ngjyra të plota dhe shtatë gradientë, si një listë të thjeshtë array-sh, pa faqosje. type është gjithmonë user. Id-ja vjen nga emri me të cilin u krijua etiketa, ndaj Invoices është USER_INVOICES, dhe nuk ndryshon kurrë.
Fushat e create dhe update janë çelësat e një array-i të vetëm me emrat e API-së, ndaj një ngjyrë është 'color' => ['backgroundColor' => '#3B82F6'].
Një etiketë i përket hapësirës së punës, prandaj një riemërtim, një ringjyrosje ose një fshirje e ndryshon për çdo anëtar dhe çdo çelës. threads->update vendos dhe heq etiketa në një bisedë, dhe $client->threads->list(folder: 'USER_INVOICES') liston çdo bisedë që mban një të tillë. Faqja e thread-eve i trajton të dyja.
Parametrat: labels->create dhe labels->update
namestring- Emri i shfaqur i etiketës, i pastruar nga hapësirat anësore para se të matet, ndaj kufiri është 1 deri në 225 karaktere pas pastrimit. I detyrueshëm te `create` dhe opsional te `update`, ku lënia e tij jashtë e ruan emrin. Vetëm hapësira jep një 422. Një emër që e ka tashmë një etiketë tjetër, i krahasuar pa dallim shkronjash të mëdha a të vogla, jep një 409 `label_name_taken`, të hedhur si `ConflictException`. `create` refuzon sapo hapësira e punës të mbajë 50 etiketa, me një 422 `label_limit_reached`, të hedhur si `ValidationException`.
colorarray or null- Opsional te të dyja thirrjet. Lënia jashtë te `update` e mban ngjyrën e ruajtur, dhe `'color' => null` e pastron. Trupi është i rreptë, ndaj një çelës pothuajse i saktë si `colour` jep një 422 dhe jo një veprim të heshtur pa efekt.
color.backgroundColorstringe 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.textColorstring- Pranohet dhe shpërfillet. Ngjyra e tekstit llogaritet nga `backgroundColor`, njësoj si në aplikacion.
Përgjigjja: një etiketë
Një etiketë është një array me çelësa në camelCase, ndaj $label['threadCount'] lexon numrin, dhe $label['color']['backgroundColor'] ?? null lexon ngjyrën dhe jep null kur etiketa nuk ka ngjyrë.
objectstring- Gjithmonë string-u `label`. `create` dhe `update` kthejnë të njëjtin array, të lexuar sërish ashtu siç është ruajtur.
idstring- Id-ja e etiketës, dhe ajo që marrin `get`, `update`, `delete` dhe `threads->update`. Nuk ndryshon kurrë, as pas një riemërtimi.
namestring- Ajo që sheh përdoruesi.
typestring- Gjithmonë `user`. Etiketat e sistemit nuk shërbehen kurrë këtu, dhe një id sistemi te `get` jep një 404, të hedhur si `NotFoundException`.
colorarray or null- Është null kur etiketa nuk ka ngjyrë.
color.backgroundColorstring- Ngjyra e ruajtur: një vlerë hex ose një token gradienti. `listColors` jep dy skajet e një gradienti.
color.textColorstring- 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.
createdAtstring or null- Kur u krijua etiketa, si ISO 8601, ose null për një etiketë të krijuar para se këto kohë të regjistroheshin.
updatedAtstring or null- Riemërtimi ose ringjyrosja e fundit, si ISO 8601, ose null për një etiketë të krijuar para se këto kohë të regjistroheshin.
Përgjigjja: një mostër ngjyre (labels->listColors)
kindstring- Nëse mostra është një ngjyrë e vetme apo një gradient: `solid` ose `gradient`.
namestring- Emri i kampionit, si `red` ose `sunset`.
valuestring- Çfarë të dërgohet si `color.backgroundColor` për të përdorur këtë kampion.
solidstring- 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ë.
fromstring or null- Ku nis një gradient, i vizatuar në 135 gradë. Është null te një ngjyrë e plotë.
tostring or null- Ku mbaron një gradient. Është null te një ngjyrë e plotë.
textColorstring- Ngjyra e tekstit që aplikacioni vizaton mbi këtë kampion.