Es un borrador de mensaje creado por el usuario en su cuenta de Gmail.
Métodos
| Método | Tipo de datos que se devuelve | Descripción breve |
|---|---|---|
delete | void | Borra este borrador de mensaje. |
get | String | Obtiene el ID de este mensaje de borrador. |
get | Gmail | Devuelve un GmailMessage que representa este borrador. |
get | String | Devuelve el ID del Gmail que representa este borrador. |
send() | Gmail | Envía este mensaje de correo electrónico en borrador. |
update(recipient, subject, body) | Gmail | Reemplaza el contenido de este mensaje de borrador. |
update(recipient, subject, body, options) | Gmail | Reemplaza el contenido de este borrador de mensaje con argumentos opcionales. |
Documentación detallada
deleteDraft()
Borra este borrador de mensaje.
const 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 alcances adecuados de la API de REST relacionada:
-
https://mail.google.com/
getId()
Obtiene el ID de este mensaje de borrador.
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(), );
Volver
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 alcances adecuados de la API de REST relacionada:
-
https://mail.google.com/
getMessage()
Devuelve un GmailMessage que representa este borrador.
const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder const message = draft.getMessage(); Logger.log(message.getSubject());
Volver
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 alcances adecuados de la API de REST relacionada:
-
https://mail.google.com/
getMessageId()
Devuelve el ID del GmailMessage que representa este borrador.
const draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder const messageId = draft.getMessageId(); Logger.log(messageId === draft.getMessage().getId());
Volver
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 alcances adecuados de la API de REST relacionada:
-
https://mail.google.com/
send()
Envía este mensaje de correo electrónico en borrador. El tamaño del correo electrónico (incluidos los encabezados) está limitado por la cuota.
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
Volver
GmailMessage: El mensaje que se acaba de enviar
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:
-
https://mail.google.com/
update(recipient, subject, body)
Reemplaza el contenido de este mensaje de borrador. El tamaño del correo electrónico (incluidos los encabezados) está limitado por la cuota.
// 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( 'mike@example.com', 'current time', `The time is: ${now.toString()}`, );
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
recipient | String | Lista de direcciones de correo electrónico separadas por comas |
subject | String | Asunto del correo electrónico (250 caracteres como máximo) |
body | String | cuerpo del correo electrónico |
Volver
GmailDraft: El borrador recién actualizado
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances 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. El correo electrónico puede contener texto sin formato o un cuerpo HTML. El tamaño del correo electrónico (incluidos los encabezados) está limitado por la cuota.
// 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( 'mike@example.com', 'Attachment example', 'Please see attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script', }, );
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
recipient | String | Lista de direcciones de correo electrónico separadas por comas |
subject | String | Asunto del correo electrónico (250 caracteres como máximo) |
body | String | cuerpo del correo electrónico |
options | Object | Un objeto JavaScript que especifica parámetros avanzados, como se indica a continuación |
Parámetros avanzados
| Nombre | Tipo | Descripción |
|---|---|---|
attachments | Blob | un array de archivos para enviar con el correo electrónico |
bcc | String | Una lista de direcciones de correo electrónico separadas por comas para incluir en CCO |
cc | String | Una lista de direcciones de correo electrónico separadas por comas para incluir en Cc |
from | String | La dirección desde la que se debe enviar el correo electrónico, que debe ser uno de los valores que devuelve Gmail |
html | String | Si se configura, los dispositivos capaces de renderizar HTML lo usarán en lugar del argumento body obligatorio. Puedes agregar un campo inline opcional en el cuerpo HTML si tienes imágenes intercaladas para tu correo electrónico. |
inline | Object | Un objeto JavaScript que contiene una asignación de la clave de la imagen (String) a los datos de la imagen (Blob). Se supone que se usa el parámetro html y que contiene referencias a estas imágenes en el formato <img src="cid:imageKey" /> |
name | String | El nombre del remitente del correo electrónico (de forma predeterminada, el nombre del usuario) |
reply | String | una dirección de correo electrónico para usar como dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario) |
Volver
GmailDraft: El borrador recién actualizado
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances o alcances adecuados de la API de REST relacionada:
-
https://mail.google.com/