SDK
Rascunhos
`drafts.list`, `listAll`, `iterate`, `get`, `create`, `update` e `delete`.
Todos os métodos
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 mantém o id do rascunho, pelo que o valor com que responde é sempre o que passou. Um id desconhecido dá 404 em vez de criar um novo rascunho.
list pagina da mesma forma que threads.list: o pageToken da API é devolvido como nextCursor e enviado como cursor, e listAll e iterate seguem-no por si.
Para enviar um rascunho, passe o seu id a emails.send. O rascunho fornece o conteúdo e o envio fornece o envelope.
await openemail.emails.send({ from: '[email protected]', to: '[email protected]', draftId: 'draft_…',})Parâmetros: drafts.create e drafts.update (DraftInput)
tostring[]- Endereços dos destinatários como strings simples, e não nas formas `RecipientInput` que `emails.send` aceita, porque este endpoint junta o array na lista separada por vírgulas que o driver espera. Na criação, um array omitido é guardado vazio; na atualização, um campo omitido deixa os destinatários guardados intactos, já que o handler lê primeiro o rascunho e depois faz a junção.
ccstring[]- Endereços em Cc, na mesma forma de string simples que `to`. Vazio na criação quando omitido, e inalterado na atualização quando omitido.
bccstring[]- Endereços em Bcc, na mesma forma de string simples que `to`. Vazio na criação quando omitido, e inalterado na atualização quando omitido.
subjectstring- O assunto do rascunho, com no máximo 998 caracteres, o limite de linha do RFC 5322. Na criação, a predefinição é uma string vazia, pelo que um rascunho tem sempre um.
htmlstring- O corpo do rascunho em markup, com no máximo 1 000 000 caracteres. É este o corpo que prevalece: `html` e `text` alimentam o campo de mensagem único do driver, pelo que enviar ambos guarda este.
textstring- Um corpo em texto simples, com no máximo 1 000 000 caracteres, usado apenas quando `html` está ausente. O rascunho guarda um único corpo em vez de duas partes, pelo que o texto fornecido aqui é devolvido em `html` quando o rascunho é lido.
fromstring- O endereço do remetente a guardar no rascunho. Na atualização, quando omitido, é mantido a partir do rascunho guardado. O driver reconstrói a mensagem inteira a partir do que recebe, pelo que uma atualização parcial que o omitisse alteraria silenciosamente o remetente escolhido.
threadIdstring- Associa o rascunho a uma conversa existente para que seja guardado como resposta. Tal como `from`, é mantido na atualização quando omitido, porque reconstruir a mensagem sem ele separaria a resposta da sua conversa.
Resposta: DraftResource (drafts.get)
object'draft'- Sempre `draft`.
idstring- O id do rascunho. As escritas respondem com um `SavedDraftResource` em vez de um rascunho completo, por isso leia o id do resultado em vez de reutilizar o que enviou.
tostring[]- Os endereços dos destinatários tal como o rascunho os guardou. Um array vazio, nunca null, quando o rascunho não tem nenhum.
ccstring[]- Endereços em Cc tal como foram guardados. Um array vazio, nunca null, quando o rascunho não tem nenhum.
bccstring[]- Endereços em Bcc tal como foram guardados. Um array vazio, nunca null, quando o rascunho não tem nenhum.
subjectstring- O assunto guardado, ou uma string vazia quando o rascunho não tem nenhum. Este campo nunca é null, por isso verifique o seu comprimento e não a sua presença.
htmlstring- O corpo guardado, ou uma string vazia quando o rascunho não tem nenhum. Não existe um campo de texto separado na resposta: um rascunho guardado apenas com `text` é devolvido aqui.