Class GmailDraft

GmailDraft

Uma mensagem de rascunho criada por um usuário na conta do Gmail de um usuário.

Métodos

MétodoTipo de retornoBreve descrição
deleteDraft()voidExclui esta mensagem de rascunho.
getId()StringExtrai o ID desta mensagem de rascunho.
getMessage()GmailMessageRetorna uma GmailMessage que representa este rascunho.
getMessageId()StringRetorna o ID da GmailMessage que representa esse rascunho.
send()GmailMessageEnvia este rascunho de mensagem de e-mail.
update(recipient, subject, body)GmailDraftSubstitui o conteúdo desta mensagem de rascunho.
update(recipient, subject, body, options)GmailDraftSubstitui o conteúdo desta mensagem de rascunho usando argumentos opcionais.

Documentação detalhada

deleteDraft()

Exclui esta mensagem de rascunho.

var 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 seguintes escopos ou escopos apropriados da API REST relacionada:

  • https://mail.google.com/

getId()

Extrai o ID desta mensagem de rascunho.

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

Retorno

String: o ID do rascunho.

Autorização

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

  • https://mail.google.com/

getMessage()

Retorna uma GmailMessage que representa este rascunho.

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

Retorno

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

Autorização

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

  • https://mail.google.com/

getMessageId()

Retorna o ID da GmailMessage que representa esse rascunho.

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

Retorno

String: o ID da mensagem

Autorização

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

  • https://mail.google.com/

send()

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

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

Retorno

GmailMessage: a mensagem recém-enviada.

Autorização

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

  • https://mail.google.com/

update(recipient, subject, body)

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

// The code below will update a draft email with the current date and time.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var now = new Date();
draft.update("mike@example.com", "current time", "The time is: " + now.toString());

Parâmetros

NomeTipoDescrição
recipientStringlista de endereços de e-mail separados por vírgula
subjectStringassunto do e-mail (máximo de 250 caracteres)
bodyStringcorpo do e-mail

Retorno

GmailDraft: o rascunho recém-atualizado.

Autorização

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

  • https://mail.google.com/

Veja também


update(recipient, subject, body, options)

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

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

Parâmetros

NomeTipoDescrição
recipientStringlista de endereços de e-mail separados por vírgula
subjectStringassunto do e-mail (máximo de 250 caracteres)
bodyStringcorpo do e-mail
optionsObjectum objeto JavaScript que especifica parâmetros avançados, conforme listado abaixo

Parâmetros avançados

NomeTipoDescrição
attachmentsBlobSource[]uma matriz de arquivos para enviar com o e-mail
bccStringuma lista de endereços de e-mail separados por vírgula em Cco
ccStringuma lista de endereços de e-mail separados por vírgulas para colocar em cópia
fromStringo endereço de origem do e-mail, que precisa ser um dos valores retornados por GmailApp.getAliases();
htmlBodyStringSe definido, os dispositivos capazes de renderizar HTML o usarão em vez do argumento obrigatório do corpo. Você pode adicionar um campo inlineImages opcional no corpo do HTML se tiver imagens inline do seu e-mail
inlineImagesObjectUm objeto JavaScript que contém um mapeamento da chave de imagem (String) para dados de imagem (BlobSource). Isso pressupõe que o parâmetro htmlBody é usado e contém referências a essas imagens no formato <img src="cid:imageKey" />
nameStringo nome do remetente do e-mail (padrão: o nome do usuário)
replyToStringUm endereço de e-mail para ser usado como o endereço para resposta padrão (padrão: o endereço de e-mail do usuário).

Retorno

GmailDraft: o rascunho recém-atualizado.

Autorização

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

  • https://mail.google.com/

Veja também