Programmierniveau: Anfänger
Dauer: 10 Minuten
Projekttyp: Automatisierung mit einem benutzerdefinierten Menü
Zielsetzungen
- Machen Sie sich mit der Lösung vertraut.
- Informieren Sie sich über die Funktionsweise der Apps Script-Dienste im
Lösung.
- Richten Sie das Skript ein.
- Führen Sie das Skript aus.
Informationen zu dieser Lösung
Eine E-Mail-Vorlage automatisch mit Daten aus Google Tabellen füllen. Die
werden E-Mails von Ihrem Gmail-Konto aus gesendet,
die Antworten von Empfängern.
Wichtig: Dieses Beispiel für die Zusammenstellung von E-Mail-Inhalten unterliegt den angegebenen Beschränkungen für E-Mail-Adressen
Weitere Informationen finden Sie unter Kontingente für Google-Dienste.
Funktionsweise
Sie erstellen einen Gmail-Vorlagenentwurf mit Platzhaltern, die
Daten in einer Google Tabellen-Tabelle entsprechen. Jede Spaltenüberschrift
in einem Tabellenblatt stellt ein Platzhalter-Tag dar. Das Skript sendet die Informationen
aus der Tabelle an die Position des
Platzhalter-Tag in Ihrem E-Mail-Entwurf.
Apps Script-Dienste
Diese Lösung verwendet die folgenden Dienste:
- Gmail-Dienst: Erhält, liest,
und sendet den E-Mail-Entwurf, den Sie senden möchten, an Ihre Empfänger.
- Tabellendienst: E-Mail-Adressen ausfüllen
mit den personalisierten Informationen
für jeden der Empfangenden.
Vorbereitung
Damit Sie dieses Beispiel verwenden können, müssen folgende Voraussetzungen erfüllt sein:
- Ein Google-Konto (Google Workspace-Konten können
Genehmigung des Administrators erforderlich.
- Ein Webbrowser mit Zugriff auf das Internet.
Skript einrichten
Apps Script-Projekt erstellen
- Klicken Sie auf die folgende Schaltfläche, um eine Kopie des
Beispieltabelle für die E-Mail-Zusammenstellung von Gmail und Google Tabellen
Das Apps Script-Projekt dafür
Lösung an die Tabellenkalkulation angehängt.
Kopie erstellen
- Geben Sie in der kopierten Tabelle in der Spalte Empfänger die E-Mail-Adresse ein.
die Sie für die Zusammenstellung von E-Mail-Inhalten verwenden möchten.
- Optional: Sie können Spalten hinzufügen, bearbeiten oder entfernen, um die Daten anzupassen.
in Ihrer E-Mail-Vorlage verwenden.
Wenn Sie den Namen des Empfängers oder der E-Mail-Adresse ändern
Sent enthält, müssen Sie den entsprechenden Code in der Spalte
Apps Script-Projekt Sie können das Apps Script öffnen,
aus der Tabellenkalkulation zu erstellen,
Klicken Sie auf Erweiterungen >
Apps Script
E-Mail-Vorlage erstellen
- Erstellen Sie in Ihrem Gmail-Konto einen E-Mail-Entwurf. Um Daten einzuschließen
aus der
Tabelle in Ihrer E-Mail verwenden, verwenden Sie Platzhalter, die den Spaltennamen entsprechen.
umgeben von geschweiften Klammern, z. B.
{{First name}}.
- Wenn Sie den Text in der E-Mail formatieren, müssen Sie auch den Platzhalter formatieren
Klammern.
- Bei Platzhaltern wird zwischen Groß- und Kleinschreibung unterschieden und sie müssen genau mit den Spaltenüberschriften übereinstimmen.
- Kopieren Sie die Betreffzeile Ihres E-Mail-Entwurfs.
Skript ausführen
- Klicken Sie in der Tabelle auf Zusammenstellung von E-Mail-Inhalten >
E-Mails senden. Möglicherweise müssen Sie die Seite für dieses benutzerdefinierte Menü aktualisieren
angezeigt werden soll.
Autorisieren Sie das Skript, wenn Sie dazu aufgefordert werden.
Wenn auf dem OAuth-Zustimmungsbildschirm die Warnung Diese App wurde nicht überprüft angezeigt wird,
wählen Sie Erweitert > aus.
Rufen Sie {Project Name} auf (unsicher).
Klicken Sie auf E-Mail-Kombifunktion > E-Mails senden.
noch einmal.
Fügen Sie die Betreffzeile der E-Mail-Vorlage ein und klicken Sie auf OK.
Wenn Sie einen Filter auf das Tabellenblatt angewendet haben, sendet das Skript weiterhin eine E-Mail an die gefilterte
Teilnehmer, aber ohne Zeitstempel.
Code ansehen
Um den Apps Script-Code für diese Lösung zu überprüfen, klicken Sie auf
Sehen Sie sich den Quellcode unten an:
Quellcode ansehen
Code.gs
// 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');
};
}
Änderungen
Sie können die Automatisierung der Zusammenstellung von E-Mail-Inhalten beliebig bearbeiten.
Im Folgenden finden Sie einige optionale Änderungen, die Sie am Quellcode vornehmen können.
E-Mail-Parameter „Bcc“, „Cc“, „ReplyTo“ oder „Von“ hinzufügen
Der Beispielcode enthält eine Reihe zusätzlicher Parameter, derzeit
auskommentiert werden, damit Sie den Namen des Kontos steuern können, an das die E-Mail gesendet wird.
von E-Mail-Adressen, Antworten an E-Mail-Adressen sowie Bcc- und Cc-E-Mail-Adressen.
Aktivieren Sie die Parameter, die Sie hinzufügen möchten, indem Sie die Schrägstriche entfernen
// vor jedem Wert.
Das folgende Beispiel zeigt einen Auszug aus der sendEmails
-Funktion, die die meisten E-Mail-Parameter aktiviert:
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)
Im obigen Beispiel ist der Parameter noReply immer noch auskommentiert.
da der Parameter replyTo festgelegt ist.
Verwenden Sie Unicode-Zeichen in Ihren E-Mails.
Wenn Sie Unicode-Zeichen wie Emojis in Ihren E-Mails verwenden möchten,
muss den Code so aktualisieren, dass der E-Mail-Dienst anstelle des Gmail-Dienstes verwendet wird.
Aktualisieren Sie im Beispielcode die folgende Zeile:
GmailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
Ersetzen Sie die Zeile durch den folgenden Code:
MailApp.sendEmail(row[RECIPIENT_COL], msgObj.subject, msgObj.text, {
Beitragende
Das Beispiel wurde von Martin Hawksey, Learning Design and Technology Lead bei
Edinburgh Futures Institute, Blogger und Google Developer Expert.
Dieses Beispiel wird von Google mit Hilfe von Google-Entwicklerexperten verwaltet.
Nächste Schritte
