문서로 건너뛰기
SDK

레이블

`labels.list`, `get`, `create`, `update`, `delete`.

모든 메서드

usage.ts
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는 단순 배열로 resolve됩니다. color는 읽기 응답에서 버려지지 않고 그대로 반환되므로, 클라이언트가 사용자가 보는 모습 그대로 레이블을 그릴 수 있습니다. type은 항상 user이므로 분기할 것이 없습니다. id는 이름에서 파생되므로 InvoicesUSER_INVOICES가 됩니다.

파라미터: labels.create 및 labels.update

namestring필수
레이블의 표시 이름입니다. 길이를 재기 전에 앞뒤 공백을 제거하므로 제한은 공백 제거 후 1자에서 225자입니다. 공백만 있는 이름은 색 점만 찍힌 채 읽을 것도 누를 것도 없는 행이 되는 대신 422가 됩니다. 또한 `create`는 메일함에 이미 사용자 레이블이 50개 있으면 `name`을 가리키는 422 `label_limit_reached`로 거부합니다.
colorLabelColor
두 호출 모두에서 선택 사항이며, `update`에서 생략하면 저장된 색을 지우지 않고 그대로 둡니다. 본문은 엄격하게 검사되므로 `colour`처럼 비슷하지만 다른 키는 조용히 무시되지 않고 422가 됩니다.
color.backgroundColorstring필수
`color`를 지정하면 필수이며, 최대 32자입니다. 네이티브 메일함에서는 이 절반만 보존됩니다. 행에는 색이 하나만 저장됩니다.
color.textColorstring필수
`color`를 지정하면 필수이며, 최대 32자입니다.

응답: Label

object'label'
항상 문자열 `label`입니다. 쓰기 호출도 이 값을 반환하지만, 이 타입이 아니라 `SavedLabelResource`에 담아서 반환합니다.
idstring
메일함이 가진 고유 id이며, `get`, `update`, `delete`가 받는 값입니다. 쓰기 호출에서는 nullable한 `SavedLabelResource.id`로 전달됩니다. null이면 목록을 조회해 레이블을 찾으십시오.
namestring
사용자에게 보이는 이름이며, 메일함이 이름 없는 레이블을 돌려줄 때는 null이 아니라 빈 문자열이 됩니다. 네이티브 메일함에서는 id가 이 이름에서 파생되므로(`Follow up`은 `USER_FOLLOW_UP`이 됩니다), 같은 id로 정규화되는 두 번째 레이블은 첫 번째를 덮어쓰지 않고 409 `label_name_taken`으로 거부됩니다.
typestring
항상 `user`입니다. 여기서는 사용자 레이블만 제공됩니다. 표준 폴더 id는 응답을 만들기 전에 걸러지고, `get`에 시스템 id를 넘기면 404입니다. 메일함이 이 필드를 생략하면 라우트가 `user`로 대체하며, `LabelInput`에는 이 값을 설정하는 것이 없습니다.
colorLabelColor | null
메일함이 해당 레이블의 색을 보고하지 않으면 null입니다. 렌더링하기 전에 객체가 아니라 문자열 쪽을 확인하십시오. 비어 있는 한 쌍과 아예 없는 것은 같지 않습니다.
color.backgroundColorstring
메일함에 저장된 그대로의 레이블 배경색입니다. 버려지지 않고 반환되므로, 클라이언트가 사용자가 앱에서 보는 모습 그대로 레이블을 그릴 수 있습니다.
color.textColorstring
전경색입니다. 네이티브 메일함에는 이 값을 담을 컬럼이 없습니다. 무엇을 쓰든 읽을 때는 `#ffffff`가 반환되므로, 밝은 배경색은 글자가 읽히지 않는 상태로 돌아옵니다.