Class GmailApp

GmailApp

Ermöglicht den Zugriff auf Gmail-Unterhaltungen, -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)GmailLabelErstellen Sie ein neues Nutzerlabel mit dem angegebenen Namen.
deleteLabel(label)GmailAppLöscht das angegebene Label.
getAliases()String[]Eine Liste der E-Mail-Adressen, die in Gmail als Alias für dieses Konto eingerichtet sind.
getDraft(draftId)GmailDraftE-Mail-Entwurf anhand der ID abrufen
getDraftMessages()GmailMessage[]Ruft alle E-Mail-Entwürfe ab.
getDrafts()GmailDraft[]Alle Gmail-Entwurfsnachrichten abrufen
getInboxThreads()GmailThread[]Ruft alle Inbox-Unterhaltungen unabhängig von Labels ab.
getInboxThreads(start, max)GmailThread[]Ruft eine Reihe von Posteingangsthreads unabhängig von Labels ab.
getInboxUnreadCount()IntegerDie Anzahl der ungelesenen Threads im Posteingang.
getMessageById(id)GmailMessageRuft eine Nachricht anhand der ID ab.
getMessagesForThread(thread)GmailMessage[]Alle Nachrichten im angegebenen Thread abrufen.
getMessagesForThreads(threads)GmailMessage[][]Alle Nachrichten in den angegebenen Threads abrufen.
getPriorityInboxThreads()GmailThread[]Ruft alle Threads im Sortierten Eingang unabhängig von Labels ab.
getPriorityInboxThreads(start, max)GmailThread[]Hiermit werden unabhängig von Labels mehrere Threads aus dem sortierten Eingang abgerufen.
getPriorityInboxUnreadCount()IntegerErmittelt die Anzahl der ungelesenen Threads im sortierten Eingang.
getSpamThreads()GmailThread[]Ruft alle Spam-Threads unabhängig von Labels ab.
getSpamThreads(start, max)GmailThread[]Ruft eine Reihe von Spam-Threads unabhängig von Labels ab.
getSpamUnreadCount()IntegerDie Anzahl der ungelesenen Threads, die Spam sind.
getStarredThreads()GmailThread[]Ruft alle getaggten Threads unabhängig von Labels ab.
getStarredThreads(start, max)GmailThread[]Hiermit werden unabhängig von Labels eine Reihe von Threads mit angepinnten Beiträgen abgerufen.
getStarredUnreadCount()IntegerDie Anzahl der ungelesenen Threads, die mit einem Stern markiert sind.
getThreadById(id)GmailThreadRuft einen Thread nach ID ab.
getTrashThreads()GmailThread[]Ruft alle Threads im Papierkorb unabhängig von Labels ab.
getTrashThreads(start, max)GmailThread[]Hiermit werden unabhängig von Labels mehrere Threads aus dem Papierkorb abgerufen.
getUserLabelByName(name)GmailLabelRuft ein Label anhand des Labelnamens ab.
getUserLabels()GmailLabel[]Ruft eine Liste der vom Nutzer erstellten Labels ab.
markMessageRead(message)GmailAppDiese Nachricht wird als gelesen markiert und die Nachricht wird aktualisiert.
markMessageUnread(message)GmailAppDiese Nachricht wird als ungelesen markiert und die Nachricht wird aktualisiert.
markMessagesRead(messages)GmailAppDiese Nachrichten werden als gelesen markiert und die Nachrichten werden aktualisiert.
markMessagesUnread(messages)GmailAppDiese Nachrichten werden als ungelesen markiert und die Nachrichten werden aktualisiert.
markThreadImportant(thread)GmailAppDieser Thread wird als wichtig markiert und er wird aktualisiert.
markThreadRead(thread)GmailAppDieser Thread wird als gelesen markiert und er wird aktualisiert.
markThreadUnimportant(thread)GmailAppDieser Thread wird als unwichtig markiert und er wird aktualisiert.
markThreadUnread(thread)GmailAppDieser Thread wird als ungelesen markiert und er wird aktualisiert.
markThreadsImportant(threads)GmailAppDiese Threads werden als wichtig markiert und die Threads werden aktualisiert.
markThreadsRead(threads)GmailAppDiese Threads werden als gelesen markiert und aktualisiert.
markThreadsUnimportant(threads)GmailAppDiese Threads werden als unwichtig markiert und aktualisiert.
markThreadsUnread(threads)GmailAppDiese Threads werden als ungelesen markiert und aktualisiert.
moveMessageToTrash(message)GmailAppDie Nachricht wird in den Papierkorb verschoben und die Aktualisierung der Nachricht erzwungen.
moveMessagesToTrash(messages)GmailAppDie angegebenen Nachrichten werden in den Papierkorb verschoben und die Nachrichten werden aktualisiert.
moveThreadToArchive(thread)GmailAppDieser Thread wird ins Archiv verschoben und er wird aktualisiert.
moveThreadToInbox(thread)GmailAppDieser Thread wird in den Posteingang verschoben und er wird aktualisiert.
moveThreadToSpam(thread)GmailAppDieser Thread wird in den Spamordner verschoben und er wird aktualisiert.
moveThreadToTrash(thread)GmailAppDer Thread wird in den Papierkorb verschoben und er wird aktualisiert.
moveThreadsToArchive(threads)GmailAppDiese Threads werden ins Archiv verschoben und aktualisiert.
moveThreadsToInbox(threads)GmailAppDiese Threads werden in den Posteingang verschoben und die Threads werden aktualisiert.
moveThreadsToSpam(threads)GmailAppDiese Threads werden in den Spamordner verschoben und die Threads werden aktualisiert.
moveThreadsToTrash(threads)GmailAppDiese Threads werden in den Papierkorb verschoben und die Threads werden aktualisiert.
refreshMessage(message)GmailAppDie Nachricht und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus geändert haben.
refreshMessages(messages)GmailAppDie Nachrichten und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus geändert haben.
refreshThread(thread)GmailAppDer Thread und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus geändert haben.
refreshThreads(threads)GmailAppDie Threads und der zugehörige Status werden aus Gmail neu geladen. Das ist nützlich, wenn sich beispielsweise die Labels oder der Lesestatus geändert haben.
search(query)GmailThread[]In Gmail mit der angegebenen Suchanfrage suchen
search(query, start, max)GmailThread[]In Gmail mit der angegebenen Suchanfrage suchen
sendEmail(recipient, subject, body)GmailAppEine E-Mail wird gesendet.
sendEmail(recipient, subject, body, options)GmailAppSendet eine E-Mail-Nachricht mit optionalen Argumenten.
setCurrentMessageAccessToken(accessToken)voidHier wird das aktuelle Zugriffstoken der Nachricht festgelegt, mit dem das Script auf die aktuellen GmailMessage-Properties zugreifen kann.
starMessage(message)GmailAppDiese Nachricht wird mit einem Sternsymbol gekennzeichnet und die Nachricht wird aktualisiert.
starMessages(messages)GmailAppDiese Nachrichten werden mit einem Stern markiert und die Nachrichten werden aktualisiert.
unstarMessage(message)GmailAppEntfernt einen Stern von dieser Nachricht und aktualisiert sie.
unstarMessages(messages)GmailAppDie Sterne werden aus diesen Nachrichten entfernt und die Nachrichten werden aktualisiert.

Detaillierte Dokumentation

createDraft(recipient, subject, body)

Erstellt einen E-Mail-Entwurf. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// The code below creates a draft email with the current date and time.
const 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

Rückflug

GmailDraft – der neu erstellte Gmail-Entwurf

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • 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 enthalten. Die Größe der E-Mail (einschließlich Kopfzeilen, aber ohne Anhänge) ist kontingentiert.

// Create a draft email with a file from Google Drive attached as a PDF.
const 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 der Empfänger
subjectStringBetreffzeile
bodyStringim Textkörper der E-Mail
optionsObjectein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]eine Reihe von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste der E-Mail-Adressen für die BCC-Funktion
ccStringeine durch Kommas getrennte Liste der E-Mail-Adressen, die auf Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Sie muss einer der von getAliases() zurückgegebenen Werte sein.
htmlBodyStringWenn festgelegt, wird es von Geräten, die HTML rendern können, anstelle des erforderlichen „body“-Arguments verwendet. Sie können ein optionales inlineImages-Feld in den HTML-Text einfügen, wenn Sie Bilder in Ihre E-Mail eingebettet haben.
inlineImagesObjectein JavaScript-Objekt mit einer Zuordnung von Bildschlüsseln (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" /> enthält
nameStringden Namen des Absenders der E-Mail (Standard: Name des Nutzers)
replyToStringeine E-Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E-Mail-Adresse des Nutzers)

Rückflug

GmailDraft – der neu erstellte Gmail-Entwurf

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • 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
nameStringden Namen des neuen Labels

Rückflug

GmailLabel – das neu erstellte Label

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


deleteLabel(label)

Löscht das angegebene Label.

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

Parameter

NameTypBeschreibung
labelGmailLabeldas zu löschende Label

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getAliases()

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

Sie können eine Nachricht von einem beliebigen 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.
const me = Session.getActiveUser().getEmail();
const 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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getDraft(draftId)

E-Mail-Entwurf anhand der ID abrufen

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

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const 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 zu abrufenden Entwurfs

Rückflug

GmailDraft: der Entwurf mit der angegebenen ID

Löst

Error – wenn kein Entwurf mit der angegebenen ID gefunden werden kann

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getDraftMessages()

Ruft alle E-Mail-Entwürfe ab.

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

Rückflug

GmailMessage[] – ein Array von Gmail-Entwürfen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getDrafts()

Alle Gmail-Entwurfsnachrichten abrufen

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

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getInboxThreads()

Ruft alle Inbox-Unterhaltungen unabhängig von Labels ab.

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

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

Rückflug

GmailThread[] – ein Array von Gmail-Unterhaltungen im Posteingang

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getInboxThreads(start, max)

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

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

Parameter

NameTypBeschreibung
startIntegerIndex des ersten Threads, der abgerufen werden soll
maxIntegerDie maximale Anzahl der Threads, die abgerufen werden sollen.

Rückflug

GmailThread[] – ein Array von Gmail-Unterhaltungen im Posteingang

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getInboxUnreadCount()

Die Anzahl der ungelesenen Threads im Posteingang.

Logger.log(`Messages unread in inbox: ${GmailApp.getInboxUnreadCount()}`);

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getMessageById(id)

Ruft eine Nachricht anhand der ID ab.

Verwenden Sie diese Funktion in Verbindung mit getId() für Gmail-Nachrichten.

// Get the first message in the first thread of your inbox
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const 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 Nachricht, die abgerufen werden soll

Rückflug

GmailMessage: die Nachricht mit der angegebenen ID

Löst

Error – wenn keine Nachricht mit der angegebenen ID gefunden werden kann

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getMessagesForThread(thread)

Alle Nachrichten im angegebenen Thread abrufen.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Nachrichten-Thread, der abgerufen werden soll

Rückflug

GmailMessage[] – Array mit Nachrichten, die zu diesem Thread gehören

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • 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
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let 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 entspricht und das innere Array die Nachrichten in diesem Thread enthält

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getPriorityInboxThreads()

Ruft alle Threads im Sortierten Eingang unabhängig von Labels ab.

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

Logger.log(
    `# of messages in your Priority Inbox: ${
        GmailApp.getPriorityInboxThreads().length}`,
);

Rückflug

GmailThread[] – ein Array von Gmail-Unterhaltungen im Sortierten Eingang

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

Hiermit werden unabhängig von Labels mehrere Threads aus dem sortierten Eingang abgerufen.

// 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 Threads, der abgerufen werden soll
maxIntegerDie maximale Anzahl der Threads, die abgerufen werden sollen.

Rückflug

GmailThread[] – ein Array von Gmail-Unterhaltungen im Sortierten Eingang

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getPriorityInboxUnreadCount()

Ermittelt die Anzahl der ungelesenen Threads im sortierten Eingang.

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

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getSpamThreads()

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

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

Logger.log(`# of total spam threads: ${GmailApp.getSpamThreads().length}`);

Rückflug

GmailThread[] – ein Array von Gmail-Unterhaltungen im Spamordner

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getSpamThreads(start, max)

Ruft eine Reihe von Spam-Threads unabhängig von 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 Threads, der abgerufen werden soll
maxIntegerDie maximale Anzahl der Threads, die abgerufen werden sollen.

Rückflug

GmailThread[] – ein Array von Gmail-Unterhaltungen im Spamordner

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getSpamUnreadCount()

Die Anzahl der ungelesenen Threads, 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: Anzahl der Spam-Unterhaltungen mit ungelesenen Nachrichten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getStarredThreads()

Ruft alle getaggten Threads unabhängig von Labels ab.

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

// Logs the number of starred threads
Logger.log(`# Starred threads: ${GmailApp.getStarredThreads().length}`);

Rückflug

GmailThread[] – eine Reihe von markierten Gmail-Konversationen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getStarredThreads(start, max)

Hiermit werden unabhängig von Labels eine Reihe von Threads mit angepinnten Beiträgen abgerufen.

// 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 Threads, der abgerufen werden soll
maxIntegerDie maximale Anzahl der Threads, die abgerufen werden sollen.

Rückflug

GmailThread[] – eine Reihe von markierten Gmail-Konversationen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getStarredUnreadCount()

Die Anzahl der ungelesenen Threads, die mit einem Stern markiert sind.

Logger.log(`# unread and starred: ${GmailApp.getStarredUnreadCount()}`);

Rückflug

Integer – die Anzahl der markierten Threads mit ungelesenen Nachrichten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getThreadById(id)

Ruft einen Thread nach ID ab.

Verwenden Sie diese Funktion in Verbindung mit getId() für Gmail-Unterhaltungen.

// 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 Threads, der abgerufen werden soll.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


getTrashThreads()

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

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

Logger.log(`# of total trash threads: ${GmailApp.getTrashThreads().length}`);

Rückflug

GmailThread[] – eine Reihe von Gmail-Threads im Papierkorb

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getTrashThreads(start, max)

Hiermit werden unabhängig von Labels mehrere Threads aus dem Papierkorb abgerufen.

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

Parameter

NameTypBeschreibung
startIntegerIndex des ersten Threads, der abgerufen werden soll
maxIntegerDie maximale Anzahl der Threads, die abgerufen werden sollen.

Rückflug

GmailThread[] – eine Reihe von Gmail-Threads im Papierkorb

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getUserLabelByName(name)

Ruft ein Label anhand des Labelnamens ab.

const labelObject = GmailApp.getUserLabelByName('myLabel');

Parameter

NameTypBeschreibung
nameStringDer Name des abzurufenden Labels.

Rückflug

GmailLabel – das Gmail-Label mit dem angegebenen Namen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

getUserLabels()

Ruft eine Liste der vom Nutzer erstellten Labels ab.

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

Rückflug

GmailLabel[] – Array mit vom Nutzer erstellten Labels

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

markMessageRead(message)

Diese Nachricht wird als gelesen markiert und die Nachricht wird aktualisiert.

// Mark the first message in the first thread of your inbox as read
const 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, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markMessageUnread(message)

Diese Nachricht wird als ungelesen markiert und die Nachricht wird aktualisiert.

// Mark the first message in the first thread of your inbox as unread
const 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, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markMessagesRead(messages)

Diese Nachrichten werden als gelesen markiert und die Nachrichten werden aktualisiert.

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

Parameter

NameTypBeschreibung
messagesGmailMessage[]eine Reihe von Nachrichten, die als gelesen markiert werden sollen

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markMessagesUnread(messages)

Diese Nachrichten werden als ungelesen markiert und die Nachrichten werden aktualisiert.

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

Parameter

NameTypBeschreibung
messagesGmailMessage[]eine Reihe von Nachrichten, die als ungelesen markiert werden sollen

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markThreadImportant(thread)

Dieser Thread wird als wichtig markiert und er wird aktualisiert.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread, den Sie als wichtig markieren möchten

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markThreadRead(thread)

Dieser Thread wird als gelesen markiert und er wird aktualisiert.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread, den Sie als gelesen markieren möchten

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markThreadUnimportant(thread)

Dieser Thread wird als unwichtig markiert und er wird aktualisiert.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread, den Sie als unwichtig markieren möchten

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markThreadUnread(thread)

Dieser Thread wird als ungelesen markiert und er wird aktualisiert.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread, den Sie als ungelesen markieren möchten

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markThreadsImportant(threads)

Diese Threads werden als wichtig markiert und die Threads werden aktualisiert.

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

Parameter

NameTypBeschreibung
threadsGmailThread[]eine Reihe von Threads, die als wichtig markiert werden sollen

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markThreadsRead(threads)

Diese Threads werden als gelesen markiert und aktualisiert.

// Marks first two threads in inbox as read
const 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, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markThreadsUnimportant(threads)

Diese Threads werden als unwichtig markiert und aktualisiert.

// Marks first two threads in inbox as unimportant
const 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, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


markThreadsUnread(threads)

Diese Threads werden als ungelesen markiert und aktualisiert.

// Marks first two threads in inbox as unread
const 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, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveMessageToTrash(message)

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

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

Parameter

NameTypBeschreibung
messageGmailMessagedie Nachricht, die in den Papierkorb verschoben werden soll

Rückflug

GmailApp – der Gmail-Dienst (nützlich für die Verknüpfung)

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveMessagesToTrash(messages)

Die angegebenen Nachrichten werden in den Papierkorb verschoben und die Nachrichten werden aktualisiert.

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

Parameter

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

Rückflug

GmailApp – der Gmail-Dienst (nützlich für die Verknüpfung)

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveThreadToArchive(thread)

Dieser Thread wird ins Archiv verschoben und er wird aktualisiert.

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

Parameter

NameTypBeschreibung
threadGmailThreadder zu archivierende Thread

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveThreadToInbox(thread)

Dieser Thread wird in den Posteingang verschoben und er wird aktualisiert.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread, der in den Posteingang verschoben werden soll

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveThreadToSpam(thread)

Dieser Thread wird in den Spamordner verschoben und er wird aktualisiert.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread, der in den Spamordner verschoben werden soll

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveThreadToTrash(thread)

Der Thread wird in den Papierkorb verschoben und er wird aktualisiert.

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

Parameter

NameTypBeschreibung
threadGmailThreadden Thread, der gelöscht werden soll

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToArchive(threads)

Diese Threads werden ins Archiv verschoben und aktualisiert.

// Move first two threads in your inbox to the archive
const 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, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToInbox(threads)

Diese Threads werden in den Posteingang verschoben und die Threads werden aktualisiert.

// Find two threads not already in your inbox
const 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, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToSpam(threads)

Diese Threads werden in den Spamordner verschoben und die Threads werden aktualisiert.

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

Parameter

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

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


moveThreadsToTrash(threads)

Diese Threads werden in den Papierkorb verschoben und die Threads werden aktualisiert.

// Move first two threads in your inbox to trash
const 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, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


refreshMessage(message)

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

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

Parameter

NameTypBeschreibung
messageGmailMessagedie Nachricht, die aktualisiert werden soll

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


refreshMessages(messages)

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

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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 Nachrichten, die aktualisiert werden sollen

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


refreshThread(thread)

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

const 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, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


refreshThreads(threads)

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

const 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, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


search(query)

In Gmail mit der angegebenen Suchanfrage suchen

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

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

Parameter

NameTypBeschreibung
queryStringdie Suchanfrage, wie Sie sie in Gmail eingeben würden

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

search(query, start, max)

In Gmail mit der angegebenen Suchanfrage 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.
const threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Parameter

NameTypBeschreibung
queryStringdie Suchanfrage, wie Sie sie in Gmail eingeben würden
startIntegerden Index des Startthreads
maxIntegerDie maximale Anzahl der zurückzugebenden Threads.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

sendEmail(recipient, subject, body)

Eine E-Mail wird gesendet. Die Größe der E-Mail (einschließlich Kopfzeilen) ist kontingentiert.

// The code below will send an email with the current date and time.
const 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

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • 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-Textkörper enthalten. Die Größe der E-Mail (einschließlich Kopfzeilen, aber ohne Anhänge) ist kontingentiert.

// Send an email with a file from Google Drive attached as a PDF.
const 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 der Empfänger
subjectStringBetreffzeile (maximal 250 Zeichen)
bodyStringim Textkörper der E-Mail
optionsObjectein JavaScript-Objekt, das die unten aufgeführten erweiterten Parameter angibt

Erweiterte Parameter

NameTypBeschreibung
attachmentsBlobSource[]eine Reihe von Dateien, die mit der E-Mail gesendet werden sollen
bccStringeine durch Kommas getrennte Liste der E-Mail-Adressen für die BCC-Funktion
ccStringeine durch Kommas getrennte Liste der E-Mail-Adressen, die auf Cc gesetzt werden sollen
fromStringDie Adresse, von der die E-Mail gesendet werden soll. Sie muss einer der von getAliases() zurückgegebenen Werte sein.
htmlBodyStringWenn festgelegt, wird es von Geräten, die HTML rendern können, anstelle des erforderlichen „body“-Arguments verwendet. Sie können ein optionales inlineImages-Feld in den HTML-Text einfügen, wenn Sie Bilder in Ihre E-Mail eingebettet haben.
inlineImagesObjectein JavaScript-Objekt mit einer Zuordnung von Bildschlüsseln (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" /> enthält
nameStringden Namen des Absenders der E-Mail (Standard: Name des Nutzers)
noReplyBooleantrue, wenn die E-Mail von einer generischen E-Mail-Adresse ohne Antwortfunktion gesendet werden soll, um Empfänger davon abzuhalten, auf E-Mails zu antworten. Diese Option ist nur für Google Workspace-Konten verfügbar, nicht für Gmail-Nutzer.
replyToStringeine E-Mail-Adresse, die als Standard-Antwortadresse verwendet werden soll (Standard: die E-Mail-Adresse des Nutzers)

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


setCurrentMessageAccessToken(accessToken)

Hier wird das aktuelle Zugriffstoken der Nachricht festgelegt, mit dem das Script auf die aktuellen GmailMessage-Properties zugreifen kann.

Diese Methode ist nur für Google Workspace-Add-on-Projekte erforderlich, die aktuelle Nachrichtenbereiche von Gmail verwenden.

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

Parameter

NameTypBeschreibung
accessTokenStringdas temporäre Zugriffstoken, das über ein Gmail-Add-on-Ereignisobjekt abgerufen wurde.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

starMessage(message)

Diese Nachricht wird mit einem Sternsymbol gekennzeichnet und die Nachricht wird aktualisiert.

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

Parameter

NameTypBeschreibung
messageGmailMessagedie Nachricht, die Sie markieren möchten

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


starMessages(messages)

Diese Nachrichten werden mit einem Stern markiert und die Nachrichten werden aktualisiert.

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

Parameter

NameTypBeschreibung
messagesGmailMessage[]eine Reihe von Nachrichten, die mit einem Stern markiert werden sollen

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


unstarMessage(message)

Entfernt einen Stern von dieser Nachricht und aktualisiert sie.

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

Parameter

NameTypBeschreibung
messageGmailMessagedie Nachricht, deren Markierung aufgehoben werden soll

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen


unstarMessages(messages)

Die Sterne werden aus diesen Nachrichten entfernt und die Nachrichten werden aktualisiert.

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

Parameter

NameTypBeschreibung
messagesGmailMessage[]eine Reihe von Nachrichten, bei denen die Markierung aufgehoben werden soll

Rückflug

GmailApp – der Gmail-Dienst, nützlich für die Verknüpfung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung mit mindestens einem der folgenden Bereiche oder geeigneten Bereichen aus der zugehörigen REST API:

  • https://mail.google.com/

Weitere Informationen

Eingestellte Methoden