Class GmailApp

ApplicationGmail

Permet d'accéder aux fils de discussion, aux messages et aux 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éez un libellé utilisateur avec le nom donné.
deleteLabel(label)	GmailApp	Supprime le libellé spécifié.
getAliases()	String[]	Récupère la liste des adresses e-mail configurées en tant qu'alias pour ce compte dans Gmail.
getDraft(draftId)	GmailDraft	Récupérez une ébauche de message par ID.
getDraftMessages()	GmailMessage[]	Récupère tous les brouillons.
getDrafts()	GmailDraft[]	Récupère tous les brouillons Gmail.
getInboxThreads()	GmailThread[]	Récupère tous les fils de discussion Inbox, quels que soient les libellés.
getInboxThreads(start, max)	GmailThread[]	Récupère une plage de fils de discussion de la boîte de réception, quelle que soit la balise.
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 ID.
getMessagesForThread(thread)	GmailMessage[]	Récupérez tous les messages du fil de discussion spécifié.
getMessagesForThreads(threads)	GmailMessage[][]	Récupérez 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, quel que soit le libellé.
getPriorityInboxThreads(start, max)	GmailThread[]	Récupère une plage de fils de discussion de la boîte de réception prioritaire, quel que soit le libellé.
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 considérés comme du spam, quels que soient les libellés.
getSpamThreads(start, max)	GmailThread[]	Récupère une plage de fils de discussion de spam, quels que soient les libellés.
getSpamUnreadCount()	Integer	Récupère le nombre de fils de discussion non lus qui sont du spam.
getStarredThreads()	GmailThread[]	Récupère tous les fils épinglés, quels que soient les libellés.
getStarredThreads(start, max)	GmailThread[]	Récupère une plage de fils épinglés, quelle que soit la balise.
getStarredUnreadCount()	Integer	Récupère le nombre de fils non lus avec une étoile.
getThreadById(id)	GmailThread	Récupère un thread par ID.
getTrashThreads()	GmailThread[]	Récupère tous les threads de corbeille, quels que soient les libellés.
getTrashThreads(start, max)	GmailThread[]	Récupère une plage de threads de corbeille, quel que soit le libellé.
getUserLabelByName(name)	GmailLabel	Récupère un libellé à partir de son nom.
getUserLabels()	GmailLabel[]	Récupère une liste de 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	Marquez ces messages comme non lus et forcez 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 son actualisation.
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 threads 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	Place le message dans la corbeille et force l'actualisation du message.
moveMessagesToTrash(messages)	GmailApp	Déplace les messages spécifiés dans la corbeille et force leur actualisation.
moveThreadToArchive(thread)	GmailApp	Déplace ce thread dans l'archive et force son actualisation.
moveThreadToInbox(thread)	GmailApp	Déplace ce fil de discussion dans la boîte de réception et force son actualisation.
moveThreadToSpam(thread)	GmailApp	Place ce thread dans le dossier de spam et force son actualisation.
moveThreadToTrash(thread)	GmailApp	Déplace ce thread dans la corbeille et force 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 dans la boîte de réception et les force à s'actualiser.
moveThreadsToSpam(threads)	GmailApp	Déplace ces fils de discussion dans le spam et les force à s'actualiser.
moveThreadsToTrash(threads)	GmailApp	Place ces threads dans la corbeille et force leur actualisation.
refreshMessage(message)	GmailApp	Recharge le message et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
refreshMessages(messages)	GmailApp	Recharge les messages et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
refreshThread(thread)	GmailApp	Recharge 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é à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
search(query)	GmailThread[]	Recherchez dans Gmail la requête indiquée.
search(query, start, max)	GmailThread[]	Recherchez dans Gmail la requête indiquée.
sendEmail(recipient, subject, body)	GmailApp	Envoie un e-mail.
sendEmail(recipient, subject, body, options)	GmailApp	Envoie un e-mail avec des arguments facultatifs.
setCurrentMessageAccessToken(accessToken)	void	Définit le jeton d'accès au message actuel 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	Ajoute une étoile à ces messages et force leur actualisation.
unstarMessage(message)	GmailApp	Supprime une étoile de ce message et force l'actualisation du message.
unstarMessages(messages)	GmailApp	Supprime les étoiles de ces messages et force leur actualisation.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
getChatThreads()	GmailThread[]	Récupère tous les fils de discussion Google Hangouts classiques et Google Chat jusqu'à ce que Google transfère tous les utilisateurs de la version classique de Hangouts vers Chat dans le courant de l'année.
getChatThreads(start, max)	GmailThread[]	Récupère une gamme de fils de discussion Google Hangouts classiques et de fils de discussion Google Chat jusqu'à ce que Google transfère tous les utilisateurs de la version classique de Hangouts vers Chat 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 (y compris les en-têtes) est limitée par quota.

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 un corps HTML. La taille de l'e-mail (y compris les en-têtes, mais à l'exception des pièces jointes) est limitée par quota.

// Create a draft email with a file from Google Drive attached as a PDF.
const 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[]	un tableau de fichiers à envoyer avec l'e-mail
bcc	String	une liste d'adresses e-mail à ajouter en Cci, séparées par une virgule
cc	String	une liste d'adresses e-mail à ajouter à la liste des destinataires Cc, séparées par une virgule
from	String	Adresse à partir de laquelle l'e-mail doit être envoyé, qui doit être l'une des valeurs renvoyées par getAliases()
htmlBody	String	Si défini, les appareils capables d'afficher du code HTML l'utiliseront à la place de l'argument de corps obligatoire. Vous pouvez ajouter un champ inlineImages facultatif dans le corps HTML si vous avez intégré des images à votre e-mail.
inlineImages	Object	un objet JavaScript contenant une mise en correspondance de la clé d'image (String) aux données d'image (BlobSource) ; cela suppose que le paramètre htmlBody est utilisé et 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: l'adresse e-mail de l'utilisateur)

Renvois

GmailDraft : brouillon Gmail créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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éez un libellé utilisateur avec le nom donné.

// Creates the label @FOO and logs label: FOO
Logger.log(`label: ${GmailApp.createLabel('FOO')}`);

Paramètres

Nom	Type	Description
name	String	nom du nouveau libellé

Renvois

GmailLabel : libellé créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 le libellé spécifié.

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

Paramètres

Nom	Type	Description
label	GmailLabel	le libellé à supprimer

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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()

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

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

// Log the aliases for this Gmail account and send an email as the first one.
const me = Session.getActiveUser().getEmail();
const aliases = GmailApp.getAliases();
Logger.log(aliases);
if (aliases.length > 0) {
  GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {
    from: aliases[0],
  });
} else {
  GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.');
}

Renvois

String[] : tableau d'alias pour ce compte

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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érez une ébauche de message par ID.

Utilisez-le avec getId() sur les brouillons Gmail.

// Get the first draft message in your drafts folder
const draft = GmailApp.getDrafts()[0];
// Get its ID
const draftId = draft.getId();
// Now fetch the same draft using that ID.
const draftById = GmailApp.getDraft(draftId);
// Should always log true as they should be the same message
Logger.log(
    draft.getMessage().getSubject() === draftById.getMessage().getSubject(),
);

Paramètres

Nom	Type	Description
draftId	String	ID de la version préliminaire à récupérer

Renvois

GmailDraft : le brouillon associé à l'ID donné

Génère

Error : si aucun brouillon associé à l'ID donné n'est trouvé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const 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 l'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()

Récupère tous les brouillons Gmail.

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

Renvois

GmailDraft[] : tableau de brouillons de messages Gmail

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 Inbox, quels que soient les libellés.

Cet appel échouera lorsque la taille de tous les threads sera trop importante pour que le système puisse la gérer. Lorsque la taille de thread est inconnue et potentiellement très importante, veuillez utiliser l'appel "paged" et spécifier les plages de threads à récupérer dans chaque appel.

// Log the subject lines of your Inbox
const threads = GmailApp.getInboxThreads();
for (let 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 l'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 une plage de fils de discussion de la boîte de réception, quelle que soit la balise.

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

Paramètres

Nom	Type	Description
start	Integer	l'index du premier thread à récupérer
max	Integer	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 l'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 dans la boîte de réception contenant des messages non lus

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 ID.

Utilisez-le avec getId() sur les messages Gmail.

// Get the first message in the first thread of your inbox
const message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
// Get its ID
const messageId = message.getId();
// Now fetch the same message using that ID.
const messageById = GmailApp.getMessageById(messageId);
// Should always log true as they should be the same message
Logger.log(message.getSubject() === messageById.getSubject());

Paramètres

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

Renvois

GmailMessage : message associé à l'ID donné

Génère

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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érez tous les messages du fil de discussion spécifié.

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

Paramètres

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

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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érez 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
const thread = GmailApp.getInboxThreads(0, 2);
const messages = GmailApp.getMessagesForThreads(thread);
for (let i = 0; i < messages.length; i++) {
  for (let j = 0; j < messages[i].length; j++) {
    Logger.log(`subject: ${messages[i][j].getSubject()}`);
  }
}

Paramètres

Nom	Type	Description
threads	GmailThread[]	les threads des messages à récupérer

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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, quel que soit le libellé.

Cet appel échouera lorsque la taille de tous les threads sera trop importante pour que le système puisse la gérer. Lorsque la taille de thread est inconnue et potentiellement très importante, veuillez utiliser l'appel "paged" 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[] : tableau de 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 l'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 une plage de fils de discussion de la boîte de réception prioritaire, quel que soit le libellé.

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

Paramètres

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

Renvois

GmailThread[] : tableau de 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 l'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 dans 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 l'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 considérés comme du spam, quels que soient les libellés.

Cet appel échouera lorsque la taille de tous les threads sera trop importante pour que le système puisse la gérer. Lorsque la taille de thread est inconnue et potentiellement très importante, veuillez utiliser l'appel "paged" et spécifier les plages de threads à récupérer dans chaque appel.

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

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 une plage de fils de discussion de spam, quels que soient les libellés.

// 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	Nombre maximal de threads à récupérer

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 sont du spam.

// Unless you actually read stuff in your spam folder, this should be the same
// as the number of messages in your spam folder.
Logger.log(`# unread threads that are spam: ${GmailApp.getSpamUnreadCount()}`);

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 l'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 épinglés, quels que soient les libellés.

Cet appel échouera lorsque la taille de tous les threads sera trop importante pour que le système puisse la gérer. Lorsque la taille de thread est inconnue et potentiellement très importante, veuillez utiliser l'appel "paged" 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 de fils de discussion Gmail suivis

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 épinglés, quelle que soit la balise.

// 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	Nombre maximal de threads à récupérer

Renvois

GmailThread[] : tableau de fils de discussion Gmail suivis

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 non lus avec une étoile.

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

Renvois

Integer : nombre de fils suivis contenant des messages non lus

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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-le 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 : le thread associé à l'ID donné ou null s'il n'est pas trouvé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 corbeille, quels que soient les libellés.

Cet appel échouera lorsque la taille de tous les threads sera trop importante pour que le système puisse la gérer. Lorsque la taille de thread est inconnue et potentiellement très importante, veuillez utiliser l'appel "paged" 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 de fils de discussion Gmail dans la corbeille

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 une plage de threads de corbeille, quel que soit le libellé.

// 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	Nombre maximal de threads à récupérer

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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é à partir de son nom.

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

Paramètres

Nom	Type	Description
name	String	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 l'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 une liste de libellés créés par l'utilisateur.

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

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const 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 la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const 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 la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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.
const threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages();
const messages = [threadMessages[0], threadMessages[1], threadMessages[2]];
GmailApp.markMessagesRead(messages);

Paramètres

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

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

Marquez ces messages comme non lus et forcez leur actualisation.

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

Paramètres

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

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const thread = GmailApp.getInboxThreads(0, 1)[0];
GmailApp.markThreadImportant(thread);

Paramètres

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

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const 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 la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const 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 la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 son actualisation.

// Marks first inbox thread as unread
const 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 la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsImportant(threads);

Paramètres

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

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const threads = GmailApp.getInboxThreads(0, 2);
GmailApp.markThreadsRead(threads);

Paramètres

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

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 threads comme non importants et force leur actualisation.

// Marks first two threads in inbox as unimportant
const 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 la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const 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 la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

Place le message dans la corbeille et force l'actualisation du message.

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

Paramètres

Nom	Type	Description
message	GmailMessage	le message à placer dans la corbeille ;

Renvois

GmailApp : service Gmail (utile pour la chaîne)

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

Déplace les messages spécifiés dans la corbeille et force leur actualisation.

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

Paramètres

Nom	Type	Description
messages	GmailMessage[]	les messages à supprimer

Renvois

GmailApp : service Gmail (utile pour la chaîne)

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 thread dans l'archive et force son actualisation.

// Archive the first thread in your inbox
const 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 la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 dans la boîte de réception et force son actualisation.

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

Paramètres

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

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

Place ce thread dans le dossier de spam et force son actualisation.

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

Paramètres

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

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

Déplace ce thread dans la corbeille et force son actualisation.

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

Paramètres

Nom	Type	Description
thread	GmailThread	le fil de discussion à supprimer

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const 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 la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 dans la boîte de réception et les force à s'actualiser.

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

Paramètres

Nom	Type	Description
threads	GmailThread[]	un tableau de threads à déplacer vers la boîte de réception

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

Déplace ces fils de discussion dans le spam et les force à s'actualiser.

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

Paramètres

Nom	Type	Description
threads	GmailThread[]	un tableau de threads à déplacer vers le spam

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

Place ces threads dans la corbeille et force leur actualisation.

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

Paramètres

Nom	Type	Description
threads	GmailThread[]	un tableau de threads à supprimer

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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é à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).

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

Paramètres

Nom	Type	Description
message	GmailMessage	le message à actualiser ;

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).

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

Paramètres

Nom	Type	Description
messages	GmailMessage[]	les messages à actualiser ;

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

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

const 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	Fil de discussion à actualiser

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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é à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).

const 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 la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

Recherchez dans Gmail la requête indiquée.

Cet appel échouera lorsque la taille de tous les threads sera trop importante pour que le système puisse la gérer. Lorsque la taille de thread est inconnue et potentiellement très importante, veuillez utiliser l'appel "paged" et spécifier les plages de threads à récupérer dans chaque appel.

// Find starred messages with subject IMPORTANT
const 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 de fils de discussion Gmail correspondant à cette requête

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

Recherchez dans Gmail la requête indiqué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.
const 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'indice du thread de départ
max	Integer	Nombre maximal de threads à renvoyer

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 (y compris les en-têtes) est limitée par quota.

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 des arguments facultatifs. L'e-mail peut contenir du texte brut ou un corps HTML. La taille de l'e-mail (y compris les en-têtes, mais à l'exception des pièces jointes) est limitée par quota.

// Send an email with a file from Google Drive attached as a PDF.
const 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[]	un tableau de fichiers à envoyer avec l'e-mail
bcc	String	une liste d'adresses e-mail à ajouter en Cci, séparées par une virgule
cc	String	une liste d'adresses e-mail à ajouter à la liste des destinataires Cc, séparées par une virgule
from	String	Adresse à partir de laquelle l'e-mail doit être envoyé, qui doit être l'une des valeurs renvoyées par getAliases()
htmlBody	String	Si défini, les appareils capables d'afficher du code HTML l'utiliseront à la place de l'argument de corps obligatoire. Vous pouvez ajouter un champ inlineImages facultatif dans le corps HTML si vous avez intégré des images à votre e-mail.
inlineImages	Object	un objet JavaScript contenant une mise en correspondance de la clé d'image (String) aux données d'image (BlobSource) ; cela suppose que le paramètre htmlBody est utilisé et 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é à partir d'une adresse e-mail générique ne permettant pas de répondre pour dissuader les destinataires de répondre aux e-mails. Cette option n'est possible que 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: l'adresse e-mail de l'utilisateur)

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 jeton d'accès au message actuel qui permet au script d'accéder aux propriétés GmailMessage actuelles.

Seules les applications complémentaires Google Workspace qui utilisent les champs d'application des messages actuels de Gmail nécessitent cette méthode.

function handleAddonActionEvent(e) {
  GmailApp.setCurrentMessageAccessToken(e.messageMetadata.accessToken);
  const mailMessage = GmailApp.getMessageById(e.messageMetadata.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 de module complémentaire Gmail.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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
const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const message = firstThread.getMessages()[0];
GmailApp.starMessage(message);

Paramètres

Nom	Type	Description
message	GmailMessage	le message à suivre

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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)

Ajoute une étoile à ces messages et force leur actualisation.

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

Paramètres

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

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 de ce message et force l'actualisation du message.

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

Paramètres

Nom	Type	Description
message	GmailMessage	le message à désépingler ;

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 étoiles de ces messages et force leur actualisation.

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

Paramètres

Nom	Type	Description
messages	GmailMessage[]	un tableau de messages à retirer de la liste de suivi

Renvois

GmailApp : service Gmail, utile pour la concaténation

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 les nouveaux scripts.

Récupère tous les fils de discussion Google Hangouts classiques et Google Chat jusqu'à ce que Google transfère tous les utilisateurs de la version classique de Hangouts vers Chat dans le courant de l'année. Pour en savoir plus, consultez Découvrez comment passer 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. Lorsque la taille des threads est inconnue et potentiellement très importante, utilisez l'appel "paged" et spécifiez les plages de threads à récupérer dans chaque appel.

const threads = GmailApp.getChatThreads();
Logger.log(`# of chat threads: ${threads.length}`);

Renvois

GmailThread[] : tableau de fils de discussion Gmail.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec l'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 les nouveaux scripts.

Récupère une gamme de fils de discussion Google Hangouts classiques et de fils de discussion Google Chat jusqu'à ce que Google transfère tous les utilisateurs de la version classique de Hangouts vers Chat dans le courant de l'année. Pour en savoir plus, consultez Découvrez comment passer de la version classique de Hangouts à Google Chat.

// Get first 50 chat threads
const 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	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 l'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/