Class GmailApp

Crée un brouillon d'e-mail. La taille de l'e-mail (en-têtes compris) est limitée par le quota.

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

Renvois

GmailDraft : le nouveau brouillon Gmail

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 une Corps HTML. La taille de l'e-mail (en-têtes compris, mais sans les 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

Renvois

GmailDraft : le nouveau brouillon Gmail

Autorisation

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

• https://mail.google.com/

Voir aussi

• createDraft(recipient, subject, body)

Crée une étiquette utilisateur du nom donné.

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

Paramètres

Renvois

GmailLabel : libellé nouvellement créé

Autorisation

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

• https://mail.google.com/

Voir aussi

• deleteLabel(label)

Supprime l'étiquette spécifiée.

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

Paramètres

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• createLabel(name)

Permet d'obtenir la liste des adresses e-mail configurées comme alias pour ce compte dans Gmail.

Vous pouvez envoyer un message à partir de l'un de ces alias en utilisant le paramètre "from" argument facultatif.

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

Renvois

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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• sendEmail(recipient, subject, body, options)

Récupérer un brouillon d'e-mail par ID

À utiliser en conjonction avec getId() sur les 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

Renvois

GmailDraft : brouillon avec l'ID donné

Génère

Error : si aucun brouillon avec l'ID donné n'a été trouvé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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);

Renvois

GmailMessage[] : tableau de 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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Permet de récupérer tous les brouillons Gmail.

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

Renvois

GmailDraft[] : tableau de brouillons Gmail

Autorisation

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

• https://mail.google.com/

Récupère tous les fils de discussion de la boîte de réception, quels que soient les libellés.

Cet appel échouera lorsque la taille de tous les threads sera trop grande pour que le système ne puisse pas la gérer. Si la taille du thread est inconnue et potentiellement très volumineuse, veuillez utiliser la fonction "paginée" appeler et spécifier les plages de threads à récupérer dans 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());
}

Renvois

GmailThread[] : tableau de 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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère plusieurs fils de discussion dans la boîte de réception, indépendamment des 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

Renvois

GmailThread[] : tableau de 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 des 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());

Renvois

Integer : nombre de fils de discussion de la boîte de réception 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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère un message par identifiant.

Utilisez cette fonction conjointement avec getId() sur 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

Renvois

GmailMessage : message portant l'ID donné

Génère

Error : si aucun message avec l'ID donné n'a été trouvé

Autorisation

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

• https://mail.google.com/

Voir aussi

• getThreadById(id)

Récupère 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

Renvois

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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• getMessagesForThreads(threads)

Récupère 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

Renvois

GmailMessage[][] : tableau de tableaux de messages, où chaque élément du tableau externe correspond à un et que le tableau interne contient les messages qu'il contient

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 de la boîte de réception Prioritaire, quels que soient les libellés.

Cet appel échouera lorsque la taille de tous les threads sera trop grande pour que le système ne puisse pas la gérer. Si la taille du thread est inconnue et potentiellement très volumineuse, veuillez utiliser la fonction "paginée" appeler et spécifier les plages de threads à récupérer dans chaque appel.

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

Renvois

GmailThread[] : 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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère divers fils de discussion de la boîte de réception Prioritaire, indépendamment des libellés.

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

Paramètres

Renvois

GmailThread[] : 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 des 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());

Renvois

Integer : nombre de fils de discussion de la boîte de réception Prioritaire 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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

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

Cet appel échouera lorsque la taille de tous les threads sera trop grande pour que le système ne puisse pas la gérer. Si la taille du thread est inconnue et potentiellement très volumineuse, veuillez utiliser la fonction "paginée" appeler et spécifier les plages de threads à récupérer dans chaque appel.

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

Renvois

GmailThread[] : 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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère divers fils de discussion de spam, indépendamment des étiquettes.

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

Paramètres

Renvois

GmailThread[] : 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 des 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 constituent 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());

Renvois

Integer : nombre de fils de discussion de spam 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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère tous les fils de discussion ajoutés aux favoris, quelles que soient les étiquettes.

Cet appel échouera lorsque la taille de tous les threads sera trop grande pour que le système ne puisse pas la gérer. Si la taille du thread est inconnue et potentiellement très volumineuse, veuillez utiliser la fonction "paginée" appeler et spécifier les plages de threads à récupérer dans chaque appel.

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

Renvois

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 des 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 étiquettes.

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

Paramètres

Renvois

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

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

Renvois

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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère un thread par ID.

Utilisez cette fonction conjointement avec getId() sur les fils de discussion Gmail.

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

Paramètres

Renvois

GmailThread : thread avec l'ID donné ou null s'il est introuvable.

Autorisation

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

• https://mail.google.com/

Voir aussi

• getMessageById(id)

Récupère tous les threads de la corbeille, indépendamment des libellés.

Cet appel échouera lorsque la taille de tous les threads sera trop grande pour que le système ne puisse pas la gérer. Si la taille du thread est inconnue et potentiellement très volumineuse, veuillez utiliser la fonction "paginée" appeler et spécifier les plages de threads à récupérer dans chaque appel.

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

Renvois

GmailThread[] : tableau des 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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère plusieurs fils de discussion dans la corbeille, indépendamment des libellés.

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

Paramètres

Renvois

GmailThread[] : tableau des 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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Récupère un libellé en fonction de son nom.

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

Paramètres

Renvois

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

Renvois

GmailLabel[] : tableau d'étiquettes créées 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 des 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• markMessageRead(message)

Marque ces messages comme lus et force 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• markMessagesRead(messages)

Marque ce thread comme important et force son actualisation.

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

Paramètres

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• markThreadUnimportant(thread)

Marque ce fil de discussion comme lu et force son actualisation.

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

Paramètres

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• markThreadUnread(thread)

Marque ce fil de discussion comme non important et force son actualisation.

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

Paramètres

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• markThreadImportant(thread)

Marque ce fil de discussion comme non lu et force l'actualisation du fil de discussion.

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

Paramètres

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• markThreadRead(thread)

Marque ces threads 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• markThreadsUnimportant(threads)

Marque ces fils de discussion 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• markThreadsUnread(threads)

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

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

Paramètres

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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

Renvois

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

Renvois

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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Voir aussi

• moveMessageToTrash(message)

Déplace ce fil de discussion vers l'archive et force son actualisation.

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

Paramètres

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

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

Déplace ce fil de discussion vers la boîte de réception et force son 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

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

Déplace ce fil de discussion vers le dossier "Spam" et force son actualisation.

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

Paramètres

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 de discussion dans la corbeille et de forcer son actualisation.

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

Paramètres

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 threads 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

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

Déplace ces fils de discussion vers la boîte de réception et force leur actualisation.

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

Paramètres

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 déplacer ces fils de discussion vers le dossier de 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 déplacer ces fils de discussion vers 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

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

Recharge le message et l'état associé depuis 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• refreshMessages(messages)

Recharge les messages et leur état associé depuis 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• refreshMessage(message)

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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• refreshThreads(threads)

Recharge les fils de discussion et l'état associé depuis 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• refreshThread(thread)

Effectuez une recherche dans Gmail à l'aide de la requête donnée.

Cet appel échouera lorsque la taille de tous les threads sera trop grande pour que le système ne puisse pas la gérer. Si la taille du thread est inconnue et potentiellement très volumineuse, veuillez utiliser la fonction "paginée" appeler et spécifier les plages de threads à récupérer dans chaque appel.

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

Paramètres

Renvois

GmailThread[] : tableau des 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 des champs d'application appropriés de l'API REST associée:

• https://mail.google.com/

Effectuez une recherche dans Gmail à l'aide de 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

Renvois

GmailThread[] : tableau des 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 des 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 compris) est limitée par le quota.

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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des 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 les arguments facultatifs. L'e-mail peut contenir du texte brut ou un fichier HTML . La taille de l'e-mail (en-têtes compris, mais sans les 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• sendEmail(recipient, subject, body)

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

Seuls les projets de modules complémentaires Google Workspace utilisant les champs d'application actuels des messages 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 des 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• starMessages(messages)

Active le suivi de 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• starMessage(message)

Supprime une étoile pour 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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• unstarMessages(messages)

Supprime les suivis de ces messages et force leur actualisation.

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

Renvois

GmailApp : service Gmail, utile pour les enchaînements

Autorisation

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

• https://mail.google.com/

Voir aussi

• unstarMessage(message)