Crea una combinación de correo electrónico con Gmail y Hojas de cálculo de Google

Nivel de programación: Principiante
Duración: 10 minutos
Tipo de proyecto: Automatización con un menú personalizado

¿Prefieres aprender con videos?
En el canal de Google Workspace Developers, encontrarás videos sobre sugerencias, trucos y las funciones más recientes.

Objetivos

  • Comprender qué hace la solución
  • Comprender qué hacen los servicios de Apps Script dentro de la solución
  • Configura la secuencia de comandos.
  • Ejecuta la secuencia de comandos.

Acerca de esta solución

Completa automáticamente una plantilla de correo electrónico con datos de Hojas de cálculo de Google. Los correos electrónicos se envían desde tu cuenta de Gmail para que puedas responder las respuestas de los destinatarios.

Importante: Esta muestra de combinación de correspondencia está sujeta a los límites de correo electrónico que se describen en Cuotas de los servicios de Google.

ejemplo de combinación de correo electrónico

Cómo funciona

Creas una plantilla de borrador de Gmail con marcadores de posición que corresponden a datos de una hoja de cálculo de Hojas de cálculo. Cada encabezado de columna en una hoja representa una etiqueta de marcador de posición. La secuencia de comandos envía la información de cada marcador de posición de la hoja de cálculo a la ubicación de la etiqueta de marcador de posición correspondiente en el borrador de tu correo electrónico.

Servicios de Apps Script

En esta solución, se usan los siguientes servicios:

Requisitos previos

Para usar esta muestra, debes cumplir con los siguientes requisitos previos:

  • Una Cuenta de Google (es posible que las cuentas de Google Workspace requieran aprobación del administrador)
  • Un navegador web con acceso a Internet

Configura la secuencia de comandos

Crea el proyecto de Apps Script

  1. Haz clic en el siguiente botón para crear una copia de la hoja de cálculo de ejemplo de Combinación de correspondencia de Gmail/Hojas de cálculo. El proyecto de Apps Script para esta solución se adjunta a la hoja de cálculo.
    Crear una copia
  2. En la hoja de cálculo copiada, actualiza la columna Destinatarios con las direcciones de correo electrónico que deseas usar en la combinación de correspondencia.
  3. (Opcional) Agrega, edita o quita columnas para personalizar los datos que deseas incluir en tu plantilla de correo electrónico.

Si cambias el nombre de las columnas Recipient o Email Sent, debes actualizar el código correspondiente en el proyecto de Apps Script. Para abrir el proyecto de Apps Script desde la hoja de cálculo, haz clic en Extensiones > Apps Script.

Crea una plantilla de correo electrónico

  1. En tu cuenta de Gmail, crea un borrador de correo electrónico. Para incluir datos de la hoja de cálculo en tu correo electrónico, usa marcadores de posición que correspondan a los nombres de las columnas rodeados de llaves, como {{First name}}.
    • Si aplicas formato al texto del correo electrónico, también debes aplicar formato a los corchetes del marcador de posición.
    • Los marcadores de posición distinguen mayúsculas de minúsculas y deben coincidir exactamente con los encabezados de las columnas.
  2. Copia el asunto del borrador de tu correo electrónico.

Ejecuta la secuencia de comandos:

  1. En la hoja de cálculo, haz clic en Combinación de correspondencia > Enviar correos electrónicos. Es posible que debas actualizar la página para que aparezca este menú personalizado.

  2. Cuando se te solicite, autoriza la secuencia de comandos. Si la pantalla de consentimiento de OAuth muestra la advertencia Esta app no está verificada, continúa seleccionando Avanzado > Ir a {nombre del proyecto} (no seguro).

  3. Vuelve a hacer clic en Combinación de correspondencia > Enviar correos electrónicos.

  4. Pega la línea de asunto de la plantilla de correo electrónico y haz clic en Aceptar.

Si aplicaste un filtro a la hoja, la secuencia de comandos seguirá enviando correos electrónicos a los participantes filtrados, pero no agregará la marca de tiempo.

Revisa el código

Para revisar el código de Apps Script de esta solución, haz clic en Ver código fuente a continuación:

Ver el código fuente

Code.gs

solutions/automations/mail-merge/Code.js
// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/automations/mail-merge

/*
Copyright 2022 Martin Hawksey

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/**
 * @OnlyCurrentDoc
*/

/**
 * Change these to match the column names you are using for email 
 * recipient addresses and email sent column.
*/
const RECIPIENT_COL  = "Recipient";
const EMAIL_SENT_COL = "Email Sent";

/** 
 * Creates the menu item "Mail Merge" for user to run scripts on drop-down.
 */
function onOpen() {
  const ui = SpreadsheetApp.getUi();
  ui.createMenu('Mail Merge')
      .addItem('Send Emails', 'sendEmails')
      .addToUi();
}

/**
 * Sends emails from sheet data.
 * @param {string} subjectLine (optional) for the email draft message
 * @param {Sheet} sheet to read data from
*/
function sendEmails(subjectLine, sheet=SpreadsheetApp.getActiveSheet()) {
  // option to skip browser prompt if you want to use this code in other projects
  if (!subjectLine){
    subjectLine = Browser.inputBox("Mail Merge", 
                                      "Type or copy/paste the subject line of the Gmail " +
                                      "draft message you would like to mail merge with:",
                                      Browser.Buttons.OK_CANCEL);

    if (subjectLine === "cancel" || subjectLine == ""){ 
    // If no subject line, finishes up
    return;
    }
  }

  // Gets the draft Gmail message to use as a template
  const emailTemplate = getGmailTemplateFromDrafts_(subjectLine);

  // Gets the data from the passed sheet
  const dataRange = sheet.getDataRange();
  // Fetches displayed values for each row in the Range HT Andrew Roberts 
  // https://mashe.hawksey.info/2020/04/a-bulk-email-mail-merge-with-gmail-and-google-sheets-solution-evolution-using-v8/#comment-187490
  // @see https://developers.google.com/apps-script/reference/spreadsheet/range#getdisplayvalues
  const data = dataRange.getDisplayValues();

  // Assumes row 1 contains our column headings
  const heads = data.shift(); 

  // Gets the index of the column named 'Email Status' (Assumes header names are unique)
  // @see http://ramblings.mcpher.com/Home/excelquirks/gooscript/arrayfunctions
  const emailSentColIdx = heads.indexOf(EMAIL_SENT_COL);

  // Converts 2d array into an object array
  // See https://stackoverflow.com/a/22917499/1027723
  // For a pretty version, see https://mashe.hawksey.info/?p=17869/#comment-184945
  const obj = data.map(r => (heads.reduce((o, k, i) => (o[k] = r[i] || '', o), {})));

  // Creates an array to record sent emails
  const out = [];

  // Loops through all the rows of data
  obj.forEach(function(row, rowIdx){
    // Only sends emails if email_sent cell is blank and not hidden by a filter
    if (row[EMAIL_SENT_COL] == ''){
      try {
        const msgObj = fillInTemplateFromObject_(emailTemplate.message, row);

        // See https://developers.google.com/apps-script/reference/gmail/gmail-app#sendEmail(String,String,String,Object)
        // If you need to send emails with unicode/emoji characters change GmailApp for MailApp
        // Uncomment advanced parameters as needed (see docs for limitations)
        GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
          htmlBody: msgObj.html,
          // bcc: 'a.bcc@email.com',
          // cc: 'a.cc@email.com',
          // from: 'an.alias@email.com',
          // name: 'name of the sender',
          // replyTo: 'a.reply@email.com',
          // noReply: true, // if the email should be sent from a generic no-reply email address (not available to gmail.com users)
          attachments: emailTemplate.attachments,
          inlineImages: emailTemplate.inlineImages
        });
        // Edits cell to record email sent date
        out.push([new Date()]);
      } catch(e) {
        // modify cell to record error
        out.push([e.message]);
      }
    } else {
      out.push([row[EMAIL_SENT_COL]]);
    }
  });

  // Updates the sheet with new data
  sheet.getRange(2, emailSentColIdx+1, out.length).setValues(out);

  /**
   * Get a Gmail draft message by matching the subject line.
   * @param {string} subject_line to search for draft message
   * @return {object} containing the subject, plain and html message body and attachments
  */
  function getGmailTemplateFromDrafts_(subject_line){
    try {
      // get drafts
      const drafts = GmailApp.getDrafts();
      // filter the drafts that match subject line
      const draft = drafts.filter(subjectFilter_(subject_line))[0];
      // get the message object
      const msg = draft.getMessage();

      // Handles inline images and attachments so they can be included in the merge
      // Based on https://stackoverflow.com/a/65813881/1027723
      // Gets all attachments and inline image attachments
      const allInlineImages = draft.getMessage().getAttachments({includeInlineImages: true,includeAttachments:false});
      const attachments = draft.getMessage().getAttachments({includeInlineImages: false});
      const htmlBody = msg.getBody(); 

      // Creates an inline image object with the image name as key 
      // (can't rely on image index as array based on insert order)
      const img_obj = allInlineImages.reduce((obj, i) => (obj[i.getName()] = i, obj) ,{});

      //Regexp searches for all img string positions with cid
      const imgexp = RegExp('<img.*?src="cid:(.*?)".*?alt="(.*?)"[^\>]+>', 'g');
      const matches = [...htmlBody.matchAll(imgexp)];

      //Initiates the allInlineImages object
      const inlineImagesObj = {};
      // built an inlineImagesObj from inline image matches
      matches.forEach(match => inlineImagesObj[match[1]] = img_obj[match[2]]);

      return {message: {subject: subject_line, text: msg.getPlainBody(), html:htmlBody}, 
              attachments: attachments, inlineImages: inlineImagesObj };
    } catch(e) {
      throw new Error("Oops - can't find Gmail draft");
    }

    /**
     * Filter draft objects with the matching subject linemessage by matching the subject line.
     * @param {string} subject_line to search for draft message
     * @return {object} GmailDraft object
    */
    function subjectFilter_(subject_line){
      return function(element) {
        if (element.getMessage().getSubject() === subject_line) {
          return element;
        }
      }
    }
  }

  /**
   * Fill template string with data object
   * @see https://stackoverflow.com/a/378000/1027723
   * @param {string} template string containing {{}} markers which are replaced with data
   * @param {object} data object used to replace {{}} markers
   * @return {object} message replaced with data
  */
  function fillInTemplateFromObject_(template, data) {
    // We have two templates one for plain text and the html body
    // Stringifing the object means we can do a global replace
    let template_string = JSON.stringify(template);

    // Token replacement
    template_string = template_string.replace(/{{[^{}]+}}/g, key => {
      return escapeData_(data[key.replace(/[{}]+/g, "")] || "");
    });
    return  JSON.parse(template_string);
  }

  /**
   * Escape cell data to make JSON safe
   * @see https://stackoverflow.com/a/9204218/1027723
   * @param {string} str to escape JSON special characters from
   * @return {string} escaped string
  */
  function escapeData_(str) {
    return str
      .replace(/[\\]/g, '\\\\')
      .replace(/[\"]/g, '\\\"')
      .replace(/[\/]/g, '\\/')
      .replace(/[\b]/g, '\\b')
      .replace(/[\f]/g, '\\f')
      .replace(/[\n]/g, '\\n')
      .replace(/[\r]/g, '\\r')
      .replace(/[\t]/g, '\\t');
  };
}

Modificaciones

Puedes editar la automatización de la combinación de correspondencia tanto como quieras para que se adapte a tus necesidades. A continuación, se muestran algunos cambios opcionales que puedes realizar en el código fuente.

Agrega parámetros de correo electrónico Cco, Cc, ReplyTo o De

El código de muestra incluye varios parámetros adicionales, que actualmente están comentados, que te permiten controlar el nombre de la cuenta desde la que se envía el correo electrónico, las direcciones de correo electrónico de respuesta, así como las direcciones de correo electrónico de Cco y Cc.

Para activar los parámetros que deseas agregar, quita las barras diagonales // que se encuentran frente a cada uno.

En el siguiente ejemplo, se muestra un extracto de la función sendEmails que activa la mayoría de los parámetros de correo electrónico: 

GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
         htmlBody: msgObj.html,
         bcc: 'bcc@example.com',
         cc: 'cc@example.com',
         from: 'from.alias@example.com',
         name: 'name of the sender',
         replyTo: 'reply@example.com',
        // noReply: true, // if the email should be sent from a generic no-reply email address (not available to gmail.com users)

En el ejemplo anterior, el parámetro noReply aún está comentado porque se configuró el parámetro replyTo.

Cómo incluir caracteres Unicode en tus correos electrónicos

Si deseas incluir caracteres Unicode, como emojis, en tus correos electrónicos, debes actualizar el código para usar el servicio de correo en lugar del servicio de Gmail.

En el código de muestra, actualiza la siguiente línea: 

GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {

Reemplaza la línea por el siguiente código: 

MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {

Colaboradores

El ejemplo fue creado por Martin Hawksey, líder de diseño y tecnología de aprendizaje en el Edinburgh Futures Institute, bloguero y experto en desarrolladores de Google.

Google mantiene esta muestra con la ayuda de expertos en desarrollo de Google.

Próximos pasos