Class GmailApp

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
Application Gmail

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

Méthodes

MéthodeType renvoyéBrève description
createDraft(recipient, subject, body)GmailDraftPermet de créer un brouillon d'e-mail.
createDraft(recipient, subject, body, options)GmailDraftCrée un brouillon d'e-mail avec des arguments facultatifs.
createLabel(name)GmailLabelCréez un libellé utilisateur pour le nom donné.
deleteLabel(label)GmailAppSupprime 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)GmailDraftRécupérez un brouillon d'e-mail à l'aide de son ID.
getDraftMessages()GmailMessage[]Récupère tous les brouillons.
getDrafts()GmailDraft[]Récupère tous les brouillons dans Gmail.
getInboxThreads()GmailThread[]Récupère tous les fils de discussion, quels que soient les libellés.
getInboxThreads(start, max)GmailThread[]Récupère un ensemble de fils de discussion, quels que soient les libellés.
getInboxUnreadCount()IntegerRécupère le nombre de fils de discussion non lus dans la boîte de réception.
getMessageById(id)GmailMessageRécupère un message par ID.
getMessagesForThread(thread)GmailMessage[]Permet de récupérer tous les messages du fil de discussion spécifié.
getMessagesForThreads(threads)GmailMessage[][]Permet de récupérer tous les messages des fils de discussion spécifiés.
getPriorityInboxThreads()GmailThread[]Récupère tous les fils de discussion prioritaires, quels que soient les libellés.
getPriorityInboxThreads(start, max)GmailThread[]Récupère un ensemble de fils de discussion de la boîte de réception Prioritaire, quel que soit le libellé.
getPriorityInboxUnreadCount()IntegerRé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, quels que soient les libellés.
getSpamThreads(start, max)GmailThread[]Récupère un ensemble de fils de discussion, quel que soit leur libellé.
getSpamUnreadCount()IntegerRécupère le nombre de fils de discussion non lus qui sont du spam.
getStarredThreads()GmailThread[]Récupère tous les fils de discussion suivis, indépendamment des libellés.
getStarredThreads(start, max)GmailThread[]Récupère une plage de fils de discussion favoris, indépendamment des libellés.
getStarredUnreadCount()IntegerRécupère le nombre de fils de discussion non lus ajoutés aux favoris.
getThreadById(id)GmailThreadRécupère un thread par ID.
getTrashThreads()GmailThread[]Récupère tous les fils de discussion, quel que soit leur libellé.
getTrashThreads(start, max)GmailThread[]Récupère une plage de fils de discussion, quel que soit leur libellé.
getUserLabelByName(name)GmailLabelRécupère un libellé à partir du nom du libellé.
getUserLabels()GmailLabel[]Récupère la liste des libellés créés par l'utilisateur.
markMessageRead(message)GmailAppMarque ce message comme lu et force son actualisation.
markMessageUnread(message)GmailAppMarque ce message comme non lu et force son actualisation.
markMessagesRead(messages)GmailAppPermet de marquer ces messages comme lus et de forcer leur actualisation.
markMessagesUnread(messages)GmailAppMarque ces messages comme non lus et force leur actualisation.
markThreadImportant(thread)GmailAppPermet de marquer ce fil de discussion comme important et de forcer son actualisation.
markThreadRead(thread)GmailAppPermet de marquer ce fil comme lu et de forcer l'actualisation.
markThreadUnimportant(thread)GmailAppPermet de marquer ce fil de discussion comme non important et de forcer l'actualisation.
markThreadUnread(thread)GmailAppMarque ce fil comme non lu et force son actualisation.
markThreadsImportant(threads)GmailAppMarque ces fils comme importants et force leur actualisation.
markThreadsRead(threads)GmailAppMarque ces fils comme lus et force leur actualisation.
markThreadsUnimportant(threads)GmailAppPermet de marquer ces fils de discussion comme non importants et de les forcer à s'actualiser.
markThreadsUnread(threads)GmailAppMarque ces fils de discussion comme non lus et force leur actualisation.
moveMessageToTrash(message)GmailAppPermet de placer le message dans la corbeille et de forcer son actualisation.
moveMessagesToTrash(messages)GmailAppPermet de placer les messages spécifiés dans la corbeille et de forcer leur actualisation.
moveThreadToArchive(thread)GmailAppPermet de déplacer ce fil de discussion vers l'archive et de forcer son actualisation.
moveThreadToInbox(thread)GmailAppPermet de déplacer ce fil de discussion vers la boîte de réception et de forcer l'actualisation.
moveThreadToSpam(thread)GmailAppPermet de déplacer ce fil de discussion vers le dossier "Spam" et de forcer l'actualisation.
moveThreadToTrash(thread)GmailAppPermet de placer ce fil dans la corbeille et de forcer l'actualisation.
moveThreadsToArchive(threads)GmailAppDéplace ces fils de discussion vers l'archive et force leur actualisation.
moveThreadsToInbox(threads)GmailAppPermet de déplacer ces fils de discussion vers la boîte de réception et de forcer leur actualisation.
moveThreadsToSpam(threads)GmailAppPermet de placer ces fils de discussion dans le dossier "Spam" et de forcer leur actualisation.
moveThreadsToTrash(threads)GmailAppPermet de placer ces fils de discussion dans la corbeille et de forcer leur actualisation.
refreshMessage(message)GmailAppActualise le message et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).
refreshMessages(messages)GmailAppActualise les messages et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).
refreshThread(thread)GmailAppIl 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)GmailAppIl actualise 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[]Lancez une recherche Gmail dans la requête donnée.
search(query, start, max)GmailThread[]Lancez une recherche Gmail dans la requête donnée.
sendEmail(recipient, subject, body)GmailAppEnvoie un e-mail.
sendEmail(recipient, subject, body, options)GmailAppEnvoie un e-mail avec des arguments facultatifs.
setCurrentMessageAccessToken(accessToken)voidDéfinit le jeton d'accès aux messages actuel qui permet au script d'accéder aux propriétés GmailMessage actuelles.
starMessage(message)GmailAppAjoute une étoile à ce message et force son actualisation.
starMessages(messages)GmailAppAjoute des messages à ces messages et force leur actualisation.
unstarMessage(message)GmailAppSupprime une étoile de ce message et force son actualisation.
unstarMessages(messages)GmailAppSupprime les étoiles de ces messages et force l'actualisation des messages.

Documentation détaillée

createDraft(recipient, subject, body)

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

// The code below creates a draft email with the current date and time.
var now = new Date();
GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());

Paramètres

NomTypeDescription
recipientStringliste d'adresses e-mail séparées par une virgule
subjectStringobjet de l'e-mail
bodyStringcorps de l'e-mail

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

Voir aussi


createDraft(recipient, subject, body, options)

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

// Create a draft email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Paramètres

NomTypeDescription
recipientStringles adresses du destinataire ;
subjectStringl'objet
bodyStringle corps de l'e-mail
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
attachmentsBlobSource[]Tableau de fichiers à envoyer avec l'adresse e-mail
bccStringune liste d'adresses e-mail à envoyer en Cci, séparées par une virgule
ccStringliste d'adresses e-mail séparées par une virgule à mettre en copie
fromStringAdresse à partir de laquelle l'e-mail doit être envoyé, qui doit être l'une des valeurs renvoyées par getAliases()
htmlBodyStringSi ce champ est défini, les appareils capables d'afficher le code HTML l'utiliseront à la place de l'argument <body> obligatoire. Vous pouvez ajouter un champ inlineImages facultatif dans le corps HTML si vous avez des images intégrées pour votre adresse e-mail.
inlineImagesObjectUn objet JavaScript contenant un mappage entre la clé image (String) et 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" />.
nameStringNom de l'expéditeur de l'e-mail (par défaut: nom de l'utilisateur)
replyToStringUne adresse e-mail à utiliser par défaut comme adresse de réponse (par défaut: l'adresse e-mail de l'utilisateur)

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

Voir aussi


createLabel(name)

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

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

Paramètres

NomTypeDescription
nameStringle nom du nouveau libellé.

Aller-retour

GmailLabel : le nouveau libellé

Autorisation

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

  • https://mail.google.com/

Voir aussi


deleteLabel(label)

Supprime le libellé spécifié.

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

Paramètres

NomTypeDescription
labelGmailLabelle libellé à supprimer

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


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 &fromt;from".

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

Aller-retour

String[] : tableau d'alias pour ce compte

Autorisation

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

  • https://mail.google.com/

Voir aussi


getDraft(draftId)

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

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

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

Paramètres

NomTypeDescription
draftIdStringID du brouillon à récupérer

Aller-retour

GmailDraft : le brouillon avec l'ID donné

Génère

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

Autorisation

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

  • https://mail.google.com/

getDraftMessages()

Récupère tous les brouillons.

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

Aller-retour

GmailMessage[] : tableau des brouillons de messages Gmail

Autorisation

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

  • https://mail.google.com/

getDrafts()

Récupère tous les brouillons dans Gmail.

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

Aller-retour

GmailDraft[] : tableau des brouillons dans Gmail

Autorisation

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

  • https://mail.google.com/

getInboxThreads()

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

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

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

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

getInboxThreads(start, max)

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

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

Paramètres

NomTypeDescription
startIntegerindex du premier thread à récupérer
maxIntegernombre maximal de fils de discussion à récupérer

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

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

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

getMessageById(id)

Récupère un message par ID.

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

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

Paramètres

NomTypeDescription
idStringIdentifiant du message à récupérer

Aller-retour

GmailMessage : message avec l'ID donné

Génère

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

Autorisation

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

  • https://mail.google.com/

Voir aussi


getMessagesForThread(thread)

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

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

Paramètres

NomTypeDescription
threadGmailThreadfil de discussion des messages à récupérer

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

Voir aussi


getMessagesForThreads(threads)

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

// Log the subject lines of all messages in the first two threads of your inbox
var thread = GmailApp.getInboxThreads(0, 2);
var messages = GmailApp.getMessagesForThreads(thread);
for (var i = 0 ; i < messages.length; i++) {
  for (var j = 0; j < messages[i].length; j++) {
    Logger.log("subject: " + messages[i][j].getSubject());
  }
}

Paramètres

NomTypeDescription
threadsGmailThread[]fils de discussion des messages à récupérer

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

Voir aussi


getPriorityInboxThreads()

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

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

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

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

getPriorityInboxThreads(start, max)

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

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

Paramètres

NomTypeDescription
startIntegerindex du premier thread à récupérer
maxIntegernombre maximal de fils de discussion à récupérer

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

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

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

getSpamThreads()

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

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

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

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

getSpamThreads(start, max)

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

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

Paramètres

NomTypeDescription
startIntegerindex du premier thread à récupérer
maxIntegernombre maximal de fils de discussion à récupérer

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

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

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

getStarredThreads()

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

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

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

Aller-retour

GmailThread[] : tableau des fils de discussion Gmail suivis

Autorisation

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

  • https://mail.google.com/

getStarredThreads(start, max)

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

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

Paramètres

NomTypeDescription
startIntegerindex du premier thread à récupérer
maxIntegernombre maximal de fils de discussion à récupérer

Aller-retour

GmailThread[] : tableau des fils de discussion Gmail suivis

Autorisation

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

  • https://mail.google.com/

getStarredUnreadCount()

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

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

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

getThreadById(id)

Récupère un thread par ID.

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

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

Paramètres

NomTypeDescription
idStringID du fil de discussion à récupérer

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

Voir aussi


getTrashThreads()

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

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

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

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

getTrashThreads(start, max)

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

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

Paramètres

NomTypeDescription
startIntegerindex du premier thread à récupérer
maxIntegernombre maximal de fils de discussion à récupérer

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

getUserLabelByName(name)

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

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

Paramètres

NomTypeDescription
nameStringNom du libellé à récupérer.

Aller-retour

GmailLabel : libellé Gmail portant le nom donné

Autorisation

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

  • https://mail.google.com/

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

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

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

NomTypeDescription
messageGmailMessagele message à marquer comme lu

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markMessageUnread(message)

Marque ce message comme non lu et force son actualisation.

// Mark the first message in the first thread of your inbox as unread
var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0];
GmailApp.markMessageUnread(message);

Paramètres

NomTypeDescription
messageGmailMessagele message à marquer comme non lu

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markMessagesRead(messages)

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

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

Paramètres

NomTypeDescription
messagesGmailMessage[]Tableau des messages à marquer comme lus

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markMessagesUnread(messages)

Marque ces messages comme non lus et force leur actualisation.

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

Paramètres

NomTypeDescription
messagesGmailMessage[]tableau des messages à marquer comme non lus

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markThreadImportant(thread)

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

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

Paramètres

NomTypeDescription
threadGmailThreadle fil de discussion à marquer comme important

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markThreadRead(thread)

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

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

Paramètres

NomTypeDescription
threadGmailThreadle fil de discussion à marquer comme lu

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markThreadUnimportant(thread)

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

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

Paramètres

NomTypeDescription
threadGmailThreadle fil de discussion à marquer comme non important

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markThreadUnread(thread)

Marque ce fil comme non lu et force son actualisation.

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

Paramètres

NomTypeDescription
threadGmailThreadle fil de discussion à marquer comme non lu

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markThreadsImportant(threads)

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

NomTypeDescription
threadsGmailThread[]Tableau des fils de discussion à marquer comme important

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markThreadsRead(threads)

Marque ces fils comme lus et force leur actualisation.

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

Paramètres

NomTypeDescription
threadsGmailThread[]tableau de fils de discussion à marquer comme lus

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markThreadsUnimportant(threads)

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

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

Paramètres

NomTypeDescription
threadsGmailThread[]tableau de fils de discussion à marquer comme non important

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


markThreadsUnread(threads)

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

NomTypeDescription
threadsGmailThread[]Tableau des fils de discussion à marquer comme non lus

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


moveMessageToTrash(message)

Permet de 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

NomTypeDescription
messageGmailMessagele message sera placé dans la corbeille

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

Voir aussi


moveMessagesToTrash(messages)

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

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

Paramètres

NomTypeDescription
messagesGmailMessage[]les messages à placer dans la corbeille.

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

Voir aussi


moveThreadToArchive(thread)

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

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

Paramètres

NomTypeDescription
threadGmailThreadle fil de discussion à archiver

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


moveThreadToInbox(thread)

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

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

Paramètres

NomTypeDescription
threadGmailThreadle fil de discussion à déplacer dans la boîte de réception

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


moveThreadToSpam(thread)

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

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

Paramètres

NomTypeDescription
threadGmailThreadle fil de discussion à déplacer vers le dossier "Spam"

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


moveThreadToTrash(thread)

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

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

Paramètres

NomTypeDescription
threadGmailThreadle fil de discussion à placer dans la corbeille

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


moveThreadsToArchive(threads)

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

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

Paramètres

NomTypeDescription
threadsGmailThread[]Tableau des fils de discussion à archiver

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


moveThreadsToInbox(threads)

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

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

Paramètres

NomTypeDescription
threadsGmailThread[]Tableau des fils de discussion à déplacer dans la boîte de réception

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


moveThreadsToSpam(threads)

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

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

Paramètres

NomTypeDescription
threadsGmailThread[]tableau des fils de discussion à déplacer vers le spam

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


moveThreadsToTrash(threads)

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

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

Paramètres

NomTypeDescription
threadsGmailThread[]Tableau des fils de discussion à placer dans la corbeille

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


refreshMessage(message)

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

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

Paramètres

NomTypeDescription
messageGmailMessagele message à actualiser

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


refreshMessages(messages)

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

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

Paramètres

NomTypeDescription
messagesGmailMessage[]messages à actualiser

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


refreshThread(thread)

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

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

Paramètres

NomTypeDescription
threadGmailThreadle fil de discussion à actualiser

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


refreshThreads(threads)

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

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

Paramètres

NomTypeDescription
threadsGmailThread[]fils de discussion à actualiser

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


search(query)

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

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

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

Paramètres

NomTypeDescription
queryStringla requête de recherche, comme vous le feriez dans Gmail.

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

search(query, start, max)

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

// Find starred messages with subject IMPORTANT and return second batch of 10.
// Assumes there are at least 11 of them, otherwise this will return an empty array.
var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);

Paramètres

NomTypeDescription
queryStringla requête de recherche, comme vous le feriez dans Gmail.
startIntegerindex du fil de discussion de départ
maxIntegernombre maximal de fils de discussion à renvoyer

Aller-retour

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

Autorisation

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

  • https://mail.google.com/

sendEmail(recipient, subject, body)

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

// The code below will send an email with the current date and time.
var now = new Date();
GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());

Paramètres

NomTypeDescription
recipientStringliste d'adresses e-mail séparées par une virgule
subjectStringobjet de l'e-mail (250 caractères maximum)
bodyStringcorps de l'e-mail

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


sendEmail(recipient, subject, body, options)

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

// Send an email with a file from Google Drive attached as a PDF.
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Paramètres

NomTypeDescription
recipientStringles adresses du destinataire ;
subjectStringla ligne d'objet (250 caractères maximum)
bodyStringle corps de l'e-mail
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
attachmentsBlobSource[]Tableau de fichiers à envoyer avec l'adresse e-mail
bccStringune liste d'adresses e-mail à envoyer en Cci, séparées par une virgule
ccStringliste d'adresses e-mail séparées par une virgule à mettre en copie
fromStringAdresse à partir de laquelle l'e-mail doit être envoyé, qui doit être l'une des valeurs renvoyées par getAliases()
htmlBodyStringSi ce champ est défini, les appareils capables d'afficher le code HTML l'utiliseront à la place de l'argument <body> obligatoire. Vous pouvez ajouter un champ inlineImages facultatif dans le corps HTML si vous avez des images intégrées pour votre adresse e-mail.
inlineImagesObjectUn objet JavaScript contenant un mappage entre la clé image (String) et 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" />.
nameStringNom de l'expéditeur de l'e-mail (par défaut: nom de l'utilisateur)
noReplyBooleantrue si l'e-mail doit être envoyé depuis une adresse e-mail générique sans réponse pour dissuader les destinataires de répondre à des e-mails. Cette option n'est disponible que pour les comptes Google Workspace, et non pour les utilisateurs Gmail.
replyToStringUne adresse e-mail à utiliser par défaut comme adresse de réponse (par défaut: l'adresse e-mail de l'utilisateur)

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


setCurrentMessageAccessToken(accessToken)

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

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

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

Paramètres

NomTypeDescription
accessTokenStringLe jeton d'accès temporaire obtenu à partir d'un objet 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 les 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

NomTypeDescription
messageGmailMessagele message à suivre

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


starMessages(messages)

Ajoute des messages à ces messages et force leur actualisation.

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

Paramètres

NomTypeDescription
messagesGmailMessage[]Tableau des messages à suivre

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


unstarMessage(message)

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

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

Paramètres

NomTypeDescription
messageGmailMessagemessage à retirer des favoris

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi


unstarMessages(messages)

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

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

Paramètres

NomTypeDescription
messagesGmailMessage[]Tableau des messages à supprimer des favoris

Aller-retour

GmailApp : service Gmail utile pour le chaînage

Autorisation

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

  • https://mail.google.com/

Voir aussi

Méthodes obsolètes