Class GmailDraft

GmailDraft

Un borrador de mensaje creado por un usuario en la cuenta de Gmail de un usuario.

Métodos

MétodoTipo de datos que se muestraDescripción breve
deleteDraft()voidElimina este borrador del mensaje.
getId()StringObtiene el ID de este borrador de mensaje.
getMessage()GmailMessageMuestra un GmailMessage que representa este borrador.
getMessageId()StringMuestra el ID de la GmailMessage que representa a este borrador.
send()GmailMessageSe envía este borrador de correo electrónico.
update(recipient, subject, body)GmailDraftReemplaza el contenido de este borrador de mensaje.
update(recipient, subject, body, options)GmailDraftReemplaza el contenido de este borrador de mensaje con argumentos opcionales.

Documentación detallada

deleteDraft()

Elimina este borrador del mensaje.

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

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getId()

Obtiene el ID de este borrador de mensaje.

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

Devolvedor

String: Es el ID del borrador.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getMessage()

Muestra un GmailMessage que representa este borrador.

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

Devolvedor

GmailMessage: Es el mensaje que representa el contenido de este borrador.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getMessageId()

Muestra el ID de la GmailMessage que representa a este borrador.

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

Devolvedor

String: Es el ID del mensaje.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

send()

Se envía este borrador de correo electrónico. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

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

Devolvedor

GmailMessage: Es el mensaje que se envió recientemente.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

update(recipient, subject, body)

Reemplaza el contenido de este borrador de mensaje. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// 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

NombreTipoDescripción
recipientStringlista de direcciones de correo electrónico separadas por comas
subjectStringasunto del correo electrónico (250 caracteres como máximo)
bodyStringcuerpo del correo electrónico

Devolvedor

GmailDraft: Es el borrador actualizado recientemente.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también


update(recipient, subject, body, options)

Reemplaza el contenido de este borrador de mensaje con argumentos opcionales. Puede contener texto sin formato o un cuerpo HTML. El tamaño del correo electrónico (incluidos los encabezados) tiene una cuota limitada.

// 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

NombreTipoDescripción
recipientStringlista de direcciones de correo electrónico separadas por comas
subjectStringasunto del correo electrónico (250 caracteres como máximo)
bodyStringcuerpo del correo electrónico
optionsObjectun objeto de JavaScript que especifica parámetros avanzados, como se indica a continuación

Parámetros avanzados

NombreTipoDescripción
attachmentsBlobSource[]un array de archivos para enviar con el correo electrónico
bccStringuna lista separada por comas de direcciones de correo electrónico a Cco
ccStringuna lista de direcciones de correo electrónico separadas por comas para incluir en Cc
fromStringLa dirección desde la que se debe enviar el correo electrónico, que debe ser uno de los valores que muestra GmailApp.getAliases()
htmlBodyStringSi se configura, los dispositivos capaces de renderizar HTML lo usarán en lugar del argumento del cuerpo obligatorio. Puedes agregar un campo opcional inlineImages en el cuerpo HTML si tienes imágenes intercaladas para tu correo electrónico.
inlineImagesObjectun objeto JavaScript que contiene una asignación de la clave de imagen (String) a los datos de la imagen (BlobSource); esto supone que se usa el parámetro htmlBody y que contiene referencias a estas imágenes en el formato <img src="cid:imageKey" />
nameStringel nombre del remitente del correo electrónico (configuración predeterminada: el nombre del usuario)
replyToStringuna dirección de correo electrónico para usar como dirección de respuesta predeterminada (configuración predeterminada: la dirección de correo electrónico del usuario)

Devolvedor

GmailDraft: Es el borrador actualizado recientemente.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o los permisos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también