Class GmailApp

Permet de créer un brouillon d'e-mail. La taille de l'e-mail (en-têtes inclus) est limitée.

// 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());

Paramètres

Aller-retour

GmailDraft : le brouillon Gmail que vous venez de créer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• createDraft(recipient, subject, body, options)

Crée un brouillon d'e-mail avec des arguments facultatifs. L'e-mail peut contenir du texte brut ou un corps HTML. La taille de l'e-mail (y compris les en-têtes, mais hors pièces jointes) est limitée au quota.

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

Paramètres

Paramètres avancés

Aller-retour

GmailDraft : le brouillon Gmail que vous venez de créer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• createDraft(recipient, subject, body)

Créez un libellé utilisateur pour le nom donné.

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

Paramètres

Aller-retour

GmailLabel : le nouveau libellé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• deleteLabel(label)

Supprime le libellé spécifié.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• createLabel(name)

Récupère la liste des adresses e-mail configurées en tant qu'alias pour ce compte dans Gmail.

Vous pouvez envoyer un message à partir de l'un de ces alias à l'aide de l'argument facultatif &fromt;from".

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

Aller-retour

String[] : tableau d'alias pour ce compte

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• sendEmail(recipient, subject, body, options)

Récupérez un brouillon d'e-mail à l'aide de son ID.

Utilisez cette option conjointement avec "getId()" dans vos brouillons Gmail.

// 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());

Paramètres

Aller-retour

GmailDraft : le brouillon avec l'ID donné

Génère

Error : si aucun brouillon ne correspond à l'ID indiqué.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Récupère tous les brouillons.

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

Aller-retour

GmailMessage[] : tableau des brouillons de messages Gmail

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère tous les brouillons dans Gmail.

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

Aller-retour

GmailDraft[] : tableau des brouillons dans Gmail

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère tous les fils de discussion, quels que soient les libellés.

Cet appel échouera si tous les fils de discussion sont trop volumineux pour être traités. Si la taille du fil de discussion est inconnue, et potentiellement très volumineuse, utilisez l'appel "paged" et spécifiez des plages de fils de discussion à récupérer à chaque appel.

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

Aller-retour

GmailThread[] : tableau des fils de discussion Gmail dans la boîte de réception

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Récupère un ensemble de fils de discussion, quels que soient les libellés.

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

Paramètres

Aller-retour

GmailThread[] : tableau des fils de discussion Gmail dans la boîte de réception

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Récupère le nombre de fils de discussion non lus dans la boîte de réception.

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

Aller-retour

Integer : nombre de fils de discussion contenant des messages non lus dans la boîte de réception

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Récupère un message par ID.

À utiliser conjointement avec getId() dans les messages Gmail.

// 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());

Paramètres

Aller-retour

GmailMessage : message avec l'ID donné

Génère

Error : si aucun message ne correspond à l'ID indiqué

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• getThreadById(id)

Permet de récupérer tous les messages du fil de discussion spécifié.

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

Paramètres

Aller-retour

GmailMessage[] : tableau de messages correspondant à ce fil de discussion

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• getMessagesForThreads(threads)

Permet de récupérer tous les messages des fils de discussion spécifiés.

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

Paramètres

Aller-retour

GmailMessage[][] : tableau de messages, où chaque élément du tableau externe correspond à un thread et le tableau interne contient les messages de ce fil

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• getMessagesForThread(thread)

Récupère tous les fils de discussion prioritaires, quels que soient les libellés.

Cet appel échouera si tous les fils de discussion sont trop volumineux pour être traités. Si la taille du fil de discussion est inconnue, et potentiellement très volumineuse, utilisez l'appel "paged" et spécifiez des plages de fils de discussion à récupérer à chaque appel.

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

Aller-retour

GmailThread[] : tableau des fils de discussion Gmail dans la boîte de réception Prioritaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère un ensemble de fils de discussion de la boîte de réception Prioritaire, quel que soit le libellé.

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

Paramètres

Aller-retour

GmailThread[] : tableau des fils de discussion Gmail dans la boîte de réception Prioritaire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Récupère le nombre de fils de discussion non lus dans la boîte de réception Prioritaire.

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

Aller-retour

Integer : nombre de fils de discussion dans la boîte de réception Prioritaire comportant des messages non lus

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Récupère tous les fils de discussion, quels que soient les libellés.

Cet appel échouera si tous les fils de discussion sont trop volumineux pour être traités. Si la taille du fil de discussion est inconnue, et potentiellement très volumineuse, utilisez l'appel "paged" et spécifiez des plages de fils de discussion à récupérer à chaque appel.

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

Aller-retour

GmailThread[] : tableau des fils de discussion Gmail dans le dossier de spam

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Récupère un ensemble de fils de discussion, quel que soit leur libellé.

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

Paramètres

Aller-retour

GmailThread[] : tableau des fils de discussion Gmail dans le dossier de spam

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère le nombre de fils de discussion non lus qui sont du spam.

// 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());

Aller-retour

Integer : nombre de fils de discussion contenant des messages non lus

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère tous les fils de discussion suivis, indépendamment des libellés.

Cet appel échouera si tous les fils de discussion sont trop volumineux pour être traités. Si la taille du fil de discussion est inconnue, et potentiellement très volumineuse, utilisez l'appel "paged" et spécifiez des plages de fils de discussion à récupérer à chaque appel.

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

Aller-retour

GmailThread[] : tableau des fils de discussion Gmail suivis

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Récupère une plage de fils de discussion favoris, indépendamment des libellés.

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

Paramètres

Aller-retour

GmailThread[] : tableau des fils de discussion Gmail suivis

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère le nombre de fils de discussion non lus ajoutés aux favoris.

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

Aller-retour

Integer : nombre de fils de discussion suivis contenant des messages non lus

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Récupère un thread par ID.

Utilisez cette option conjointement avec "getId()" dans les fils de discussion Gmail.

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

Paramètres

Aller-retour

GmailThread : thread avec l'ID donné ou valeur null si introuvable

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• getMessageById(id)

Récupère tous les fils de discussion, quel que soit leur libellé.

Cet appel échouera si tous les fils de discussion sont trop volumineux pour être traités. Si la taille du fil de discussion est inconnue, et potentiellement très volumineuse, utilisez l'appel "paged" et spécifiez des plages de fils de discussion à récupérer à chaque appel.

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

Aller-retour

GmailThread[] : tableau de fils de discussion Gmail dans la corbeille

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère une plage de fils de discussion, quel que soit leur libellé.

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

Paramètres

Aller-retour

GmailThread[] : tableau de fils de discussion Gmail dans la corbeille

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère un libellé à partir du nom du libellé.

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

Paramètres

Aller-retour

GmailLabel : libellé Gmail portant le nom donné

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère la liste des libellés créés par l'utilisateur.

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

Aller-retour

GmailLabel[] : tableau des libellés créés par l'utilisateur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Marque ce message comme lu et force son actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• markMessageUnread(message)

Marque ce message comme non lu et force son actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• markMessageRead(message)

Permet de marquer ces messages comme lus et de forcer leur actualisation.

// 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());

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• markMessagesUnread(messages)

Marque ces messages comme non lus et force leur actualisation.

// 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());

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• markMessagesRead(messages)

Permet de marquer ce fil de discussion comme important et de forcer son actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• markThreadUnimportant(thread)

Permet de marquer ce fil comme lu et de forcer l'actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• markThreadUnread(thread)

Permet de marquer ce fil de discussion comme non important et de forcer l'actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• markThreadImportant(thread)

Marque ce fil comme non lu et force son actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• markThreadRead(thread)

Marque ces fils comme importants et force leur actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• markThreadsUnimportant(threads)

Marque ces fils comme lus et force leur actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• markThreadsUnread(threads)

Permet de marquer ces fils de discussion comme non importants et de les forcer à s'actualiser.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• markThreadsImportant(threads)

Marque ces fils de discussion comme non lus et force leur actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• markThreadsRead(threads)

Permet de placer le message dans la corbeille et de forcer son actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail (utile pour le chaînage)

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• moveMessagesToTrash(messages)

Permet de placer les messages spécifiés dans la corbeille et de forcer leur actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail (utile pour le chaînage)

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• moveMessageToTrash(message)

Permet de déplacer ce fil de discussion vers l'archive et de forcer son actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToTrash(thread)

Permet de déplacer ce fil de discussion vers la boîte de réception et de forcer l'actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• moveThreadToTrash(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

Permet de déplacer ce fil de discussion vers le dossier "Spam" et de forcer l'actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• moveThreadToTrash(thread)
• moveThreadToInbox(thread)
• moveThreadToArchive(thread)

Permet de placer ce fil dans la corbeille et de forcer l'actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• moveThreadToInbox(thread)
• moveThreadToSpam(thread)
• moveThreadToArchive(thread)

Déplace ces fils de discussion vers l'archive et force leur actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToTrash(threads)

Permet de déplacer ces fils de discussion vers la boîte de réception et de forcer leur actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• moveThreadsToTrash(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

Permet de placer ces fils de discussion dans le dossier "Spam" et de forcer leur actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• moveThreadsToInbox(threads)
• moveThreadsToTrash(threads)
• moveThreadsToArchive(threads)

Permet de placer ces fils de discussion dans la corbeille et de forcer leur actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• moveThreadsToInbox(threads)
• moveThreadsToSpam(threads)
• moveThreadsToArchive(threads)

Actualise le message et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• refreshMessages(messages)

Actualise les messages et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• refreshMessage(message)

Il actualise le fil de discussion et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• refreshThreads(threads)

Il actualise les fils de discussion et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• refreshThread(thread)

Lancez une recherche Gmail dans la requête donnée.

Cet appel échouera si tous les fils de discussion sont trop volumineux pour être traités. Si la taille du fil de discussion est inconnue, et potentiellement très volumineuse, utilisez l'appel "paged" et spécifiez des plages de fils de discussion à récupérer à chaque appel.

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

Paramètres

Aller-retour

GmailThread[] : tableau de fils de discussion Gmail correspondant à cette requête

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Lancez une recherche Gmail dans la requête donnée.

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

Paramètres

Aller-retour

GmailThread[] : tableau de fils de discussion Gmail correspondant à cette requête

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Envoie un e-mail. La taille de l'e-mail (en-têtes inclus) est limitée.

// 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());

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• sendEmail(recipient, subject, body, options)

Envoie un e-mail avec des arguments facultatifs. L'e-mail peut contenir du texte brut ou un corps HTML. La taille de l'e-mail (y compris les en-têtes, mais hors pièces jointes) est limitée au quota.

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

Paramètres

Paramètres avancés

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• sendEmail(recipient, subject, body)

Définit le jeton d'accès aux messages actuel qui permet au script d'accéder aux propriétés GmailMessage actuelles.

Seuls les projets de module complémentaire Google Workspace qui utilisent les champs d'application de messagerie actuels de Gmail nécessitent cette méthode.

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
}

Paramètres

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Ajoute une étoile à ce message et force son actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée :

• https://mail.google.com/

Voir aussi

• starMessages(messages)

Ajoute des messages à ces messages et force leur actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• starMessage(message)

Supprime une étoile de ce message et force son actualisation.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• unstarMessages(messages)

Supprime les étoiles de ces messages et force l'actualisation des messages.

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

Paramètres

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants ou les champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• unstarMessage(message)