Class GmailDraft

GmailBorrador

Un mensaje de borrador creado por el usuario en su cuenta de Gmail.

Métodos

MétodoTipo de datos que se muestraDescripción breve
deleteDraft()voidBorra este borrador de mensaje.
getId()StringObtiene el ID de este mensaje de borrador.
getMessage()GmailMessageMuestra un GmailMessage que representa este borrador.
getMessageId()StringMuestra el ID del GmailMessage que representa este borrador.
send()GmailMessageEnvía este borrador de mensaje 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 mensaje de borrador 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 ámbitos o los ámbitos 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getMessage()

Muestra 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

  • https://mail.google.com/

getMessageId()

Muestra 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

  • https://mail.google.com/

send()

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

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: 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 ámbitos o los ámbitos 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.
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

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

Volver

GmailDraft: Es 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también


update(recipient, subject, body, options)

Reemplaza el contenido de este mensaje de borrador 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) tiene una cuota limitada.

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

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 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 de direcciones de correo electrónico separadas por comas para 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 devuelve GmailApp.getAliases()
htmlBodyStringSi se establece, los dispositivos capaces de renderizar HTML lo usarán en lugar del argumento de cuerpo obligatorio. Puedes agregar un campo inlineImages opcional 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 imagen (BlobSource). Esto supone que se usa el parámetro htmlBody y contiene referencias a estas imágenes en el formato <img src="cid:imageKey" />
nameStringel nombre del remitente del correo electrónico (predeterminado: el nombre del usuario)
replyToStringUna dirección de correo electrónico que se usará como la dirección de respuesta predeterminada (predeterminada: la dirección de correo electrónico del usuario)

Volver

GmailDraft: Es 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 ámbitos o los ámbitos adecuados de la API de REST relacionada:

  • https://mail.google.com/

Consulta también