문서로 건너뛰기
SDK

초안

`drafts.list`, `listAll`, `iterate`, `get`, `create`, `update`, `delete`.

모든 메서드

usage.ts
const page = await openemail.drafts.list({ query: 'invoice', limit: 25 })const draft = await openemail.drafts.get('draft_…') const created = await openemail.drafts.create({  to: ['[email protected]'],  cc: [],  bcc: [],  subject: 'Your September invoice',  html: '<p>Draft body.</p>',  from: '[email protected]',  threadId: 'thread_…',}) const updated = await openemail.drafts.update(created.id!, { subject: 'Revised' })await openemail.drafts.delete(updated.id!)

update는 초안의 id를 유지하므로, 응답에 담긴 값은 항상 전달한 것과 같습니다. 알 수 없는 id는 새 초안이 아니라 404입니다.

listthreads.list와 같은 방식으로 페이징합니다. API의 pageTokennextCursor로 돌아오고 cursor로 들어가며, listAlliterate가 이를 대신 따라갑니다.

초안을 보내려면 그 id를 emails.send에 전달하세요. 초안이 내용을 제공하고 발송이 봉투를 제공합니다.

send-draft.ts
await openemail.emails.send({  from: '[email protected]',  to: '[email protected]',  draftId: 'draft_…',})

매개변수: drafts.create 및 drafts.update (DraftInput)

tostring[]
수신자 주소를 평범한 문자열로 담습니다. `emails.send`가 받는 `RecipientInput` 형태가 아닌데, 이 엔드포인트는 배열을 드라이버가 원하는 쉼표 구분 목록으로 합치기 때문입니다. 생성 시 배열을 생략하면 빈 값으로 저장되고, 수정 시 필드를 생략하면 저장된 수신자가 그대로 유지됩니다. 핸들러가 초안을 먼저 읽고 병합하기 때문입니다.
ccstring[]
`to`와 같은 평범한 문자열 형태의 Cc 주소입니다. 생성 시 생략하면 비어 있고, 수정 시 생략하면 그대로 유지됩니다.
bccstring[]
`to`와 같은 평범한 문자열 형태의 Bcc 주소입니다. 생성 시 생략하면 비어 있고, 수정 시 생략하면 그대로 유지됩니다.
subjectstring
초안의 제목이며 최대 998자로, RFC 5322의 줄 길이 제한입니다. 생성 시 기본값은 빈 문자열이므로 초안에는 항상 제목이 있습니다.
htmlstring
마크업으로 된 초안 본문이며 최대 1,000,000자입니다. 이기는 쪽은 이 본문입니다. `html`과 `text`는 드라이버의 단일 메시지 필드로 들어가므로, 둘 다 보내면 이쪽이 저장됩니다.
textstring
일반 텍스트 본문이며 최대 1,000,000자이고, `html`이 없을 때만 사용됩니다. 초안은 두 개의 파트가 아니라 하나의 본문을 저장하므로, 여기에 넣은 텍스트는 초안을 읽을 때 `html`로 돌아옵니다.
fromstring
초안에 저장할 발신 주소입니다. 수정 시 생략하면 저장된 초안의 값이 그대로 이어집니다. 드라이버는 전달받은 내용으로 메시지 전체를 다시 만들기 때문에, 이 값을 빠뜨린 부분 수정은 선택된 발신자를 조용히 바꿔 버릴 것입니다.
threadIdstring
초안을 기존 스레드에 붙여 답장으로 저장합니다. `from`과 마찬가지로 수정 시 생략하면 값이 이어지는데, 이 값 없이 메시지를 다시 만들면 답장이 스레드에서 떨어져 나가기 때문입니다.

응답: DraftResource (drafts.get)

object'draft'
항상 `draft`입니다.
idstring
초안의 id입니다. 쓰기 작업은 초안 전체가 아니라 `SavedDraftResource`로 응답하므로, 보낸 id를 재사용하지 말고 결과에서 id를 읽으세요.
tostring[]
초안이 저장한 그대로의 수신자 주소입니다. 초안에 수신자가 없으면 null이 아니라 빈 배열입니다.
ccstring[]
저장된 그대로의 Cc 주소입니다. 없으면 null이 아니라 빈 배열입니다.
bccstring[]
저장된 그대로의 Bcc 주소입니다. 없으면 null이 아니라 빈 배열입니다.
subjectstring
저장된 제목이며, 초안에 제목이 없으면 빈 문자열입니다. 이 필드는 null이 되지 않으므로 존재 여부가 아니라 길이를 확인하세요.
htmlstring
저장된 본문이며, 초안에 본문이 없으면 빈 문자열입니다. 나가는 쪽에는 별도의 text 필드가 없습니다. `text`만으로 저장된 초안도 여기로 반환됩니다.