Class GmailDraft

GmailDraft

Uma mensagem de rascunho criada pelo usuário na conta do Gmail dele.

Métodos

Método	Tipo de retorno	Breve descrição
deleteDraft()	void	Exclui essa mensagem de rascunho.
getId()	String	Recebe o ID dessa mensagem de rascunho.
getMessage()	GmailMessage	Retorna um GmailMessage que representa esse rascunho.
getMessageId()	String	Retorna o ID do GmailMessage que representa esse rascunho.
send()	GmailMessage	Envia essa mensagem de e-mail de rascunho.
update(recipient, subject, body)	GmailDraft	Substitui o conteúdo dessa mensagem de rascunho.
update(recipient, subject, body, options)	GmailDraft	Substitui o conteúdo dessa mensagem de rascunho usando argumentos opcionais.

Documentação detalhada

deleteDraft()

Exclui essa mensagem de rascunho.

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
draft.deleteDraft();
draft.getMessage();  // Throws exception.

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos adequados da API REST relacionada:

• https://mail.google.com/

---

getId()

Recebe o ID dessa mensagem de rascunho.

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const draftId = draft.getId();
const draftById = GmailApp.getDraft(draftId);
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

Retornar

String: o ID do rascunho

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos adequados da API REST relacionada:

• https://mail.google.com/

---

getMessage()

Retorna um GmailMessage que representa esse rascunho.

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const message = draft.getMessage();
Logger.log(message.getSubject());

Retornar

GmailMessage: a mensagem que representa o conteúdo desse rascunho

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos adequados da API REST relacionada:

• https://mail.google.com/

---

getMessageId()

Retorna o ID do GmailMessage que representa esse rascunho.

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const messageId = draft.getMessageId();
Logger.log(messageId === draft.getMessage().getId());

Retornar

String: o ID da mensagem

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos adequados da API REST relacionada:

• https://mail.google.com/

---

send()

Envia essa mensagem de e-mail de rascunho. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela cota.

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const msg = draft.send();     // Send it
Logger.log(msg.getDate());    // Should be approximately the current timestamp

Retornar

GmailMessage: a mensagem recém-enviada

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos adequados da API REST relacionada:

• https://mail.google.com/

---

update(recipient, subject, body)

Substitui o conteúdo dessa mensagem de rascunho. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela cota.

// The code below will update a draft email with the current date and time.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const now = new Date();
draft.update(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

Parâmetros

Nome	Tipo	Descrição
recipient	String	lista de endereços de e-mail separados por vírgula
subject	String	assunto do e-mail (máximo de 250 caracteres)
body	String	corpo do e-mail

Retornar

GmailDraft: o rascunho recém-atualizado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• GmailApp.createDraft(recipient, subject, body)

---

update(recipient, subject, body, options)

Substitui o conteúdo dessa mensagem de rascunho usando argumentos opcionais. O e-mail pode conter texto simples ou um corpo HTML. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela cota.

// Update a draft email with a file from Google Drive attached as a PDF.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
draft.update(
    '[e-mail]',
    'Attachment example',
    'Please see attached file.',
    {
      attachments: [file.getAs(MimeType.PDF)],
      name: 'Automatic Emailer Script',
    },
);

Parâmetros

Nome	Tipo	Descrição
recipient	String	lista de endereços de e-mail separados por vírgula
subject	String	assunto do e-mail (máximo de 250 caracteres)
body	String	corpo do e-mail
options	Object	um objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo

Parâmetros avançados

Nome	Tipo	Descrição
attachments	BlobSource[]	uma matriz de arquivos a serem enviados com o e-mail
bcc	String	uma lista de endereços de e-mail separada por vírgulas para Cco
cc	String	uma lista separada por vírgulas de endereços de e-mail para CC
from	String	o endereço de onde o e-mail será enviado, que precisa ser um dos valores retornados por GmailApp.getAliases()
htmlBody	String	se definido, os dispositivos capazes de renderizar HTML vão usá-lo em vez do argumento de corpo obrigatório; você pode adicionar um campo inlineImages opcional no corpo HTML se tiver imagens incorporadas para seu e-mail
inlineImages	Object	um objeto JavaScript que contém um mapeamento da chave da imagem (String) para os dados da imagem (BlobSource); isso pressupõe que o parâmetro htmlBody seja usado e contenha referências a essas imagens no formato <img src="cid:imageKey" />
name	String	o nome do remetente do e-mail (padrão: o nome do usuário)
replyTo	String	um endereço de e-mail a ser usado como o Endereço para resposta padrão (padrão: o endereço de e-mail do usuário)

Retornar

GmailDraft: o rascunho recém-atualizado

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos escopos a seguir ou escopos adequados da API REST relacionada:

• https://mail.google.com/

Consulte também

• GmailApp.createDraft(recipient, subject, body, options)