Class GmailApp

GmailApp

Zugriff auf Gmail-Konversationen, -Nachrichten und -Labels

Methoden

MethodeRückgabetypKurzbeschreibung
createDraft(recipient, subject, body)GmailDraftErstellt einen E-Mail-Entwurf.
createDraft(recipient, subject, body, options)GmailDraftErstellt einen E-Mail-Entwurf mit optionalen Argumenten.
createLabel(name)GmailLabelErstellt ein neues Nutzerlabel des angegebenen Namens.
deleteLabel(label)GmailAppLöscht das angegebene Label.
getAliases()String[]Ruft eine Liste der E-Mail-Adressen ab, die als Alias für dieses Konto in Gmail eingerichtet sind.
getDraft(draftId)GmailDraftE-Mail-Entwurf nach ID abrufen
getDraftMessages()GmailMessage[]Ruft alle Nachrichtenentwürfe ab.
getDrafts()GmailDraft[]Ruft alle Gmail-Entwürfe ab.
getInboxThreads()GmailThread[]Ruft alle Posteingangs-Threads unabhängig von Labels ab.
getInboxThreads(start, max)GmailThread[]Ruft unabhängig von Labels eine Reihe von Posteingangsthreads ab.
getInboxUnreadCount()IntegerRuft die Anzahl der ungelesenen Threads im Posteingang ab.
getMessageById(id)GmailMessageRuft eine Nachricht nach ID ab.
getMessagesForThread(thread)GmailMessage[]Ruft alle Nachrichten im angegebenen Thread ab.
getMessagesForThreads(threads)GmailMessage[][]Ruft alle Nachrichten in den angegebenen Threads ab.
getPriorityInboxThreads()GmailThread[]Ruft alle Threads des sortierten Eingangs unabhängig von den Labels ab.
getPriorityInboxThreads(start, max)GmailThread[]Ruft unabhängig von Labels einen Bereich von Threads des sortierten Eingangs ab.
getPriorityInboxUnreadCount()IntegerRuft die Anzahl der ungelesenen Threads im sortierten Eingang ab.
getSpamThreads()GmailThread[]Ruft alle Spam-Threads unabhängig von Labels ab.
getSpamThreads(start, max)GmailThread[]Ruft eine Reihe von Spam-Threads unabhängig von den Labels ab.
getSpamUnreadCount()IntegerRuft die Anzahl der ungelesenen Threads ab, die Spam sind.
getStarredThreads()GmailThread[]Ruft alle markierten Threads unabhängig von Labels ab.
getStarredThreads(start, max)GmailThread[]Ruft einen Bereich markierter Threads unabhängig von Labels 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 anhand des Labelnamens ab.
getUserLabels()GmailLabel[]Ruft eine Liste der von Nutzern erstellten Labels ab.
markMessageRead(message)GmailAppDiese Nachricht wird als gelesen markiert und ihre Aktualisierung wird erzwungen.
markMessageUnread(message)GmailAppDiese Nachricht wird als ungelesen markiert und ihre Aktualisierung wird erzwungen.
markMessagesRead(messages)GmailAppDiese Nachrichten werden als gelesen markiert und ihre Aktualisierung wird erzwungen.
markMessagesUnread(messages)GmailAppDiese Nachrichten werden als ungelesen markiert und ihre Aktualisierung wird erzwungen.
markThreadImportant(thread)GmailAppMarkiert diesen Thread als wichtig und erzwingt eine Aktualisierung des Threads.
markThreadRead(thread)GmailAppMarkiert diesen Thread als gelesen und erzwingt eine Aktualisierung des Threads.
markThreadUnimportant(thread)GmailAppMarkiert diesen Thread als unwichtig und erzwingt eine Aktualisierung des Threads.
markThreadUnread(thread)GmailAppMarkiert diesen Thread als ungelesen und erzwingt die Aktualisierung des Threads.
markThreadsImportant(threads)GmailAppDiese Threads werden als wichtig markiert und ihre Aktualisierung wird erzwungen.
markThreadsRead(threads)GmailAppDiese Threads werden als gelesen markiert und ihre Aktualisierung wird erzwungen.
markThreadsUnimportant(threads)GmailAppDiese Threads werden als unwichtig markiert und ihre Aktualisierung wird erzwungen.
markThreadsUnread(threads)GmailAppDiese Threads werden als ungelesen markiert und ihre Aktualisierung wird erzwungen.
moveMessageToTrash(message)GmailAppDie Nachricht wird in den Papierkorb verschoben und ihre Aktualisierung wird erzwungen.
moveMessagesToTrash(messages)GmailAppVerschiebt die angegebenen Nachrichten in den Papierkorb und erzwingt eine Aktualisierung.
moveThreadToArchive(thread)GmailAppVerschiebt diesen Thread in das Archiv und erzwingt eine Aktualisierung des Threads.
moveThreadToInbox(thread)GmailAppVerschiebt diese Konversation in den Posteingang und erzwingt eine Aktualisierung der Konversation.
moveThreadToSpam(thread)GmailAppVerschiebt diesen Thread in den Spamordner und erzwingt eine Aktualisierung des Threads.
moveThreadToTrash(thread)GmailAppVerschiebt diese Konversation in den Papierkorb und erzwingt eine Aktualisierung der Konversation.
moveThreadsToArchive(threads)GmailAppVerschiebt diese Threads in das Archiv und erzwingt eine Aktualisierung der Threads.
moveThreadsToInbox(threads)GmailAppVerschiebt diese Threads in den Posteingang und erzwingt eine Aktualisierung der Threads.
moveThreadsToSpam(threads)GmailAppVerschiebt diese Threads in den Spamordner und erzwingt eine Aktualisierung der Threads.
moveThreadsToTrash(threads)GmailAppVerschiebt diese Threads in den Papierkorb und erzwingt eine Aktualisierung der Threads.
refreshMessage(message)GmailAppLädt die Nachricht und den zugehörigen Status aus Google Mail neu (nützlich für den Fall, dass Labels, Lesestatus, sich geändert haben).
refreshMessages(messages)GmailAppLädt die Nachrichten und den zugehörigen Status aus Gmail neu (nützlich für den Fall, dass Labels, Lesestatus, sich geändert haben).
refreshThread(thread)GmailAppLädt den Thread und den zugehörigen Status aus Gmail neu (nützlich für den Fall, dass Labels, Lesestatus, sich geändert haben).
refreshThreads(threads)GmailAppLädt Threads und den zugehörigen Status aus Gmail neu (nützlich für den Fall, dass Labels, Lesestatus, sich geändert haben).
search(query)GmailThread[]Durchsuchen Sie Gmail mit der angegebenen Suchanfrage.
search(query, start, max)GmailThread[]Durchsuchen Sie Gmail mit der angegebenen Suchanfrage.
sendEmail(recipient, subject, body)GmailAppSendet eine E-Mail-Nachricht.
sendEmail(recipient, subject, body, options)GmailAppSendet eine E-Mail-Nachricht mit optionalen Argumenten.
setCurrentMessageAccessToken(accessToken)voidAktuelle Nachricht festlegen Zugriffstoken, das es dem Skript ermöglicht, auf die aktuellen GmailMessage-Eigenschaften zuzugreifen.
starMessage(message)GmailAppFügt dieser Nachricht einen Stern hinzu und erzwingt, dass die Nachricht aktualisiert wird.
starMessages(messages)GmailAppDiese Nachrichten werden mit einem Stern markiert und die Aktualisierung wird erzwungen.
unstarMessage(message)GmailAppEntfernt einen Stern von dieser Nachricht und erzwingt die Aktualisierung der Nachricht.
unstarMessages(messages)GmailAppDie Markierungen werden von diesen Nachrichten entfernt und eine Aktualisierung der Nachrichten wird erzwungen.

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 von E-Mail-Adressen
subjectStringBetreff der E-Mail
bodyStringE-Mail-Text

Rückflug

GmailDraft – der neu erstellte Gmail-Entwurf

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


createDraft(recipient, subject, body, options)

Erstellt einen E-Mail-Entwurf mit optionalen Argumenten. Die E-Mail kann nur Text oder einen HTML-Textkörper. 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
subjectStringdie Betreffzeile
bodyStringden Text der E-Mail
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]eine Array der Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste von E-Mail-Adressen als Bcc
ccStringeine durch Kommas getrennte Liste von E-Mail-Adressen für das Cc-Feld
fromStringAdresse, von der aus die E-Mail gesendet werden soll. Dabei muss es sich um eine der von getAliases() zurückgegebenen Werte
htmlBodyStringWenn festgelegt, wird HTML-Code von Geräten, die HTML rendern können, verwendet des erforderlichen Arguments "body"; können Sie ein optionales inlineImages-Feld in HTML Text, wenn Sie Inline-Bilder für Ihre E-Mail haben
inlineImagesObjectJavaScript-Objekt, das eine Zuordnung vom Image-Schlüssel enthält (String) zu Bilddaten (BlobSource); Dabei wird davon ausgegangen, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthalten sind.
nameStringDer Name des Absenders der E-Mail (Standard: der Name des Nutzers)
replyToStringeine E-Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: E-Mail-Adresse des Nutzers)

Rückflug

GmailDraft – der neu erstellte Gmail-Entwurf

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


createLabel(name)

Erstellt ein neues Nutzerlabel des angegebenen Namens.

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

Parameter

NameTypBeschreibung
nameStringden Namen des neuen Labels

Rückflug

GmailLabel: das neu erstellte Label

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


deleteLabel(label)

Löscht das angegebene Label.

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

Parameter

NameTypBeschreibung
labelGmailLabeldas zu löschende Label

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getAliases()

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

Sie können eine Nachricht von jedem dieser Aliasse senden, indem Sie den String "from" optionales Argument.

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getDraft(draftId)

E-Mail-Entwurf nach ID abrufen

Verwenden Sie dieses Argument 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

Rückflug

GmailDraft – Der Entwurf mit der angegebenen ID

Löst aus

Error – wenn kein Entwurf mit der angegebenen ID gefunden wird

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getDraftMessages()

Ruft alle Nachrichtenentwürfe ab.

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

Rückflug

GmailMessage[]: Array von Gmail-Entwürfen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getDrafts()

Ruft alle Gmail-Entwürfe ab.

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

Rückflug

GmailDraft[]: Array von Gmail-Entwürfen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getInboxThreads()

Ruft alle Posteingangs-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 potenziell sehr groß ist, verwenden Sie den anrufen und gibt Bereiche der in jedem Aufruf abzurufenden Threads an.

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getInboxThreads(start, max)

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

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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());

Rückflug

Integer: die Anzahl der Threads im Posteingang mit ungelesenen Nachrichten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getMessageById(id)

Ruft eine Nachricht nach ID ab.

Verwenden Sie dieses Argument 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

Rückflug

GmailMessage: die Nachricht mit der angegebenen ID

Löst aus

Error – wenn keine Nachricht mit der angegebenen ID gefunden wird

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getMessagesForThread(thread)

Ruft alle Nachrichten im angegebenen Thread ab.

// 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
threadGmailThreadThread der abzurufenden Nachrichten

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getMessagesForThreads(threads)

Ruft alle Nachrichten in den angegebenen Threads ab.

// 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 Threads der abzurufenden Nachrichten

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


getPriorityInboxThreads()

Ruft alle Threads des sortierten Eingangs unabhängig von den Labels ab.

Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Wenn die Thread-Größe unbekannt und potenziell sehr groß ist, verwenden Sie den anrufen und gibt Bereiche der in jedem Aufruf abzurufenden Threads an.

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

Ruft unabhängig von Labels einen Bereich von Threads des sortierten Eingangs 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 abzurufender Threads

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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());

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getSpamThreads()

Ruft alle Spam-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 potenziell sehr groß ist, verwenden Sie den anrufen und gibt Bereiche der in jedem Aufruf abzurufenden Threads an.

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

Rückflug

GmailThread[]: Array von Gmail-Threads im Spamordner

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getSpamThreads(start, max)

Ruft eine Reihe von Spam-Threads unabhängig von den Labels ab.

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

Rückflug

GmailThread[]: Array von Gmail-Threads im Spamordner

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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());

Rückflug

Integer – die Anzahl der Spamthreads mit ungelesenen Nachrichten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getStarredThreads()

Ruft alle markierten 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 potenziell sehr groß ist, verwenden Sie den anrufen und gibt Bereiche der in jedem Aufruf abzurufenden Threads an.

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

Rückflug

GmailThread[] – eine Reihe markierter Gmail-Threads

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getStarredThreads(start, max)

Ruft einen Bereich markierter Threads unabhängig von Labels 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 abzurufender Threads

Rückflug

GmailThread[] – eine Reihe markierter Gmail-Threads

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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());

Rückflug

Integer: die Anzahl der markierten Threads mit ungelesenen Nachrichten

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getThreadById(id)

Ruft einen Thread nach ID ab.

Verwenden Sie dieses Argument in Verbindung mit getId() für Gmail-Threads.

// Gets the first inbox thread.
const firstThread = GmailApp.getInboxThreads(0,1)[0];
// Gets the same thread by ID.
const threadById = GmailApp.getThreadById(firstThread.getId());
// Verifies that they are the same.
console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());

Parameter

NameTypBeschreibung
idStringDie ID des abzurufenden Threads.

Rückflug

GmailThread – Der Thread mit der angegebenen ID oder null, falls er nicht gefunden wird.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 potenziell sehr groß ist, verwenden Sie den anrufen und gibt Bereiche der in jedem Aufruf abzurufenden Threads an.

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

Rückflug

GmailThread[]: Array von Gmail-Threads im Papierkorb

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 abzurufender Threads

Rückflug

GmailThread[]: Array von Gmail-Threads im Papierkorb

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getUserLabelByName(name)

Ruft ein Label anhand des Labelnamens ab.

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

Parameter

NameTypBeschreibung
nameStringden Namen des abzurufenden Labels

Rückflug

GmailLabel: das Gmail-Label mit dem angegebenen Namen

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

getUserLabels()

Ruft eine Liste der 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());
}

Rückflug

GmailLabel[]: Array der vom Nutzer erstellten Labels

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

markMessageRead(message)

Diese Nachricht wird als gelesen markiert und ihre Aktualisierung wird 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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markMessageUnread(message)

Diese Nachricht wird als ungelesen markiert und ihre Aktualisierung wird 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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markMessagesRead(messages)

Diese Nachrichten werden als gelesen markiert und ihre Aktualisierung wird erzwungen.

// 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[]Array von Nachrichten, die als gelesen markiert werden sollen

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markMessagesUnread(messages)

Diese Nachrichten werden als ungelesen markiert und ihre Aktualisierung wird erzwungen.

// 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 mit Nachrichten, die als ungelesen markiert werden sollen

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadImportant(thread)

Markiert diesen Thread als wichtig und erzwingt eine Aktualisierung des Threads.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread als wichtig zu markieren,

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadRead(thread)

Markiert diesen Thread als gelesen und erzwingt eine Aktualisierung des Threads.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread, der als gelesen markiert werden soll

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadUnimportant(thread)

Markiert diesen Thread als unwichtig und erzwingt eine Aktualisierung des Threads.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread als unwichtig zu markieren.

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadUnread(thread)

Markiert diesen Thread als ungelesen und erzwingt die Aktualisierung des Threads.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread, der als ungelesen markiert werden soll

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadsImportant(threads)

Diese Threads werden als wichtig markiert und ihre Aktualisierung wird erzwungen.

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

Parameter

NameTypBeschreibung
threadsGmailThread[]Ein Array von Threads, die als wichtig markiert werden sollen

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadsRead(threads)

Diese Threads werden als gelesen markiert und ihre Aktualisierung wird erzwungen.

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadsUnimportant(threads)

Diese Threads werden als unwichtig markiert und ihre Aktualisierung wird erzwungen.

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


markThreadsUnread(threads)

Diese Threads werden als ungelesen markiert und ihre Aktualisierung wird erzwungen.

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveMessageToTrash(message)

Die Nachricht wird in den Papierkorb verschoben und ihre 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 wird in den Papierkorb verschoben

Rückflug

GmailApp – der Gmail-Dienst (nützlich zum Verketten)

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveMessagesToTrash(messages)

Verschiebt die angegebenen Nachrichten in den Papierkorb und erzwingt eine Aktualisierung.

// 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[]die in den Papierkorb zu verschiebenden Nachrichten

Rückflug

GmailApp – der Gmail-Dienst (nützlich zum Verketten)

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadToArchive(thread)

Verschiebt diesen Thread in das Archiv und erzwingt eine Aktualisierung des Threads.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread zu archivieren

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadToInbox(thread)

Verschiebt diese Konversation in den Posteingang und erzwingt eine Aktualisierung der Konversation.

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

Parameter

NameTypBeschreibung
threadGmailThreaddie Konversation, die in den Posteingang verschoben werden soll

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadToSpam(thread)

Verschiebt diesen Thread in den Spamordner und erzwingt eine Aktualisierung des Threads.

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

Parameter

NameTypBeschreibung
threadGmailThreadKonversation wird in den Spamordner verschoben

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadToTrash(thread)

Verschiebt diese Konversation in den Papierkorb und erzwingt eine Aktualisierung der Konversation.

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

Parameter

NameTypBeschreibung
threadGmailThreadden in den Papierkorb zu verschiebenden Thread

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToArchive(threads)

Verschiebt diese Threads in das Archiv und erzwingt eine Aktualisierung der Threads.

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

Parameter

NameTypBeschreibung
threadsGmailThread[]Ein Array von Threads, die archiviert werden sollen

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToInbox(threads)

Verschiebt diese Threads in den Posteingang und erzwingt eine Aktualisierung der Threads.

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToSpam(threads)

Verschiebt diese Threads in den Spamordner und erzwingt eine Aktualisierung der Threads.

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToTrash(threads)

Verschiebt diese Threads in den Papierkorb und erzwingt eine Aktualisierung der Threads.

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


refreshMessage(message)

Lädt die Nachricht und den zugehörigen Status aus Google Mail neu (nützlich für den Fall, dass Labels, Lesestatus, sich 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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


refreshMessages(messages)

Lädt die Nachrichten und den zugehörigen Status aus Gmail neu (nützlich für den Fall, dass Labels, Lesestatus, sich 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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


refreshThread(thread)

Lädt den Thread und den zugehörigen Status aus Gmail neu (nützlich für den Fall, dass Labels, Lesestatus, sich 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
threadGmailThreadden zu aktualisierenden Thread

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


refreshThreads(threads)

Lädt Threads und den zugehörigen Status aus Gmail neu (nützlich für den Fall, dass Labels, Lesestatus, sich 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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


search(query)

Durchsuchen Sie Gmail mit der angegebenen Suchanfrage.

Dieser Aufruf schlägt fehl, wenn alle Threads zu groß für das System sind. Wenn die Thread-Größe unbekannt und potenziell sehr groß ist, verwenden Sie den anrufen und gibt Bereiche der in jedem Aufruf abzurufenden Threads an.

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

Parameter

NameTypBeschreibung
queryStringgenau so eingeben, wie Sie es in Gmail eingeben würden

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

search(query, start, max)

Durchsuchen Sie Gmail mit der angegebenen Suchanfrage.

// 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 so eingeben, wie Sie es in Gmail eingeben würden
startIntegerIndex des Startthreads
maxIntegerDie maximale Anzahl von Threads, die zurückgegeben werden sollen

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

sendEmail(recipient, subject, body)

Sendet eine E-Mail-Nachricht. 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 von E-Mail-Adressen
subjectStringBetreff der E-Mail (maximal 250 Zeichen)
bodyStringE-Mail-Text

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus 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 HTML-Code enthalten. Textkörper. 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
subjectStringin der Betreffzeile (maximal 250 Zeichen)
bodyStringden Text der E-Mail
optionsObjectEin JavaScript-Objekt, das erweiterte Parameter angibt, wie unten aufgeführt

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]eine Array der Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste von E-Mail-Adressen als Bcc
ccStringeine durch Kommas getrennte Liste von E-Mail-Adressen für das Cc-Feld
fromStringAdresse, von der aus die E-Mail gesendet werden soll. Dabei muss es sich um eine der von getAliases() zurückgegebenen Werte
htmlBodyStringWenn festgelegt, wird HTML-Code von Geräten, die HTML rendern können, verwendet des erforderlichen Arguments "body"; können Sie ein optionales inlineImages-Feld in HTML Text, wenn Sie Inline-Bilder für Ihre E-Mail haben
inlineImagesObjectJavaScript-Objekt, das eine Zuordnung vom Image-Schlüssel enthält (String) zu Bilddaten (BlobSource); Dabei wird davon ausgegangen, dass der Parameter htmlBody verwendet wird und Verweise auf diese Bilder im Format <img src="cid:imageKey" /> enthalten sind.
nameStringDer Name des Absenders der E-Mail (Standard: der Name des Nutzers)
noReplyBooleantrue, wenn die E-Mail von einer allgemeinen E-Mail-Adresse gesendet werden soll Antwort-E-Mail-Adresse, um Empfänger davon abzuhalten, auf E-Mails zu antworten ist diese Option nur für Google Workspace-Konten möglich, nicht für Gmail-Nutzer
replyToStringeine E-Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: E-Mail-Adresse des Nutzers)

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


setCurrentMessageAccessToken(accessToken)

Aktuelle Nachricht festlegen Zugriffstoken, das es dem Skript ermöglicht, auf die aktuellen GmailMessage-Eigenschaften zuzugreifen.

Nur Google Workspace-Add-on-Projekte, die aktuelle Nachrichtenbereiche in Gmail verwenden erfordern 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 Sie über das Aktionsobjekt des Gmail-Add-ons erhalten haben.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

starMessage(message)

Fügt dieser Nachricht einen Stern hinzu und erzwingt, dass die Nachricht aktualisiert wird.

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

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


starMessages(messages)

Diese Nachrichten werden mit einem Stern markiert und die Aktualisierung wird erzwungen.

// 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[]ein Array mit zu markierenden Nachrichten

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


unstarMessage(message)

Entfernt einen Stern von dieser Nachricht und erzwingt die Aktualisierung der Nachricht.

// 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 zum Aufheben der Markierung

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen


unstarMessages(messages)

Die Markierungen werden von diesen Nachrichten entfernt und eine Aktualisierung der Nachrichten wird erzwungen.

// 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[]Array von Nachrichten, deren Markierung entfernt werden soll

Rückflug

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung für einen oder mehrere der folgenden Bereiche oder die entsprechenden Bereiche aus der zugehörigen REST API erforderlich:

  • https://mail.google.com/

Weitere Informationen

Verworfene Methoden