Class GmailApp

GmailApp

Permet d'accéder aux fils de discussion, messages et libellés Gmail.

Méthodes

Méthode	Type renvoyé	Brève description
createDraft(recipient, subject, body)	GmailDraft	Crée un brouillon d'e-mail.
createDraft(recipient, subject, body, options)	GmailDraft	Crée un brouillon d'e-mail avec des arguments facultatifs.
createLabel(name)	GmailLabel	Crée une étiquette utilisateur du nom donné.
deleteLabel(label)	GmailApp	Supprime l'étiquette spécifiée.
getAliases()	String[]	Permet d'obtenir la liste des adresses e-mail configurées comme alias pour ce compte dans Gmail.
getDraft(draftId)	GmailDraft	Récupérer un brouillon d'e-mail par ID
getDraftMessages()	GmailMessage[]	Récupère tous les brouillons.
getDrafts()	GmailDraft[]	Permet de récupérer tous les brouillons Gmail.
getInboxThreads()	GmailThread[]	Récupère tous les fils de discussion de la boîte de réception, quels que soient les libellés.
getInboxThreads(start, max)	GmailThread[]	Récupère plusieurs fils de discussion dans la boîte de réception, indépendamment des libellés.
getInboxUnreadCount()	Integer	Récupère le nombre de fils de discussion non lus dans la boîte de réception.
getMessageById(id)	GmailMessage	Récupère un message par identifiant.
getMessagesForThread(thread)	GmailMessage[]	Récupère tous les messages du fil de discussion spécifié.
getMessagesForThreads(threads)	GmailMessage[][]	Récupère tous les messages des fils de discussion spécifiés.
getPriorityInboxThreads()	GmailThread[]	Récupère tous les fils de discussion de la boîte de réception Prioritaire, quels que soient les libellés.
getPriorityInboxThreads(start, max)	GmailThread[]	Récupère divers fils de discussion de la boîte de réception Prioritaire, indépendamment des libellés.
getPriorityInboxUnreadCount()	Integer	Récupère le nombre de fils de discussion non lus dans la boîte de réception Prioritaire.
getSpamThreads()	GmailThread[]	Récupère tous les fils de discussion de spam, indépendamment des libellés.
getSpamThreads(start, max)	GmailThread[]	Récupère divers fils de discussion de spam, indépendamment des étiquettes.
getSpamUnreadCount()	Integer	Récupère le nombre de fils de discussion non lus qui constituent du spam.
getStarredThreads()	GmailThread[]	Récupère tous les fils de discussion ajoutés aux favoris, quelles que soient les étiquettes.
getStarredThreads(start, max)	GmailThread[]	Récupère une plage de fils de discussion favoris, indépendamment des étiquettes.
getStarredUnreadCount()	Integer	Récupère le nombre de fils de discussion non lus qui sont suivis.
getThreadById(id)	GmailThread	Récupère un thread par ID.
getTrashThreads()	GmailThread[]	Récupère tous les threads de la corbeille, indépendamment des libellés.
getTrashThreads(start, max)	GmailThread[]	Récupère plusieurs fils de discussion dans la corbeille, indépendamment des libellés.
getUserLabelByName(name)	GmailLabel	Récupère un libellé en fonction de son nom.
getUserLabels()	GmailLabel[]	Récupère la liste des libellés créés par l'utilisateur.
markMessageRead(message)	GmailApp	Marque ce message comme lu et force son actualisation.
markMessageUnread(message)	GmailApp	Marque ce message comme non lu et force son actualisation.
markMessagesRead(messages)	GmailApp	Marque ces messages comme lus et force leur actualisation.
markMessagesUnread(messages)	GmailApp	Marque ces messages comme non lus et force leur actualisation.
markThreadImportant(thread)	GmailApp	Marque ce thread comme important et force son actualisation.
markThreadRead(thread)	GmailApp	Marque ce fil de discussion comme lu et force son actualisation.
markThreadUnimportant(thread)	GmailApp	Marque ce fil de discussion comme non important et force son actualisation.
markThreadUnread(thread)	GmailApp	Marque ce fil de discussion comme non lu et force l'actualisation du fil de discussion.
markThreadsImportant(threads)	GmailApp	Marque ces threads comme importants et force leur actualisation.
markThreadsRead(threads)	GmailApp	Marque ces fils de discussion comme lus et force leur actualisation.
markThreadsUnimportant(threads)	GmailApp	Marque ces fils de discussion comme non importants et force leur actualisation.
markThreadsUnread(threads)	GmailApp	Marque ces fils de discussion comme non lus et force leur actualisation.
moveMessageToTrash(message)	GmailApp	Permet de placer le message dans la corbeille et de forcer son actualisation.
moveMessagesToTrash(messages)	GmailApp	Permet de placer les messages spécifiés dans la corbeille et de forcer leur actualisation.
moveThreadToArchive(thread)	GmailApp	Déplace ce fil de discussion vers l'archive et force son actualisation.
moveThreadToInbox(thread)	GmailApp	Déplace ce fil de discussion vers la boîte de réception et force son actualisation.
moveThreadToSpam(thread)	GmailApp	Déplace ce fil de discussion vers le dossier "Spam" et force son actualisation.
moveThreadToTrash(thread)	GmailApp	Permet de placer ce fil de discussion dans la corbeille et de forcer son actualisation.
moveThreadsToArchive(threads)	GmailApp	déplace ces threads vers l'archive et force leur actualisation.
moveThreadsToInbox(threads)	GmailApp	Déplace ces fils de discussion vers la boîte de réception et force leur actualisation.
moveThreadsToSpam(threads)	GmailApp	Permet de déplacer ces fils de discussion vers le dossier de spam et de forcer leur actualisation.
moveThreadsToTrash(threads)	GmailApp	Permet de déplacer ces fils de discussion vers la corbeille et de forcer leur actualisation.
refreshMessage(message)	GmailApp	Recharge le message et l'état associé depuis Gmail (utile si les libellés, l'état de lecture, etc., ont changé).
refreshMessages(messages)	GmailApp	Recharge les messages et leur état associé depuis Gmail (utile si les libellés, l'état de lecture, etc., ont changé).
refreshThread(thread)	GmailApp	Actualise le fil de discussion et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).
refreshThreads(threads)	GmailApp	Recharge les fils de discussion et l'état associé depuis Gmail (utile si les libellés, l'état de lecture, etc., ont changé).
search(query)	GmailThread[]	Effectuez une recherche dans Gmail à l'aide de la requête donnée.
search(query, start, max)	GmailThread[]	Effectuez une recherche dans Gmail à l'aide de la requête donnée.
sendEmail(recipient, subject, body)	GmailApp	Envoie un e-mail.
sendEmail(recipient, subject, body, options)	GmailApp	Envoie un e-mail avec les arguments facultatifs.
setCurrentMessageAccessToken(accessToken)	void	Définit le message actuel jeton d'accès qui permet au script d'accéder aux propriétés GmailMessage actuelles.
starMessage(message)	GmailApp	Ajoute une étoile à ce message et force son actualisation.
starMessages(messages)	GmailApp	Active le suivi de ces messages et force leur actualisation.
unstarMessage(message)	GmailApp	Supprime une étoile pour ce message et force son actualisation.
unstarMessages(messages)	GmailApp	Supprime les suivis de ces messages et force leur actualisation.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
getChatThreads()	GmailThread[]	Permet de récupérer tous les fils de discussion Google Chat et de la version classique de Hangouts jusqu'à ce que Google change tous de la version classique de Hangouts vers Chat plus tard dans l'année.
getChatThreads(start, max)	GmailThread[]	Récupère différents fils de discussion Google Chat et de la version classique de Hangouts jusqu'au changement de Google à Chat de tous les utilisateurs de la version classique de Hangouts dans le courant de l'année.

Documentation détaillée

createDraft(recipient, subject, body)

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("[e-mail]", "current time", "The time is: " + now.toString());

Paramètres

Nom	Type	Description
recipient	String	liste d'adresses e-mail séparées par une virgule
subject	String	objet de l'e-mail
body	String	corps de l'e-mail

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)

---

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('[e-mail]', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Paramètres

Nom	Type	Description
recipient	String	les adresses du destinataire
subject	String	la ligne d'objet
body	String	le corps de l'e-mail
options	Object	Un objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

Nom	Type	Description
attachments	BlobSource[]	une tableau de fichiers à envoyer avec l'adresse e-mail
bcc	String	une liste d'adresses e-mail séparées par une virgule à mettre en Cci
cc	String	une liste d'adresses e-mail séparées par une virgule à mettre en Cc
from	String	l'adresse d'envoi de l'e-mail, qui doit être une des valeurs renvoyées par getAliases()
htmlBody	String	Si cette règle est définie, les appareils capables d'afficher le code HTML l'utilisent à la place de l'argument "body" requis ; vous pouvez ajouter un champ inlineImages facultatif en HTML corps si vous avez des images intégrées pour votre e-mail
inlineImages	Object	Objet JavaScript contenant un mappage à partir de la clé d'image (String) vers les données d'image (BlobSource) Cela suppose que le paramètre htmlBody est utilisé et qu'il contient des références à ces images au format <img src="cid:imageKey" />.
name	String	Nom de l'expéditeur de l'e-mail (par défaut: nom de l'utilisateur)
replyTo	String	Une adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut: adresse e-mail de l'utilisateur)

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)

---

createLabel(name)

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

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

Paramètres

Nom	Type	Description
name	String	le nom du nouveau libellé

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)

---

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

Nom	Type	Description
label	GmailLabel	l'étiquette à supprimer

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)

---

getAliases()

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)

---

getDraft(draftId)

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

Nom	Type	Description
draftId	String	ID du brouillon à récupérer

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/

---

getDraftMessages()

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/

---

getDrafts()

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/

---

getInboxThreads()

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/

---

getInboxThreads(start, max)

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

Nom	Type	Description
start	Integer	l'index du premier thread à récupérer
max	Integer	le nombre maximal de threads à récupérer

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/

---

getInboxUnreadCount()

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/

---

getMessageById(id)

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

Nom	Type	Description
id	String	ID du message à récupérer

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)

---

getMessagesForThread(thread)

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

Nom	Type	Description
thread	GmailThread	le fil des messages à récupérer

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)

---

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

Nom	Type	Description
threads	GmailThread[]	les fils de messages pour récupérer

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)

---

getPriorityInboxThreads()

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/

---

getPriorityInboxThreads(start, max)

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

Nom	Type	Description
start	Integer	l'index du premier thread à récupérer
max	Integer	le nombre maximal de threads à récupérer

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/

---

getPriorityInboxUnreadCount()

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/

---

getSpamThreads()

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/

---

getSpamThreads(start, max)

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

Nom	Type	Description
start	Integer	l'index du premier thread à récupérer
max	Integer	le nombre maximal de threads à récupérer

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/

---

getSpamUnreadCount()

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/

---

getStarredThreads()

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/

---

getStarredThreads(start, max)

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

Nom	Type	Description
start	Integer	l'index du premier thread à récupérer
max	Integer	le nombre maximal de threads à récupérer

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/

---

getStarredUnreadCount()

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/

---

getThreadById(id)

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

Nom	Type	Description
id	String	ID du thread à récupérer.

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)

---

getTrashThreads()

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/

---

getTrashThreads(start, max)

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

Nom	Type	Description
start	Integer	l'index du premier thread à récupérer
max	Integer	le nombre maximal de threads à récupérer

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/

---

getUserLabelByName(name)

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

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

Paramètres

Nom	Type	Description
name	String	le nom de l'étiquette à récupérer

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/

---

getUserLabels()

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/

---

markMessageRead(message)

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

Nom	Type	Description
message	GmailMessage	le message à marquer comme lu

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)

---

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

Nom	Type	Description
message	GmailMessage	le message à marquer comme non lu

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)

---

markMessagesRead(messages)

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

Nom	Type	Description
messages	GmailMessage[]	un tableau de messages à marquer comme lus

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)

---

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

Nom	Type	Description
messages	GmailMessage[]	Tableau des messages à marquer comme non lus

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)

---

markThreadImportant(thread)

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

Nom	Type	Description
thread	GmailThread	le fil de discussion pour le marquer comme important

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)

---

markThreadRead(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

Nom	Type	Description
thread	GmailThread	le fil de discussion à marquer comme lu

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)

---

markThreadUnimportant(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

Nom	Type	Description
thread	GmailThread	le fil de discussion à marquer comme non important

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)

---

markThreadUnread(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

Nom	Type	Description
thread	GmailThread	le fil de discussion à marquer comme non lu

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)

---

markThreadsImportant(threads)

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

Nom	Type	Description
threads	GmailThread[]	un tableau de threads à marquer comme importants

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)

---

markThreadsRead(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

Nom	Type	Description
threads	GmailThread[]	un tableau de threads à marquer comme lus

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)

---

markThreadsUnimportant(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

Nom	Type	Description
threads	GmailThread[]	Un tableau de fils de discussion à marquer comme non importants

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)

---

markThreadsUnread(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

Nom	Type	Description
threads	GmailThread[]	un tableau de fils de discussion à marquer comme non lus

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)

---

moveMessageToTrash(message)

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

Nom	Type	Description
message	GmailMessage	message à placer dans la corbeille

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)

---

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

Nom	Type	Description
messages	GmailMessage[]	messages à placer dans la corbeille

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)

---

moveThreadToArchive(thread)

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

Nom	Type	Description
thread	GmailThread	le fil de discussion à archiver

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)

---

moveThreadToInbox(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

Nom	Type	Description
thread	GmailThread	fil de discussion à déplacer dans la boîte de réception

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)

---

moveThreadToSpam(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

Nom	Type	Description
thread	GmailThread	fil de discussion à déplacer dans le spam

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)

---

moveThreadToTrash(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

Nom	Type	Description
thread	GmailThread	fil de discussion à placer dans la corbeille

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)

---

moveThreadsToArchive(threads)

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

Nom	Type	Description
threads	GmailThread[]	un tableau de fils de discussion à archiver

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)

---

moveThreadsToInbox(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

Nom	Type	Description
threads	GmailThread[]	Tableau des fils de discussion à déplacer dans la boîte de réception

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)

---

moveThreadsToSpam(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

Nom	Type	Description
threads	GmailThread[]	un tableau de fils de discussion à placer dans le spam

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)

---

moveThreadsToTrash(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

Nom	Type	Description
threads	GmailThread[]	un tableau de threads à placer dans la corbeille

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)

---

refreshMessage(message)

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

Nom	Type	Description
message	GmailMessage	le message à actualiser

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)

---

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

Nom	Type	Description
messages	GmailMessage[]	les messages à actualiser

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)

---

refreshThread(thread)

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

Nom	Type	Description
thread	GmailThread	le thread à actualiser

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)

---

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

Nom	Type	Description
threads	GmailThread[]	les threads à actualiser

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)

---

search(query)

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

Nom	Type	Description
query	String	la requête de recherche, telle que vous la saisiriez dans Gmail ;

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/

---

search(query, start, max)

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

Nom	Type	Description
query	String	la requête de recherche, telle que vous la saisiriez dans Gmail ;
start	Integer	l'index du thread de démarrage
max	Integer	le nombre maximal de threads à renvoyer

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/

---

sendEmail(recipient, subject, body)

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("[e-mail]", "current time", "The time is: " + now.toString());

Paramètres

Nom	Type	Description
recipient	String	liste d'adresses e-mail séparées par une virgule
subject	String	objet de l'e-mail (250 caractères maximum)
body	String	corps de l'e-mail

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)

---

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('[e-mail]', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Paramètres

Nom	Type	Description
recipient	String	les adresses du destinataire
subject	String	La ligne d'objet (250 caractères maximum)
body	String	le corps de l'e-mail
options	Object	Un objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

Nom	Type	Description
attachments	BlobSource[]	une tableau de fichiers à envoyer avec l'adresse e-mail
bcc	String	une liste d'adresses e-mail séparées par une virgule à mettre en Cci
cc	String	une liste d'adresses e-mail séparées par une virgule à mettre en Cc
from	String	l'adresse d'envoi de l'e-mail, qui doit être une des valeurs renvoyées par getAliases()
htmlBody	String	Si cette règle est définie, les appareils capables d'afficher le code HTML l'utilisent à la place de l'argument "body" requis ; vous pouvez ajouter un champ inlineImages facultatif en HTML corps si vous avez des images intégrées pour votre e-mail
inlineImages	Object	Objet JavaScript contenant un mappage à partir de la clé d'image (String) vers les données d'image (BlobSource) Cela suppose que le paramètre htmlBody est utilisé et qu'il contient des références à ces images au format <img src="cid:imageKey" />.
name	String	Nom de l'expéditeur de l'e-mail (par défaut: nom de l'utilisateur)
noReply	Boolean	true si l'e-mail doit être envoyé depuis un adresse e-mail n'acceptant pas de réponse visant à dissuader les destinataires de répondre aux e-mails cette option est Uniquement possible pour les comptes Google Workspace, et non pour les utilisateurs Gmail
replyTo	String	Une adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut: adresse e-mail de l'utilisateur)

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)

---

setCurrentMessageAccessToken(accessToken)

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

Nom	Type	Description
accessToken	String	Le jeton d'accès temporaire obtenu à partir d'un objet d'événement d'action du module complémentaire 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/

---

starMessage(message)

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

Nom	Type	Description
message	GmailMessage	activer le suivi du message

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)

---

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

Nom	Type	Description
messages	GmailMessage[]	un tableau de messages à suivre

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)

---

unstarMessage(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

Nom	Type	Description
message	GmailMessage	le message à désactiver

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)

---

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

Nom	Type	Description
messages	GmailMessage[]	un tableau de messages à désactiver du suivi ;

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)

Méthodes obsolètes

getChatThreads()

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Permet de récupérer tous les fils de discussion Google Chat et de la version classique de Hangouts jusqu'à ce que Google change tous de la version classique de Hangouts vers Chat plus tard dans l'année. Pour en savoir plus, consultez la section En savoir plus sur le passage de la version classique de Hangouts à Google Chat.

Cet appel échoue lorsque la taille de tous les threads est trop importante pour que le système puisse la gérer. Où la taille du thread est inconnue et peut être très volumineuse, utilisez l'opérateur et spécifiez plages de threads à récupérer dans chaque appel.

var threads = GmailApp.getChatThreads();
Logger.log("# of chat threads: " + threads.length);

Renvois

GmailThread[] : tableau des fils de discussion de 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/

---

getChatThreads(start, max)

Obsolète. Cette fonction est obsolète et ne doit pas être utilisée dans de nouveaux scripts.

Récupère différents fils de discussion Google Chat et de la version classique de Hangouts jusqu'au changement de Google à Chat de tous les utilisateurs de la version classique de Hangouts dans le courant de l'année. Pour en savoir plus, consultez la section En savoir plus sur le passage de la version classique de Hangouts à Google Chat.

// Get first 50 chat threads
var threads = GmailApp.getChatThreads(0,50);
// Will log no more than 50.0
Logger.log(threads.length);
Logger.log(threads[0].getFirstMessageSubject());

Paramètres

Nom	Type	Description
start	Integer	l'index du premier thread à récupérer
max	Integer	le nombre maximal de threads à récupérer

Renvois

GmailThread[] : tableau de fils de discussion 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/