Esta página foi traduzida pela API Cloud Translation.

Class GmailDraft

Um rascunho criado na conta do Gmail de um usuário.

Métodos

Método	Tipo de retorno	Breve descrição
`deleteDraft()`	`void`	Exclui esta mensagem de rascunho.
`getId()`	`String`	Recebe o ID desta mensagem de rascunho.
`getMessage()`	`GmailMessage`	Retorna uma GmailMessage que representa esse rascunho.
`getMessageId()`	`String`	Retorna o ID do `GmailMessage` que representa esse rascunho.
`send()`	`GmailMessage`	Envia esta mensagem de e-mail de rascunho.
`update(recipient, subject, body)`	`GmailDraft`	Substitui o conteúdo desta mensagem de rascunho.
`update(recipient, subject, body, options)`	`GmailDraft`	Substitui 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 precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

https://mail.google.com/

`getId()`

Recebe 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());

Retornar

String: o ID do rascunho

Autorização

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

https://mail.google.com/

`getMessage()`

Retorna uma GmailMessage que representa esse rascunho.

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

Retornar

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

Autorização

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

https://mail.google.com/

`getMessageId()`

Retorna o ID do 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());

Retornar

String: o ID da mensagem.

Autorização

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

https://mail.google.com/

`send()`

Envia esta mensagem de e-mail de rascunho. O tamanho do e-mail (incluindo cabeçalhos) é limitado pela 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

Retornar

GmailMessage: a mensagem recém-enviada.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos escopos a seguir 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 cabeçalhos) é limitado pela 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

Nome	Tipo	Descrição
`recipient`	`String`	lista separada por vírgulas de endereços de e-mail
`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 precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados 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 desta 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.
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

Nome	Tipo	Descrição
`recipient`	`String`	lista separada por vírgulas de endereços de e-mail
`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, como listado abaixo

Parâmetros avançados

Nome	Tipo	Descrição
`attachments`	`BlobSource[]`	um matriz de arquivos para enviar com o e-mail
`bcc`	`String`	uma lista separada por vírgulas de endereços de e-mail para Cco
`cc`	`String`	uma lista separada por vírgulas de endereços de e-mail para Cc
`from`	`String`	o endereço do qual o e-mail deve ser enviado, que deve ser um dos valores retornados por `GmailApp.getAliases()`
`htmlBody`	`String`	Se definido, ele será usado pelos dispositivos capazes de processar HTML do argumento "body" obrigatório. é possível adicionar um campo `inlineImages` opcional em HTML corpo se você tiver imagens inline para seu e-mail
`inlineImages`	`Object`	um objeto JavaScript que contém um mapeamento da chave de imagem (`String`) aos dados da 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" />`
`name`	`String`	o nome do remetente do e-mail (padrão: o nome do usuário)
`replyTo`	`String`	um endereço de e-mail para ser usado como o endereço padrão para resposta (padrã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 precisam de autorização com um ou mais dos escopos a seguir ou escopos apropriados da API REST relacionada:

https://mail.google.com/

Consulte também

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