Cette page a été traduite par l'API Cloud Translation.

Créer un publipostage avec Gmail et Google Sheets

Niveau de programmation : débutant
Durée : 10 minutes
Type de projet : automatisation avec un menu personnalisé

Objectifs

Comprendre ce que fait la solution
Comprendre le rôle des services Apps Script dans la solution
Configurez le script.
Exécutez le script.

À propos de cette solution

Remplissez automatiquement un modèle d'e-mail avec des données issues de Google Sheets. Les e-mails sont envoyés depuis votre compte Gmail, ce qui vous permet de répondre aux destinataires.

Important : Cet exemple de publipostage est soumis aux limites d'envoi d'e-mails décrites dans Quotas pour les services Google.

Exemple de publipostage

Fonctionnement

Vous créez un modèle de brouillon Gmail avec des espaces réservés correspondant aux données d'une feuille de calcul Sheets. Chaque en-tête de colonne d'une feuille représente un tag d'espace réservé. Le script envoie les informations de chaque espace réservé de la feuille de calcul à l'emplacement de la balise d'espace réservé correspondante dans votre brouillon d'e-mail.

Services Apps Script

Cette solution utilise les services suivants :

Service Gmail : récupère, lit et envoie le brouillon d'e-mail que vous souhaitez envoyer à vos destinataires.
- Si votre e-mail inclut des caractères Unicode tels que des emoji, utilisez plutôt le service de messagerie. Découvrez comment mettre à jour le code pour inclure des caractères Unicode dans votre e-mail.
Service de feuille de calcul : remplit les espaces réservés pour les adresses e-mail avec les informations personnalisées pour chacun des destinataires.

Prérequis

Pour utiliser cet exemple, vous devez remplir les conditions préalables suivantes :

Un compte Google (l'approbation de l'administrateur peut être nécessaire pour les comptes Google Workspace).
Un navigateur Web avec accès à Internet.

Configurer le script

Créer le projet Apps Script

Cliquez sur le bouton suivant pour créer une copie de l'exemple de feuille de calcul Publipostage Gmail/Sheets. Le projet Apps Script de cette solution est associé à la feuille de calcul.
Créer une copie
Dans la feuille de calcul que vous avez copiée, mettez à jour la colonne Destinataires avec les adresses e-mail que vous souhaitez utiliser dans le publipostage.
(Facultatif) Ajoutez, modifiez ou supprimez des colonnes pour personnaliser les données à inclure dans votre modèle d'e-mail.

Si vous modifiez le nom des colonnes Destinataire ou E-mail envoyé, vous devez mettre à jour le code correspondant dans le projet Apps Script. Vous pouvez ouvrir le projet Apps Script à partir de la feuille de calcul en cliquant sur Extensions > Apps Script.

Créer un modèle d'e-mail

Dans votre compte Gmail, créez un brouillon d'e-mail. Pour inclure des données de la feuille de calcul dans votre e-mail, utilisez des espaces réservés correspondant aux noms de colonnes entre accolades, comme {{First name}}.
- Si vous mettez en forme le texte de l'e-mail, vous devez également mettre en forme les crochets des espaces réservés.
- Les espaces réservés sont sensibles à la casse et doivent correspondre exactement aux en-têtes de colonne.
Copiez l'objet de votre brouillon d'e-mail.

Exécuter le script

Dans la feuille de calcul, cliquez sur Publipostage > Envoyer des e-mails. Vous devrez peut-être actualiser la page pour que ce menu personnalisé s'affiche.
Lorsque vous y êtes invité, autorisez le script. Si l'écran de consentement OAuth affiche l'avertissement Cette application n'est pas validée, poursuivez en sélectionnant Avancé > Accéder à {Nom du projet} (non sécurisé).
Cliquez à nouveau sur Publipostage > Envoyer des e-mails.
Collez l'objet du modèle d'e-mail, puis cliquez sur OK.

Si vous avez appliqué un filtre à la feuille, le script envoie toujours un e-mail aux participants filtrés, mais il n'ajoute pas le code temporel.

Examiner le code

Pour consulter le code Apps Script de cette solution, cliquez sur Afficher le code source ci-dessous :

Afficher le code source

Code.gs

solutions/automations/mail-merge/Code.js

Afficher sur GitHub

// 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');
  };
}

Modifications

Vous pouvez modifier l'automatisation du publipostage autant que vous le souhaitez pour l'adapter à vos besoins. Vous trouverez ci-dessous quelques modifications facultatives que vous pouvez apporter au code source.

Ajouter des paramètres d'adresse e-mail Cci, Cc, Réponse à ou De

L'exemple de code inclut un certain nombre de paramètres supplémentaires, actuellement mis en commentaire, qui vous permettent de contrôler le nom du compte à partir duquel l'e-mail est envoyé, les adresses e-mail de réponse, ainsi que les adresses e-mail en copie cachée et en copie.

Activez les paramètres que vous souhaitez ajouter en supprimant les barres obliques // devant chacun d'eux.

L'exemple suivant montre un extrait de la fonction sendEmails qui active la plupart des paramètres d'e-mail :

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)

Dans l'exemple ci-dessus, le paramètre noReply est toujours mis en commentaire, car le paramètre replyTo est défini.

Inclure des caractères Unicode dans vos e-mails

Si vous souhaitez inclure des caractères Unicode, tels que des emojis, dans vos e-mails, vous devez mettre à jour le code pour utiliser le service de messagerie au lieu du service Gmail.

Dans l'exemple de code, modifiez la ligne suivante :

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

Remplacez la ligne par le code suivant :

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

Contributeurs

L'exemple a été créé par Martin Hawksey, responsable de la conception et de la technologie de l'apprentissage à l'Edinburgh Futures Institute, blogueur et expert Google Developer.

Retrouvez Martin sur Twitter : @mhawksey.
Lisez les articles de blog de Martin sur Google Apps Script.
Regardez l'émission YouTube de Martin, Totally Unscripted.

Cet exemple est géré par Google avec l'aide des Google Developer Experts.

Créer un publipostage avec Gmail et Google Sheets Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.