Class GmailApp

Gmail App

Bietet Zugriff auf Gmail-Threads, -Nachrichten und -Labels.

Methoden

MethodeRückgabetypKurzbeschreibung
createDraft(recipient, subject, body)GmailDraftErstellt einen E-Mail-Entwurf.
createDraft(recipient, subject, body, options)GmailDraftErstellt einen Nachrichtenentwurf mit optionalen Argumenten.
createLabel(name)GmailLabelErstellen Sie ein neues Nutzerlabel mit dem angegebenen Namen.
deleteLabel(label)GmailAppDas angegebene Label wird gelöscht.
getAliases()String[]Ruft eine Liste der E-Mails ab, die als Aliasse für dieses Konto in Gmail eingerichtet sind.
getDraft(draftId)GmailDraftRufen Sie einen E-Mail-Nachrichtenentwurf nach ID ab.
getDraftMessages()GmailMessage[]Ruft alle Entwürfe ab.
getDrafts()GmailDraft[]Ruft alle Gmail-Nachrichtenentwürfe ab.
getInboxThreads()GmailThread[]Ruft alle Posteingangsthreads unabhängig von Labels ab.
getInboxThreads(start, max)GmailThread[]Ruft eine Reihe von Posteingangsthreads ab, unabhängig von Labels.
getInboxUnreadCount()IntegerRuft die Anzahl der ungelesenen Threads im Posteingang ab.
getMessageById(id)GmailMessageRuft eine Nachricht nach ID ab.
getMessagesForThread(thread)GmailMessage[]Alle Nachrichten in der angegebenen Unterhaltung abrufen.
getMessagesForThreads(threads)GmailMessage[][]Alle Nachrichten in den angegebenen Threads abrufen.
getPriorityInboxThreads()GmailThread[]Ruft unabhängig von Labels alle Konversationen im sortierten Eingang ab.
getPriorityInboxThreads(start, max)GmailThread[]Ruft unabhängig von Labels eine Reihe von Threads im sortierten Eingang ab.
getPriorityInboxUnreadCount()IntegerRuft die Anzahl der ungelesenen Threads im sortierten Eingang ab.
getSpamThreads()GmailThread[]Ruft unabhängig von Labels alle Spam-Threads ab.
getSpamThreads(start, max)GmailThread[]Ruft eine Reihe von Spamthreads ab, unabhängig von Labels.
getSpamUnreadCount()IntegerRuft die Anzahl der ungelesenen Threads ab, die Spam sind.
getStarredThreads()GmailThread[]Ruft unabhängig von Labels alle markierten Threads ab.
getStarredThreads(start, max)GmailThread[]Ruft unabhängig von Labels einen Bereich von markierten Threads ab.
getStarredUnreadCount()IntegerRuft die Anzahl der ungelesenen Threads ab, die markiert sind.
getThreadById(id)GmailThreadRuft einen Thread nach ID ab.
getTrashThreads()GmailThread[]Ruft alle Papierkorb-Threads unabhängig von Labels ab.
getTrashThreads(start, max)GmailThread[]Ruft unabhängig von Labels einen Bereich von Papierkorb-Threads ab.
getUserLabelByName(name)GmailLabelRuft ein Label mit dem Labelnamen ab.
getUserLabels()GmailLabel[]Ruft eine Liste mit von Nutzern erstellten Labels ab.
markMessageRead(message)GmailAppDie Nachricht wird als gelesen markiert und ihre Aktualisierung erzwungen.
markMessageUnread(message)GmailAppDadurch wird die Nachricht als ungelesen markiert und eine Aktualisierung erzwungen.
markMessagesRead(messages)GmailAppMarkieren Sie diese Nachrichten als gelesen und erzwingen die Aktualisierung.
markMessagesUnread(messages)GmailAppDiese Nachrichten werden als ungelesen markiert und mit einer erzwungenen Aktualisierung aktualisiert.
markThreadImportant(thread)GmailAppMarkiert diesen Thread als wichtig und erzwingt die Aktualisierung.
markThreadRead(thread)GmailAppMarkiert diesen Thread als gelesen und erzwingt die Aktualisierung.
markThreadUnimportant(thread)GmailAppMarkiert diesen Thread als unwichtig und erzwingt die Aktualisierung.
markThreadUnread(thread)GmailAppMarkiert diesen Thread als ungelesen und erzwingt die Aktualisierung.
markThreadsImportant(threads)GmailAppKennzeichnet diese Threads als wichtig und erzwingt die Aktualisierung.
markThreadsRead(threads)GmailAppKennzeichnet diese Threads als gelesen und erzwingt die Aktualisierung.
markThreadsUnimportant(threads)GmailAppKennzeichnet diese Threads als unwichtig und zwingt die Aktualisierung.
markThreadsUnread(threads)GmailAppKennzeichnet diese Threads als ungelesen und erzwingt die Aktualisierung.
moveMessageToTrash(message)GmailAppDie Nachricht wird in den Papierkorb verschoben und die Aktualisierung wird erzwungen.
moveMessagesToTrash(messages)GmailAppDie angegebenen Nachrichten werden in den Papierkorb verschoben und die Aktualisierung wird erzwungen.
moveThreadToArchive(thread)GmailAppVerschiebt diesen Thread in das Archiv und erzwingt die Aktualisierung.
moveThreadToInbox(thread)GmailAppVerschiebt diesen Thread in den Posteingang und erzwingt die Aktualisierung.
moveThreadToSpam(thread)GmailAppVerschiebt diesen Thread in den Spam-Ordner und erzwingt die Aktualisierung.
moveThreadToTrash(thread)GmailAppVerschiebt diesen Thread in den Papierkorb und erzwingt die Aktualisierung.
moveThreadsToArchive(threads)GmailAppVerschiebt diese Threads in das Archiv und erzwingt die Aktualisierung.
moveThreadsToInbox(threads)GmailAppVerschiebt diese Threads in den Posteingang und erzwingt die Aktualisierung.
moveThreadsToSpam(threads)GmailAppVerschiebt diese Threads in den Spamordner und erzwingt die Aktualisierung.
moveThreadsToTrash(threads)GmailAppVerschiebt diese Threads in den Papierkorb und erzwingt die Aktualisierung.
refreshMessage(message)GmailAppDie Nachricht und der zugehörige Status aus Gmail werden neu geladen. Dies ist nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben.
refreshMessages(messages)GmailAppDie Nachrichten und der zugehörige Status aus Gmail werden neu geladen. Dies ist nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben.
refreshThread(thread)GmailAppDer Thread und der zugehörige Status aus Gmail werden neu geladen. Dies ist nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben.
refreshThreads(threads)GmailAppDie Threads und der zugehörige Status aus Gmail werden neu geladen. Dies ist nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben.
search(query)GmailThread[]Mit der angegebenen Abfrage in Gmail suchen
search(query, start, max)GmailThread[]Mit der angegebenen Abfrage in Gmail suchen
sendEmail(recipient, subject, body)GmailAppEs wird eine E-Mail gesendet.
sendEmail(recipient, subject, body, options)GmailAppSendet eine E-Mail-Nachricht mit optionalen Argumenten.
setCurrentMessageAccessToken(accessToken)voidLegt das aktuelle Zugriffstoken für Nachrichten fest, mit dem das Skript auf die aktuellen GmailMessage-Attribute zugreifen kann.
starMessage(message)GmailAppDadurch wird der Nachricht ein Stern hinzugefügt und die Aktualisierung wird erzwungen.
starMessages(messages)GmailAppDiese Nachrichten werden mit einem Stern markiert und gezwungen, die Nachrichten zu aktualisieren.
unstarMessage(message)GmailAppDie Markierung wird entfernt und die Nachricht wird aktualisiert.
unstarMessages(messages)GmailAppEntfernt Sterne aus diesen Nachrichten und erzwingt, dass die Nachrichten aktualisiert werden müssen.

Detaillierte Dokumentation

createDraft(recipient, subject, body)

Erstellt einen E-Mail-Entwurf. Die Größe der E-Mail (einschließlich Header) ist Kontingent begrenzt.

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

Parameter

NameTypBeschreibung
recipientStringDurch Kommas getrennte Liste der E-Mail-Adressen
subjectStringBetreff der E-Mail
bodyStringE-Mail-Text

Zurücksenden

GmailDraft: Der neu erstellte Gmail-Entwurf

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


createDraft(recipient, subject, body, options)

Erstellt einen Nachrichtenentwurf mit optionalen Argumenten. Die E-Mail kann im Nur-Text- oder HTML-Textformat vorliegen. Die Größe der E-Mail (einschließlich Header, aber ohne Anhänge) ist Kontingent begrenzt.

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parameter

NameTypBeschreibung
recipientStringdie Adressen des Empfängers
subjectStringBetreff
bodyStringder E-Mail-Text
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]ein Array von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine kommagetrennte Liste von E-Mail-Adressen für Bcc
ccStringeine durch Kommas getrennte Liste der E-Mail-Adressen, die auf „Cc“ gesetzt werden sollen
fromStringDie Adresse, von der aus die E-Mail gesendet werden soll. Dies muss einer der Werte sein, die von getAliases() zurückgegeben werden.
htmlBodyStringWenn festgelegt, wird für Geräte, die HTML rendern können, anstelle des erforderlichen Textarguments verwendet. Sie können ein optionales inlineImages-Feld im HTML-Textkörper hinzufügen, wenn Sie Inline-Bilder für Ihre E-Mail haben.
inlineImagesObjectEin JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu Bilddaten (BlobSource) enthält. Dabei wird davon ausgegangen, dass der Parameter htmlBody verwendet wird. Er enthält Verweise auf diese Bilder im Format <img src="cid:imageKey" />.
nameStringName des Absenders der E-Mail (Standard: Name des Nutzers)
replyToStringeine E-Mail-Adresse, die als standardmäßige Antwortadresse verwendet werden soll (Standard: E-Mail-Adresse des Nutzers)

Zurücksenden

GmailDraft: Der neu erstellte Gmail-Entwurf

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


createLabel(name)

Erstellen Sie ein neues Nutzerlabel mit dem angegebenen Namen.

// Creates the label @FOO and logs label: FOO
Logger.log("label: " + GmailApp.createLabel("FOO"));

Parameter

NameTypBeschreibung
nameStringName des neuen Labels

Zurücksenden

GmailLabel: Das neu erstellte Label

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


deleteLabel(label)

Das angegebene Label wird gelöscht.

// Have to get the label by name first
var label = GmailApp.getUserLabelByName("FOO");
GmailApp.deleteLabel(label);

Parameter

NameTypBeschreibung
labelGmailLabeldas zu löschende Label

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getAliases()

Ruft eine Liste der E-Mails ab, die als Aliasse für dieses Konto in Gmail eingerichtet sind.

Sie können eine Nachricht von einem dieser Aliasse senden, indem Sie das optionale Argument „from“ verwenden.

// Log the aliases for this Gmail account and send an email as the first one.
var me = Session.getActiveUser().getEmail();
var aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]});
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

Zurücksenden

String[]: ein Array von Aliassen für dieses Konto

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getDraft(draftId)

Rufen Sie einen E-Mail-Nachrichtenentwurf nach ID ab.

Verwenden Sie diese Option in Verbindung mit „getId()“ für Gmail-Entwürfe.

// Get the first draft message in your drafts folder
var draft = GmailApp.getDrafts()[0];
// Get its ID
var draftId = draft.getId();
// Now fetch the same draft using that ID.
var draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

Parameter

NameTypBeschreibung
draftIdStringDie ID des abzurufenden Entwurfs

Zurücksenden

GmailDraft: Der Entwurf mit der angegebenen ID

Throws

Error: Wenn kein Entwurf mit der angegebenen ID gefunden werden kann

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getDraftMessages()

Ruft alle Entwürfe ab.

// Logs the number of draft messages
var drafts = GmailApp.getDraftMessages();
Logger.log(drafts.length);

Zurücksenden

GmailMessage[]: ein Array von Gmail-Nachrichtenentwürfen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getDrafts()

Ruft alle Gmail-Nachrichtenentwürfe ab.

var drafts = GmailApp.getDrafts();
for (var i = 0; i < drafts.length; i++) {
  Logger.log(drafts[i].getId());
}

Zurücksenden

GmailDraft[]: ein Array von Gmail-Nachrichtenentwürfen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getInboxThreads()

Ruft alle Posteingangsthreads unabhängig von Labels ab.

Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Wenn die Thread-Größe unbekannt und möglicherweise sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.

// Log the subject lines of your Inbox
var threads = GmailApp.getInboxThreads();
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Zurücksenden

GmailThread[]: ein Array von Gmail-Threads im Posteingang

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getInboxThreads(start, max)

Ruft eine Reihe von Posteingangsthreads ab, unabhängig von Labels.

// Log the subject lines of up to the first 50 emails in your Inbox
var threads = GmailApp.getInboxThreads(0, 50);
for (var i = 0; i < threads.length; i++) {
  Logger.log(threads[i].getFirstMessageSubject());
}

Parameter

NameTypBeschreibung
startIntegerIndex des ersten abzurufenden Threads
maxIntegerdie maximale Anzahl der abzurufenden Threads

Zurücksenden

GmailThread[]: ein Array von Gmail-Threads im Posteingang

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getInboxUnreadCount()

Ruft die Anzahl der ungelesenen Threads im Posteingang ab.

Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());

Zurücksenden

Integer: Anzahl der Threads im Posteingang, die ungelesene Nachrichten enthalten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getMessageById(id)

Ruft eine Nachricht nach ID ab.

Verwenden Sie dieses Attribut in Verbindung mit „getId()“ für Gmail-Nachrichten.

// Get the first message in the first thread of your inbox
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
var messageId = message.getId();
// Now fetch the same message using that ID.
var messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() == messageById.getSubject());

Parameter

NameTypBeschreibung
idStringDie ID der abzurufenden Nachricht

Zurücksenden

GmailMessage: Die Nachricht mit der angegebenen ID

Throws

Error: Wenn keine Nachricht mit der angegebenen ID gefunden werden kann

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getMessagesForThread(thread)

Alle Nachrichten in der angegebenen Unterhaltung abrufen.

// Log all the subject lines in the first thread of your inbox
var thread = GmailApp.getInboxThreads(0, 1)[0];
var messages = GmailApp.getMessagesForThread(thread);
for (var i = 0 ; i < messages.length; i++) {
  Logger.log("subject: " + messages[i].getSubject());
}

Parameter

NameTypBeschreibung
threadGmailThreadNachrichtenthread, der abgerufen werden soll

Zurücksenden

GmailMessage[]: Array von Nachrichten, die diesem Thread entsprechen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getMessagesForThreads(threads)

Alle Nachrichten in den angegebenen Threads abrufen.

// Log the subject lines of all messages in the first two threads of your inbox
var thread = GmailApp.getInboxThreads(0, 2);
var messages = GmailApp.getMessagesForThreads(thread);
for (var i = 0 ; i < messages.length; i++) {
  for (var j = 0; j < messages[i].length; j++) {
    Logger.log("subject: " + messages[i][j].getSubject());
  }
}

Parameter

NameTypBeschreibung
threadsGmailThread[]die abzurufenden Threads

Zurücksenden

GmailMessage[][]: ein Array von Nachrichten, wobei jedes Element im äußeren Array einem Thread entspricht und das innere Array die Nachrichten in diesem Thread enthält

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getPriorityInboxThreads()

Ruft unabhängig von Labels alle Konversationen im sortierten Eingang ab.

Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Wenn die Thread-Größe unbekannt und möglicherweise sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.

Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads().length);

Zurücksenden

GmailThread[]: ein Array von Gmail-Threads im sortierten Eingang

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

Ruft unabhängig von Labels eine Reihe von Threads im sortierten Eingang ab.

// Will log some number 2 or less
Logger.log("# of messages in your Priority Inbox: " +
           GmailApp.getPriorityInboxThreads(0, 2).length);

Parameter

NameTypBeschreibung
startIntegerIndex des ersten abzurufenden Threads
maxIntegerdie maximale Anzahl der abzurufenden Threads

Zurücksenden

GmailThread[]: ein Array von Gmail-Threads im sortierten Eingang

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getPriorityInboxUnreadCount()

Ruft die Anzahl der ungelesenen Threads im sortierten Eingang ab.

Logger.log("Number of unread emails in your Priority Inbox : " +
           GmailApp.getPriorityInboxUnreadCount());

Zurücksenden

Integer: Anzahl der Threads im sortierten Eingang, die ungelesene Nachrichten enthalten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getSpamThreads()

Ruft unabhängig von Labels alle Spam-Threads ab.

Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Wenn die Thread-Größe unbekannt und möglicherweise sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.

Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);

Zurücksenden

GmailThread[]: ein Array von Gmail-Threads im Spamordner

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getSpamThreads(start, max)

Ruft eine Reihe von Spamthreads ab, unabhängig von Labels.

// Will log a number at most 5
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads(0, 5).length);

Parameter

NameTypBeschreibung
startIntegerIndex des ersten abzurufenden Threads
maxIntegerdie maximale Anzahl der abzurufenden Threads

Zurücksenden

GmailThread[]: ein Array von Gmail-Threads im Spamordner

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getSpamUnreadCount()

Ruft die Anzahl der ungelesenen Threads ab, die Spam sind.

// Unless you actually read stuff in your spam folder, this should be the same as
// the number of messages in your spam folder.
Logger.log("# unread threads that are spam: " + GmailApp.getSpamUnreadCount());

Zurücksenden

Integer: Anzahl der Spam-Threads mit ungelesenen Nachrichten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getStarredThreads()

Ruft unabhängig von Labels alle markierten Threads ab.

Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Wenn die Thread-Größe unbekannt und möglicherweise sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.

// Logs the number of starred threads
Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);

Zurücksenden

GmailThread[]: ein Array mit markierten Gmail-Threads

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getStarredThreads(start, max)

Ruft unabhängig von Labels einen Bereich von markierten Threads ab.

// Logs the number of starred threads to a maximum of 5
Logger.log("# Starred threads: " + GmailApp.getStarredThreads(0, 5).length);

Parameter

NameTypBeschreibung
startIntegerIndex des ersten abzurufenden Threads
maxIntegerdie maximale Anzahl der abzurufenden Threads

Zurücksenden

GmailThread[]: ein Array mit markierten Gmail-Threads

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getStarredUnreadCount()

Ruft die Anzahl der ungelesenen Threads ab, die markiert sind.

Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());

Zurücksenden

Integer: Anzahl der markierten Unterhaltungen mit ungelesenen Nachrichten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getThreadById(id)

Ruft einen Thread nach ID ab.

Verwenden Sie diese Option in Verbindung mit „getId()“ für Gmail-Threads.

// Thread IDs can also be found in the location bar when you have a thread open in Gmail
// get first inbox thread
var firstThread = GmailApp.getInboxThreads(0,1)[0];
// Get the same thread by ID
var threadById = GmailApp.getThreadById(firstThread.getId());
// Verify they are the same
Logger.log(firstThread.getFirstMessageSubject() == threadById.getFirstMessageSubject());

Parameter

NameTypBeschreibung
idStringDie ID des abzurufenden Threads

Zurücksenden

GmailThread: Der Thread mit der angegebenen ID oder null, wenn nicht gefunden

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getTrashThreads()

Ruft alle Papierkorb-Threads unabhängig von Labels ab.

Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Wenn die Thread-Größe unbekannt und möglicherweise sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.

Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);

Zurücksenden

GmailThread[]: ein Array von Gmail-Threads im Papierkorb

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getTrashThreads(start, max)

Ruft unabhängig von Labels einen Bereich von Papierkorb-Threads ab.

// Will log a number at most 5
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);

Parameter

NameTypBeschreibung
startIntegerIndex des ersten abzurufenden Threads
maxIntegerdie maximale Anzahl der abzurufenden Threads

Zurücksenden

GmailThread[]: ein Array von Gmail-Threads im Papierkorb

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getUserLabelByName(name)

Ruft ein Label mit dem Labelnamen ab.

var labelObject = GmailApp.getUserLabelByName("myLabel");

Parameter

NameTypBeschreibung
nameStringName des abzurufenden Labels

Zurücksenden

GmailLabel: Das Gmail-Label mit dem angegebenen Namen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getUserLabels()

Ruft eine Liste mit von Nutzern erstellten Labels ab.

// Logs all of the names of your labels
var labels = GmailApp.getUserLabels();
for (var i = 0; i < labels.length; i++) {
  Logger.log("label: " + labels[i].getName());
}

Zurücksenden

GmailLabel[]: Array mit von Nutzern erstellten Labels

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

markMessageRead(message)

Die Nachricht wird als gelesen markiert und ihre Aktualisierung erzwungen.

// Mark the first message in the first thread of your inbox as read
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageRead(message);

Parameter

NameTypBeschreibung
messageGmailMessagedie Nachricht, die als gelesen markiert werden soll

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markMessageUnread(message)

Dadurch wird die Nachricht als ungelesen markiert und eine Aktualisierung erzwungen.

// Mark the first message in the first thread of your inbox as unread
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Parameter

NameTypBeschreibung
messageGmailMessagedie Nachricht, die als ungelesen markiert werden soll

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markMessagesRead(messages)

Markieren Sie diese Nachrichten als gelesen und erzwingen die Aktualisierung.

// Mark first three messages in the first inbox thread as read.
// Assumes that the first inbox thread has 3 messages in it.
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(thread.getMessages());

Parameter

NameTypBeschreibung
messagesGmailMessage[]ein Array von Nachrichten, die als gelesen markiert werden sollen

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markMessagesUnread(messages)

Diese Nachrichten werden als ungelesen markiert und mit einer erzwungenen Aktualisierung aktualisiert.

// Mark first three messages in the first inbox thread as unread.
// Assumes that the first inbox thread has 3 messages in it
var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
var messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesUnread(thread.getMessages());

Parameter

NameTypBeschreibung
messagesGmailMessage[]Ein Array von Nachrichten, die als ungelesen markiert werden sollen

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadImportant(thread)

Markiert diesen Thread als wichtig und erzwingt die Aktualisierung.

// Marks first inbox thread as important
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Parameter

NameTypBeschreibung
threadGmailThreadden Thread als wichtig zu markieren

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadRead(thread)

Markiert diesen Thread als gelesen und erzwingt die Aktualisierung.

// Marks first inbox thread as read
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadRead(thread);

Parameter

NameTypBeschreibung
threadGmailThreadder Thread, der als gelesen markiert werden soll

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadUnimportant(thread)

Markiert diesen Thread als unwichtig und erzwingt die Aktualisierung.

// Marks first inbox thread as unimportant
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnimportant(thread);

Parameter

NameTypBeschreibung
threadGmailThreadden Thread als unwichtig zu markieren

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadUnread(thread)

Markiert diesen Thread als ungelesen und erzwingt die Aktualisierung.

// Marks first inbox thread as unread
var thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadUnread(thread);

Parameter

NameTypBeschreibung
threadGmailThreadder Thread, der als ungelesen markiert werden soll

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadsImportant(threads)

Kennzeichnet diese Threads als wichtig und erzwingt die Aktualisierung.

// Marks first two threads in inbox as important
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Parameter

NameTypBeschreibung
threadsGmailThread[]ein Array mit Threads, die als wichtig markiert werden sollen

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadsRead(threads)

Kennzeichnet diese Threads als gelesen und erzwingt die Aktualisierung.

// Marks first two threads in inbox as read
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

Parameter

NameTypBeschreibung
threadsGmailThread[]ein Array von Threads, die als gelesen markiert werden sollen

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadsUnimportant(threads)

Kennzeichnet diese Threads als unwichtig und zwingt die Aktualisierung.

// Marks first two threads in inbox as unimportant
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnimportant(threads);

Parameter

NameTypBeschreibung
threadsGmailThread[]ein Array von Threads, die als unwichtig markiert werden sollen

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadsUnread(threads)

Kennzeichnet diese Threads als ungelesen und erzwingt die Aktualisierung.

// Marks first two threads in inbox as unread
var threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsUnread(threads);

Parameter

NameTypBeschreibung
threadsGmailThread[]ein Array von Threads, die als ungelesen markiert werden sollen

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveMessageToTrash(message)

Die Nachricht wird in den Papierkorb verschoben und die Aktualisierung wird erzwungen.

// Move the first message in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
GmailApp.moveMessageToTrash(firstMessage);

Parameter

NameTypBeschreibung
messageGmailMessagedie Nachricht, die in den Papierkorb verschoben werden soll

Zurücksenden

GmailApp: Der Gmail-Dienst (nützlich für Verkettung)

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveMessagesToTrash(messages)

Die angegebenen Nachrichten werden in den Papierkorb verschoben und die Aktualisierung wird erzwungen.

// Move first two messages in your inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var messages = firstThread.getMessages();
var toDelete = [messages[0], messages[1]];
GmailApp.moveMessagesToTrash(toDelete);

Parameter

NameTypBeschreibung
messagesGmailMessage[]Nachrichten, die in den Papierkorb verschoben werden sollen

Zurücksenden

GmailApp: Der Gmail-Dienst (nützlich für Verkettung)

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadToArchive(thread)

Verschiebt diesen Thread in das Archiv und erzwingt die Aktualisierung.

// Archive the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToArchive(firstThread);

Parameter

NameTypBeschreibung
threadGmailThreadder zu archivierende Thread

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadToInbox(thread)

Verschiebt diesen Thread in den Posteingang und erzwingt die Aktualisierung.

// Find a thread not already in your inbox
var thread = GmailApp.search("-in:inbox")[0]; // Get the first one
GmailApp.moveThreadToInbox(thread);

Parameter

NameTypBeschreibung
threadGmailThreadder Thread, der in den Posteingang verschoben werden soll

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadToSpam(thread)

Verschiebt diesen Thread in den Spam-Ordner und erzwingt die Aktualisierung.

// Tag first thread in inbox as spam
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToSpam(firstThread);

Parameter

NameTypBeschreibung
threadGmailThreaddie Unterhaltung in den Spamordner verschoben werden soll

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadToTrash(thread)

Verschiebt diesen Thread in den Papierkorb und erzwingt die Aktualisierung.

// Move first thread in inbox to trash
var firstThread = GmailApp.getInboxThreads(0,1)[0];
GmailApp.moveThreadToTrash(firstThread);

Parameter

NameTypBeschreibung
threadGmailThreaddie Unterhaltung, die in den Papierkorb verschoben werden soll

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToArchive(threads)

Verschiebt diese Threads in das Archiv und erzwingt die Aktualisierung.

// Move first two threads in your inbox to the archive
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToArchive(firstTwoThreads);

Parameter

NameTypBeschreibung
threadsGmailThread[]ein zu archivierendes Array von Threads

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToInbox(threads)

Verschiebt diese Threads in den Posteingang und erzwingt die Aktualisierung.

// Find two threads not already in your inbox
var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2);
GmailApp.moveThreadsToInbox(firstTwoThreads);

Parameter

NameTypBeschreibung
threadsGmailThread[]ein Array von Threads, die in den Posteingang verschoben werden sollen

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToSpam(threads)

Verschiebt diese Threads in den Spamordner und erzwingt die Aktualisierung.

// Move first two threads in your inbox to spam
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToSpam(firstTwoThreads);

Parameter

NameTypBeschreibung
threadsGmailThread[]ein Array von Threads, die in den Spamordner verschoben werden sollen

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToTrash(threads)

Verschiebt diese Threads in den Papierkorb und erzwingt die Aktualisierung.

// Move first two threads in your inbox to trash
var firstTwoThreads = GmailApp.getInboxThreads(0,2);
GmailApp.moveThreadsToTrash(firstTwoThreads);

Parameter

NameTypBeschreibung
threadsGmailThread[]ein Array von Threads, die in den Papierkorb verschoben werden sollen

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


refreshMessage(message)

Die Nachricht und der zugehörige Status aus Gmail werden neu geladen. Dies ist nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben.

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var firstMessage = firstThread.getMessages()[0];
// ...Do something that may take a while here....
GmailApp.refreshMessage(firstMessage);
// ...Do more stuff with firstMessage...

Parameter

NameTypBeschreibung
messageGmailMessagedie zu aktualisierende Nachricht

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


refreshMessages(messages)

Die Nachrichten und der zugehörige Status aus Gmail werden neu geladen. Dies ist nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben.

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 2);
// ...Do something that may take a while here....
GmailApp.refreshMessages(coupleOfMessages);
// ...Do more stuff with coupleOfMessages...

Parameter

NameTypBeschreibung
messagesGmailMessage[]die zu aktualisierenden Nachrichten

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


refreshThread(thread)

Der Thread und der zugehörige Status aus Gmail werden neu geladen. Dies ist nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben.

var firstThread = GmailApp.getInboxThreads(0,1)[0];
// ...Do something that may take a while here....
GmailApp.refreshThread(firstThread);
// ... Do more stuff with the thread ...

Parameter

NameTypBeschreibung
threadGmailThreadder zu aktualisierende Thread

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


refreshThreads(threads)

Die Threads und der zugehörige Status aus Gmail werden neu geladen. Dies ist nützlich, wenn sich die Labels, der Lesestatus usw. geändert haben.

var threads = GmailApp.getInboxThreads(0, 3);
// ...Do something that may take a while here....
GmailApp.refreshThreads(threads);
// ... Do more stuff with threads ...

Parameter

NameTypBeschreibung
threadsGmailThread[]die zu aktualisierenden Threads

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


search(query)

Mit der angegebenen Abfrage in Gmail suchen

Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Wenn die Thread-Größe unbekannt und möglicherweise sehr groß ist, verwenden Sie den Aufruf „paged“ und geben Sie Bereiche der Threads an, die bei jedem Aufruf abgerufen werden sollen.

// Find starred messages with subject IMPORTANT
var threads = GmailApp.search('is:starred subject:"IMPORTANT"');

Parameter

NameTypBeschreibung
queryStringgenau wie in Gmail.

Zurücksenden

GmailThread[]: ein Array von Gmail-Threads, die dieser Abfrage entsprechen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

search(query, start, max)

Mit der angegebenen Abfrage in Gmail suchen

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty array.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parameter

NameTypBeschreibung
queryStringgenau wie in Gmail.
startIntegerIndex des Start-Threads
maxIntegerdie maximale Anzahl der zurückzugebenden Threads

Zurücksenden

GmailThread[]: ein Array von Gmail-Threads, die dieser Abfrage entsprechen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

sendEmail(recipient, subject, body)

Es wird eine E-Mail gesendet. Die Größe der E-Mail (einschließlich Header) ist Kontingent begrenzt.

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

Parameter

NameTypBeschreibung
recipientStringDurch Kommas getrennte Liste der E-Mail-Adressen
subjectStringBetreff der E-Mail (maximal 250 Zeichen)
bodyStringE-Mail-Text

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


sendEmail(recipient, subject, body, options)

Sendet eine E-Mail-Nachricht mit optionalen Argumenten. Die E-Mail kann nur Text oder einen HTML-Text enthalten. Die Größe der E-Mail (einschließlich Header, aber ohne Anhänge) ist Kontingent begrenzt.

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Parameter

NameTypBeschreibung
recipientStringdie Adressen des Empfängers
subjectStringBetreffzeile (maximal 250 Zeichen)
bodyStringder E-Mail-Text
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]ein Array von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine kommagetrennte Liste von E-Mail-Adressen für Bcc
ccStringeine durch Kommas getrennte Liste der E-Mail-Adressen, die auf „Cc“ gesetzt werden sollen
fromStringDie Adresse, von der aus die E-Mail gesendet werden soll. Dies muss einer der Werte sein, die von getAliases() zurückgegeben werden.
htmlBodyStringWenn festgelegt, wird für Geräte, die HTML rendern können, anstelle des erforderlichen Textarguments verwendet. Sie können ein optionales inlineImages-Feld im HTML-Textkörper hinzufügen, wenn Sie Inline-Bilder für Ihre E-Mail haben.
inlineImagesObjectEin JavaScript-Objekt, das eine Zuordnung vom Bildschlüssel (String) zu Bilddaten (BlobSource) enthält. Dabei wird davon ausgegangen, dass der Parameter htmlBody verwendet wird. Er enthält Verweise auf diese Bilder im Format <img src="cid:imageKey" />.
nameStringName des Absenders der E-Mail (Standard: Name des Nutzers)
noReplyBooleantrue, wenn die E-Mail von einer allgemeinen E-Mail-Adresse ohne Antwort gesendet werden soll, um Empfänger am Antworten auf E-Mails zu hindern. Diese Option ist nur für Google Workspace-Konten und nicht für Gmail-Nutzer verfügbar.
replyToStringeine E-Mail-Adresse, die als standardmäßige Antwortadresse verwendet werden soll (Standard: E-Mail-Adresse des Nutzers)

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


setCurrentMessageAccessToken(accessToken)

Legt das aktuelle Zugriffstoken für Nachrichten fest, mit dem das Skript auf die aktuellen GmailMessage-Attribute zugreifen kann.

Nur Google Workspace-Add-on-Projekte, die Gmail-aktuelle Nachrichtenbereiche verwenden, benötigen diese Methode.

function handleAddonActionEvent(e) {
  var accessToken = e.messageMetadata.accessToken;
  var messageId = e.messageMetadata.messageId;
  GmailApp.setCurrentMessageAccessToken(accessToken);
  var mailMessage = GmailApp.getMessageById(messageId);
  // Do something with mailMessage
}

Parameter

NameTypBeschreibung
accessTokenStringDas temporäre Zugriffstoken, das von einem Aktionsereignisobjekt für Gmail-Add-ons abgerufen wird.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

starMessage(message)

Dadurch wird der Nachricht ein Stern hinzugefügt und die Aktualisierung wird erzwungen.

// Stars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

Parameter

NameTypBeschreibung
messageGmailMessagedie zu markierende Nachricht

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


starMessages(messages)

Diese Nachrichten werden mit einem Stern markiert und gezwungen, die Nachrichten zu aktualisieren.

// Stars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.starMessages(coupleOfMessages);

Parameter

NameTypBeschreibung
messagesGmailMessage[]Array mit zu markierenden Nachrichten

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


unstarMessage(message)

Die Markierung wird entfernt und die Nachricht wird aktualisiert.

// Unstars the first message in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
GmailApp.unstarMessage(message);

Parameter

NameTypBeschreibung
messageGmailMessagedie Nachricht, um die Markierung zu entfernen

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


unstarMessages(messages)

Entfernt Sterne aus diesen Nachrichten und erzwingt, dass die Nachrichten aktualisiert werden müssen.

// Unstars the first three messages in the first thread in your inbox
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var coupleOfMessages = firstThread.getMessages().slice(0, 3);
GmailApp.unstarMessages(coupleOfMessages);

Parameter

NameTypBeschreibung
messagesGmailMessage[]ein Array von Nachrichten, deren Markierung entfernt werden soll

Zurücksenden

GmailApp: Der Gmail-Dienst, der für Verkettungen nützlich ist.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung mit mindestens einem der folgenden Bereiche oder entsprechenden Bereichen der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen

Eingestellte Methoden