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ée un nouveau libellé d'utilisateur du 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érer 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 Gmail. |
getInboxThreads() | GmailThread[] | Récupère tous les fils de discussion de la boîte de réception, indépendamment des libellés. |
getInboxThreads(start, max) | GmailThread[] | Récupère un ensemble de fils de discussion de la boîte de réception, indépendamment des libellés. |
getInboxUnreadCount() | Integer | Récupère le nombre de fils de discussion non lus dans la boîte de réception. |
getMessageById(id) | GmailMessage | Récupère un message par ID. |
getMessagesForThread(thread) | GmailMessage[] | Récupère tous les messages du thread spécifié. |
getMessagesForThreads(threads) | GmailMessage[][] | Récupère tous les messages des threads spécifiés. |
getPriorityInboxThreads() | GmailThread[] | Récupère tous les fils de discussion de la boîte de réception Prioritaire, quels que soient les libellés. |
getPriorityInboxThreads(start, max) | GmailThread[] | Récupère un ensemble de fils de discussion de la boîte de réception Prioritaire, indépendamment des libellés. |
getPriorityInboxUnreadCount() | Integer | Récupère le nombre de fils de discussion non lus dans la boîte de réception Prioritaire. |
getSpamThreads() | GmailThread[] | Récupère tous les fils de discussion contenant du spam, indépendamment des libellés. |
getSpamThreads(start, max) | GmailThread[] | Récupère un éventail de fils de discussion de spam, indépendamment des 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 de discussion ajoutés aux favoris, 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() | Integer | Récupère le nombre de fils de discussion non lus suivis. |
getThreadById(id) | GmailThread | Récupère un thread par ID. |
getTrashThreads() | GmailThread[] | Récupère tous les fils de discussion de la corbeille, indépendamment des libellés. |
getTrashThreads(start, max) | GmailThread[] | Récupère un ensemble de fils de discussion de la corbeille, sans tenir compte des libellés. |
getUserLabelByName(name) | GmailLabel | Récupère un libellé en fonction du nom du libellé. |
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 | Marque ces messages comme non lus et force leur actualisation. |
markThreadImportant(thread) | GmailApp | Marque ce thread comme important et le force à s'actualiser. |
markThreadRead(thread) | GmailApp | Marque ce thread comme lu et force son actualisation. |
markThreadUnimportant(thread) | GmailApp | Marque ce thread comme non important et le force à s'actualiser. |
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 threads 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 comme non lus et force leur actualisation. |
moveMessageToTrash(message) | GmailApp | Place le message dans la corbeille et force son actualisation. |
moveMessagesToTrash(messages) | GmailApp | Place les messages spécifiés dans la corbeille et force leur actualisation. |
moveThreadToArchive(thread) | GmailApp | Déplace ce thread vers l'archive et force son actualisation. |
moveThreadToInbox(thread) | GmailApp | Déplace ce fil de discussion vers la boîte de réception et le force à s'actualiser. |
moveThreadToSpam(thread) | GmailApp | Place ce fil de discussion dans le spam et le force à s'actualiser. |
moveThreadToTrash(thread) | GmailApp | Place ce thread dans la corbeille et force son actualisation. |
moveThreadsToArchive(threads) | GmailApp | Déplace ces fils de discussion vers l'archive et force leur actualisation. |
moveThreadsToInbox(threads) | GmailApp | Déplace ces fils de discussion vers la boîte de réception et force leur actualisation. |
moveThreadsToSpam(threads) | GmailApp | Déplace ces fils dans le spam et force leur actualisation. |
moveThreadsToTrash(threads) | GmailApp | Déplace ces threads dans la corbeille et force leur actualisation. |
refreshMessage(message) | GmailApp | Actualise le message et son état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé). |
refreshMessages(messages) | GmailApp | Recharge les messages et leur état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé). |
refreshThread(thread) | GmailApp | Recharge le thread et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé). |
refreshThreads(threads) | GmailApp | Recharge les threads et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé). |
search(query) | GmailThread[] | Effectuer une recherche dans Gmail à l'aide de la requête donnée |
search(query, start, max) | GmailThread[] | Effectuer une recherche dans Gmail à l'aide de la requête donnée |
sendEmail(recipient, subject, body) | GmailApp | Envoie un e-mail. |
sendEmail(recipient, subject, body, options) | GmailApp | Envoie un e-mail avec des arguments facultatifs. |
setCurrentMessageAccessToken(accessToken) | void | Définit le jeton d'accès aux messages 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 le suivi de ces messages et force leur actualisation. |
unstarMessage(message) | GmailApp | Supprime le suivi pour ce message et le force à s'actualiser. |
unstarMessages(messages) | GmailApp | Supprime les suivis de ces messages et force leur actualisation. |
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 à un quota.
// The code below creates a draft email with the current date and time. var now = new Date(); GmailApp.createDraft("mike@example.com", "current time", "The time is: " + now.toString());
Paramètres
Nom | Type | Description |
---|---|---|
recipient | String | liste d'adresses e-mail séparées par une virgule |
subject | String | objet de l'e-mail |
body | String | corps de l'e-mail |
Renvois
GmailDraft
: le brouillon GmailBrouillon que vous venez de créer
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
createDraft(recipient, subject, body, options)
Crée un brouillon d'e-mail avec des arguments facultatifs. L'e-mail peut contenir du texte brut ou un corps HTML. La taille de l'e-mail (en-têtes inclus, mais sans les pièces jointes) est limitée au quota.
// Create a draft email with a file from Google Drive attached as a PDF. var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.createDraft('mike@example.com', 'Attachment example', 'Please see attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script' });
Paramètres
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 les paramètres avancés, listés ci-dessous ; |
Paramètres avancés
Nom | Type | Description |
---|---|---|
attachments | BlobSource[] | Tableau de fichiers à envoyer avec l'adresse e-mail |
bcc | String | d'une liste d'adresses e-mail séparées par une virgule en Cci |
cc | String | d'une liste d'adresses e-mail séparées par une virgule en copie |
from | String | Adresse à partir de laquelle l'e-mail doit être envoyé, qui doit correspondre à l'une des valeurs renvoyées par getAliases() |
htmlBody | String | Si cette valeur est définie, les appareils capables d'afficher le code HTML l'utiliseront à la place de l'argument obligatoire du corps. Vous pouvez ajouter un champ facultatif inlineImages dans le corps HTML si vous avez intégré des images à votre e-mail |
inlineImages | Object | Objet JavaScript contenant un mappage entre clé d'image (String ) et données d'image (BlobSource ). Cela suppose que le paramètre htmlBody est utilisé et qu'il contient des références à ces images au format <img src="cid:imageKey" /> |
name | String | Nom de l'expéditeur de l'e-mail (par défaut: le 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
: le brouillon GmailBrouillon que vous venez de créer
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Crée un nouveau libellé d'utilisateur du nom donné.
// Creates the label @FOO and logs label: FOO Logger.log("label: " + GmailApp.createLabel("FOO"));
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nom du nouveau libellé ; |
Renvois
GmailLabel
: libellé nouvellement créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
deleteLabel(label)
Supprime le libellé spécifié.
// Have to get the label by name first var label = GmailApp.getUserLabelByName("FOO"); GmailApp.deleteLabel(label);
Paramètres
Nom | Type | Description |
---|---|---|
label | GmailLabel | le libellé à supprimer |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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 n'importe lequel 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. var me = Session.getActiveUser().getEmail(); var aliases = GmailApp.getAliases(); Logger.log(aliases); if (aliases.length > 0) { GmailApp.sendEmail(me, 'From an alias', 'A message from an alias!', {'from': aliases[0]}); } else { GmailApp.sendEmail(me, 'No aliases found', 'You have no aliases.'); }
Renvois
String[]
: tableau d'alias pour ce compte
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
getDraft(draftId)
Récupérer un brouillon d'e-mail à l'aide de son ID
Utilisez cette méthode conjointement avec getId() pour les brouillons Gmail.
// Get the first draft message in your drafts folder var draft = GmailApp.getDrafts()[0]; // Get its ID var draftId = draft.getId(); // Now fetch the same draft using that ID. var draftById = GmailApp.getDraft(draftId); // Should always log true as they should be the same message Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());
Paramètres
Nom | Type | Description |
---|---|---|
draftId | String | ID du brouillon à récupérer |
Renvois
GmailDraft
: brouillon avec l'ID donné
Génère
Error
: si aucun brouillon ne correspond à l'ID indiqué.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
getDraftMessages()
Récupère tous les brouillons.
// Logs the number of draft messages var drafts = GmailApp.getDraftMessages(); Logger.log(drafts.length);
Renvois
GmailMessage[]
: ensemble de brouillons de messages Gmail
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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.
var drafts = GmailApp.getDrafts(); for (var i = 0; i < drafts.length; i++) { Logger.log(drafts[i].getId()); }
Renvois
GmailDraft[]
: ensemble de brouillons Gmail
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
getInboxThreads()
Récupère tous les fils de discussion de la boîte de réception, indépendamment des libellés.
Cet appel échouera si la taille de tous les threads est trop importante pour que le système puisse la gérer. Si la taille du thread n'est pas connue et qu'elle peut être très importante, utilisez l'appel "paginé" et spécifiez les plages des threads à récupérer dans chaque appel.
// Log the subject lines of your Inbox var threads = GmailApp.getInboxThreads(); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Renvois
GmailThread[]
: ensemble de fils de discussion Gmail dans la boîte de réception
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 un ensemble de fils de discussion de la boîte de réception, indépendamment des libellés.
// Log the subject lines of up to the first 50 emails in your Inbox var threads = GmailApp.getInboxThreads(0, 50); for (var i = 0; i < threads.length; i++) { Logger.log(threads[i].getFirstMessageSubject()); }
Paramètres
Nom | Type | Description |
---|---|---|
start | Integer | l'index du premier thread à récupérer |
max | Integer | Nombre maximal de threads à récupérer |
Renvois
GmailThread[]
: ensemble de fils de discussion Gmail dans la boîte de réception
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
getInboxUnreadCount()
Récupère le nombre de fils de discussion non lus dans la boîte de réception.
Logger.log("Messages unread in inbox: " + GmailApp.getInboxUnreadCount());
Renvois
Integer
: nombre de fils de discussion de la boîte de réception contenant des messages non lus
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 en conjonction avec getId() sur les messages Gmail.
// Get the first message in the first thread of your inbox var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; // Get its ID var messageId = message.getId(); // Now fetch the same message using that ID. var messageById = GmailApp.getMessageById(messageId); // Should always log true as they should be the same message Logger.log(message.getSubject() == messageById.getSubject());
Paramètres
Nom | Type | Description |
---|---|---|
id | String | ID du message à récupérer |
Renvois
GmailMessage
: message avec l'ID donné
Génère
Error
: si aucun message correspondant à l'ID donné n'est trouvé.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
getMessagesForThread(thread)
Récupère tous les messages du thread spécifié.
// Log all the subject lines in the first thread of your inbox var thread = GmailApp.getInboxThreads(0, 1)[0]; var messages = GmailApp.getMessagesForThread(thread); for (var i = 0 ; i < messages.length; i++) { Logger.log("subject: " + messages[i].getSubject()); }
Paramètres
Nom | Type | Description |
---|---|---|
thread | GmailThread | le fil 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 associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
getMessagesForThreads(threads)
Récupère tous les messages des threads spécifiés.
// Log the subject lines of all messages in the first two threads of your inbox var thread = GmailApp.getInboxThreads(0, 2); var messages = GmailApp.getMessagesForThreads(thread); for (var i = 0 ; i < messages.length; i++) { for (var j = 0; j < messages[i].length; j++) { Logger.log("subject: " + messages[i][j].getSubject()); } }
Paramètres
Nom | Type | Description |
---|---|---|
threads | GmailThread[] | les fils de discussion des messages à récupérer |
Renvois
GmailMessage[][]
: tableau de tableaux de messages, où chaque élément du tableau externe correspond à un thread et le tableau interne contient les messages de ce thread.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
getPriorityInboxThreads()
Récupère tous les fils de discussion de la boîte de réception Prioritaire, quels que soient les libellés.
Cet appel échouera si la taille de tous les threads est trop importante pour que le système puisse la gérer. Si la taille du thread n'est pas connue et qu'elle peut être très importante, utilisez l'appel "paginé" et spécifiez les plages des threads à récupérer dans chaque appel.
Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads().length);
Renvois
GmailThread[]
: ensemble 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 associée à 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 un ensemble de fils de discussion de la boîte de réception Prioritaire, indépendamment des libellés.
// Will log some number 2 or less Logger.log("# of messages in your Priority Inbox: " + GmailApp.getPriorityInboxThreads(0, 2).length);
Paramètres
Nom | Type | Description |
---|---|---|
start | Integer | l'index du premier thread à récupérer |
max | Integer | Nombre maximal de threads à récupérer |
Renvois
GmailThread[]
: ensemble 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 associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
getPriorityInboxUnreadCount()
Récupère le nombre de fils de discussion non lus dans la boîte de réception Prioritaire.
Logger.log("Number of unread emails in your Priority Inbox : " + GmailApp.getPriorityInboxUnreadCount());
Renvois
Integer
: nombre de fils de discussion de la boîte de réception Prioritaire contenant des messages non lus
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 contenant du spam, indépendamment des libellés.
Cet appel échouera si la taille de tous les threads est trop importante pour que le système puisse la gérer. Si la taille du thread n'est pas connue et qu'elle peut être très importante, utilisez l'appel "paginé" et spécifiez les plages des threads à récupérer dans chaque appel.
Logger.log("# of total spam threads: " + GmailApp.getSpamThreads().length);
Renvois
GmailThread[]
: ensemble de fils de discussion Gmail placés dans le dossier de spam
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 un éventail de fils de discussion de spam, indépendamment des 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[]
: ensemble de fils de discussion Gmail placés dans le dossier de spam
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 indésirables contenant des messages non lus
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
getStarredThreads()
Récupère tous les fils de discussion ajoutés aux favoris, indépendamment des libellés.
Cet appel échouera si la taille de tous les threads est trop importante pour que le système puisse la gérer. Si la taille du thread n'est pas connue et qu'elle peut être très importante, utilisez l'appel "paginé" et spécifiez les plages des threads à récupérer dans chaque appel.
// Logs the number of starred threads Logger.log("# Starred threads: " + GmailApp.getStarredThreads().length);
Renvois
GmailThread[]
: ensemble de fils de discussion Gmail suivis
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
getStarredThreads(start, max)
Récupère une plage de fils de discussion favoris, indépendamment des libellés.
// 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[]
: ensemble de fils de discussion Gmail suivis
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
getStarredUnreadCount()
Récupère le nombre de fils de discussion non lus suivis.
Logger.log("# unread and starred: " + GmailApp.getStarredUnreadCount());
Renvois
Integer
: nombre de fils de discussion suivis contenant des messages non lus
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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.
À utiliser conjointement avec getId() sur les fils de discussion Gmail.
// Gets the first inbox thread. const firstThread = GmailApp.getInboxThreads(0,1)[0]; // Gets the same thread by ID. const threadById = GmailApp.getThreadById(firstThread.getId()); // Verifies that they are the same. console.log(firstThread.getFirstMessageSubject() === threadById.getFirstMessageSubject());
Paramètres
Nom | Type | Description |
---|---|---|
id | String | ID du thread à récupérer. |
Renvois
GmailThread
: fil de discussion avec l'ID donné ou null
si aucun fil de discussion n'a été trouvé.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
getTrashThreads()
Récupère tous les fils de discussion de la corbeille, indépendamment des libellés.
Cet appel échouera si la taille de tous les threads est trop importante pour que le système puisse la gérer. Si la taille du thread n'est pas connue et qu'elle peut être très importante, utilisez l'appel "paginé" et spécifiez les plages des threads à récupérer dans chaque appel.
Logger.log("# of total trash threads: " + GmailApp.getTrashThreads().length);
Renvois
GmailThread[]
: ensemble de fils de discussion Gmail placés dans la corbeille
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 un ensemble de fils de discussion de la corbeille, sans tenir compte des libellés.
// Will log a number at most 5 Logger.log("# of total trash threads: " + GmailApp.getTrashThreads(0, 5).length);
Paramètres
Nom | Type | Description |
---|---|---|
start | Integer | l'index du premier thread à récupérer |
max | Integer | Nombre maximal de threads à récupérer |
Renvois
GmailThread[]
: ensemble de fils de discussion Gmail placés dans la corbeille
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
getUserLabelByName(name)
Récupère un libellé en fonction du nom du libellé.
var labelObject = GmailApp.getUserLabelByName("myLabel");
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nom de l'étiquette à récupérer |
Renvois
GmailLabel
: libellé Gmail portant le nom donné
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 var labels = GmailApp.getUserLabels(); for (var i = 0; i < labels.length; i++) { Logger.log("label: " + labels[i].getName()); }
Renvois
GmailLabel[]
: tableau des libellés créés par les utilisateurs
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
markMessageRead(message)
Marque ce message comme lu et force son actualisation.
// Mark the first message in the first thread of your inbox as read var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageRead(message);
Paramètres
Nom | Type | Description |
---|---|---|
message | GmailMessage | le message à marquer comme lu |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
markMessageUnread(message)
Marque ce message comme non lu et force son actualisation.
// Mark the first message in the first thread of your inbox as unread var message = GmailApp.getInboxThreads(0, 1)[0].getMessages()[0]; GmailApp.markMessageUnread(message);
Paramètres
Nom | Type | Description |
---|---|---|
message | GmailMessage | le message à marquer comme non lu |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
markMessagesRead(messages)
Marque ces messages comme lus et force leur actualisation.
// Mark first three messages in the first inbox thread as read. // Assumes that the first inbox thread has 3 messages in it. var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesRead(thread.getMessages());
Paramètres
Nom | Type | Description |
---|---|---|
messages | GmailMessage[] | Tableau de messages à marquer comme lus |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
markMessagesUnread(messages)
Marque ces messages comme non lus et force leur actualisation.
// Mark first three messages in the first inbox thread as unread. // Assumes that the first inbox thread has 3 messages in it var threadMessages = GmailApp.getInboxThreads(0, 1)[0].getMessages(); var messages = [threadMessages[0], threadMessages[1], threadMessages[2]]; GmailApp.markMessagesUnread(thread.getMessages());
Paramètres
Nom | Type | Description |
---|---|---|
messages | GmailMessage[] | Tableau des messages à marquer comme non lus |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
markThreadImportant(thread)
Marque ce thread comme important et le force à s'actualiser.
// Marks first inbox thread as important var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadImportant(thread);
Paramètres
Nom | Type | Description |
---|---|---|
thread | GmailThread | le fil de discussion à marquer comme important |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
markThreadRead(thread)
Marque ce thread comme lu et force son actualisation.
// Marks first inbox thread as read var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadRead(thread);
Paramètres
Nom | Type | Description |
---|---|---|
thread | GmailThread | le fil de discussion à marquer comme lu |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
markThreadUnimportant(thread)
Marque ce thread comme non important et le force à s'actualiser.
// Marks first inbox thread as unimportant var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnimportant(thread);
Paramètres
Nom | Type | Description |
---|---|---|
thread | GmailThread | le fil de discussion à marquer comme non important |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
markThreadUnread(thread)
Marque ce fil de discussion comme non lu et force son actualisation.
// Marks first inbox thread as unread var thread = GmailApp.getInboxThreads(0, 1)[0]; GmailApp.markThreadUnread(thread);
Paramètres
Nom | Type | Description |
---|---|---|
thread | GmailThread | le fil de discussion à marquer comme non lu |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
markThreadsImportant(threads)
Marque ces threads comme importants et force leur actualisation.
// Marks first two threads in inbox as important var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsImportant(threads);
Paramètres
Nom | Type | Description |
---|---|---|
threads | GmailThread[] | Un tableau de fils de discussion à marquer comme importants |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Marque ces threads comme lus et force leur actualisation.
// Marks first two threads in inbox as read var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsRead(threads);
Paramètres
Nom | Type | Description |
---|---|---|
threads | GmailThread[] | Un tableau de threads à marquer comme lu |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
markThreadsUnimportant(threads)
Marque ces threads comme non importants et force leur actualisation.
// Marks first two threads in inbox as unimportant var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnimportant(threads);
Paramètres
Nom | Type | Description |
---|---|---|
threads | GmailThread[] | Un tableau de threads à marquer comme sans importance |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
markThreadsUnread(threads)
Marque ces fils comme non lus et force leur actualisation.
// Marks first two threads in inbox as unread var threads = GmailApp.getInboxThreads(0, 2); GmailApp.markThreadsUnread(threads);
Paramètres
Nom | Type | Description |
---|---|---|
threads | GmailThread[] | Un tableau des fils de discussion à marquer comme non lus |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Place le message dans la corbeille et force son actualisation.
// Move the first message in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var firstMessage = firstThread.getMessages()[0]; GmailApp.moveMessageToTrash(firstMessage);
Paramètres
Nom | Type | Description |
---|---|---|
message | GmailMessage | le message à placer dans la corbeille |
Renvois
GmailApp
: service Gmail (utile pour le chaînage)
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Place les messages spécifiés dans la corbeille et force leur actualisation.
// Move first two messages in your inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; var messages = firstThread.getMessages(); var toDelete = [messages[0], messages[1]]; GmailApp.moveMessagesToTrash(toDelete);
Paramètres
Nom | Type | Description |
---|---|---|
messages | GmailMessage[] | les messages à placer dans la corbeille |
Renvois
GmailApp
: service Gmail (utile pour le chaînage)
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
moveThreadToArchive(thread)
Déplace ce thread vers l'archive et force son actualisation.
// Archive the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToArchive(firstThread);
Paramètres
Nom | Type | Description |
---|---|---|
thread | GmailThread | le fil de discussion à archiver |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Déplace ce fil de discussion vers la boîte de réception et le force à s'actualiser.
// Find a thread not already in your inbox var thread = GmailApp.search("-in:inbox")[0]; // Get the first one GmailApp.moveThreadToInbox(thread);
Paramètres
Nom | Type | Description |
---|---|---|
thread | GmailThread | à placer le fil de discussion dans la boîte de réception |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
moveThreadToSpam(thread)
Place ce fil de discussion dans le spam et le force à s'actualiser.
// Tag first thread in inbox as spam var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToSpam(firstThread);
Paramètres
Nom | Type | Description |
---|---|---|
thread | GmailThread | le fil de discussion à placer dans le spam |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Place ce thread dans la corbeille et force son actualisation.
// Move first thread in inbox to trash var firstThread = GmailApp.getInboxThreads(0,1)[0]; GmailApp.moveThreadToTrash(firstThread);
Paramètres
Nom | Type | Description |
---|---|---|
thread | GmailThread | le fil de discussion à placer dans la corbeille |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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
Nom | Type | Description |
---|---|---|
threads | GmailThread[] | un tableau de fils de discussion à archiver |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Déplace ces fils de discussion vers la boîte de réception et force leur actualisation.
// Find two threads not already in your inbox var firstTwoThreads = GmailApp.search("-in:inbox", 0, 2); GmailApp.moveThreadsToInbox(firstTwoThreads);
Paramètres
Nom | Type | Description |
---|---|---|
threads | GmailThread[] | Tableau des fils de discussion à placer dans la boîte de réception |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
moveThreadsToSpam(threads)
Déplace ces fils dans le spam et force leur actualisation.
// Move first two threads in your inbox to spam var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToSpam(firstTwoThreads);
Paramètres
Nom | Type | Description |
---|---|---|
threads | GmailThread[] | Tableau des fils de discussion à placer dans le spam |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Déplace ces threads dans la corbeille et force leur actualisation.
// Move first two threads in your inbox to trash var firstTwoThreads = GmailApp.getInboxThreads(0,2); GmailApp.moveThreadsToTrash(firstTwoThreads);
Paramètres
Nom | Type | Description |
---|---|---|
threads | GmailThread[] | un tableau de threads à placer dans la corbeille ; |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
refreshMessage(message)
Actualise le message et son é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
Nom | Type | Description |
---|---|---|
message | GmailMessage | le message à actualiser |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
refreshMessages(messages)
Recharge les messages et leur état associé à 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
Nom | Type | Description |
---|---|---|
messages | GmailMessage[] | les messages à actualiser |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Recharge le thread et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
var firstThread = GmailApp.getInboxThreads(0,1)[0]; // ...Do something that may take a while here.... GmailApp.refreshThread(firstThread); // ... Do more stuff with the thread ...
Paramètres
Nom | Type | Description |
---|---|---|
thread | GmailThread | à actualiser le thread |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
refreshThreads(threads)
Recharge les threads 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
Nom | Type | Description |
---|---|---|
threads | GmailThread[] | les threads à actualiser |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
search(query)
Effectuer une recherche dans Gmail à l'aide de la requête donnée
Cet appel échouera si la taille de tous les threads est trop importante pour que le système puisse la gérer. Si la taille du thread n'est pas connue et qu'elle peut être très importante, utilisez l'appel "paginé" et spécifiez les plages des threads à récupérer dans chaque appel.
// Find starred messages with subject IMPORTANT var threads = GmailApp.search('is:starred subject:"IMPORTANT"');
Paramètres
Nom | Type | Description |
---|---|---|
query | String | la requête de recherche, comme 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 associée à 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)
Effectuer une recherche dans Gmail à l'aide de la requête donnée
// Find starred messages with subject IMPORTANT and return second batch of 10. // Assumes there are at least 11 of them, otherwise this will return an empty array. var threads = GmailApp.search('is:starred subject:"IMPORTANT"', 10, 10);
Paramètres
Nom | Type | Description |
---|---|---|
query | String | la requête de recherche, comme vous la saisiriez dans Gmail |
start | Integer | l'index du thread de démarrage |
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 associée à 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 à un quota.
// The code below will send an email with the current date and time. var now = new Date(); GmailApp.sendEmail("mike@example.com", "current time", "The time is: " + now.toString());
Paramètres
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 associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
sendEmail(recipient, subject, body, options)
Envoie un e-mail avec des arguments facultatifs. L'e-mail peut contenir du texte brut ou un corps HTML. La taille de l'e-mail (en-têtes inclus, mais sans les pièces jointes) est limitée au quota.
// Send an email with a file from Google Drive attached as a PDF. var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); GmailApp.sendEmail('mike@example.com', 'Attachment example', 'Please see the attached file.', { attachments: [file.getAs(MimeType.PDF)], name: 'Automatic Emailer Script' });
Paramètres
Nom | Type | Description |
---|---|---|
recipient | String | les adresses du destinataire, |
subject | String | l'objet (250 caractères au maximum) ; |
body | String | le corps de l'e-mail ; |
options | Object | un objet JavaScript qui spécifie les paramètres avancés, listés ci-dessous ; |
Paramètres avancés
Nom | Type | Description |
---|---|---|
attachments | BlobSource[] | Tableau de fichiers à envoyer avec l'adresse e-mail |
bcc | String | d'une liste d'adresses e-mail séparées par une virgule en Cci |
cc | String | d'une liste d'adresses e-mail séparées par une virgule en copie |
from | String | Adresse à partir de laquelle l'e-mail doit être envoyé, qui doit correspondre à l'une des valeurs renvoyées par getAliases() |
htmlBody | String | Si cette valeur est définie, les appareils capables d'afficher le code HTML l'utiliseront à la place de l'argument obligatoire du corps. Vous pouvez ajouter un champ facultatif inlineImages dans le corps HTML si vous avez intégré des images à votre e-mail |
inlineImages | Object | Objet JavaScript contenant un mappage entre clé d'image (String ) et données d'image (BlobSource ). Cela suppose que le paramètre htmlBody est utilisé et qu'il contient des références à ces images au format <img src="cid:imageKey" /> |
name | String | Nom de l'expéditeur de l'e-mail (par défaut: le nom de l'utilisateur) |
noReply | Boolean | true si l'e-mail doit être envoyé à partir d'une adresse e-mail générique qui ne doit pas recevoir de réponse afin de dissuader les destinataires de répondre (cette option n'est disponible que pour les comptes Google Workspace, pas 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 associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
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 des messages 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
Nom | Type | Description |
---|---|---|
accessToken | String | Le jeton d'accès temporaire obtenu à partir d'un objet d'événement d'action du module complémentaire Gmail |
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
starMessage(message)
Ajoute une étoile à ce message et force son actualisation.
// Stars the first message in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; GmailApp.starMessage(message);
Paramètres
Nom | Type | Description |
---|---|---|
message | GmailMessage | le message pour lequel activer le suivi |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Ajoute le suivi de ces messages et force leur actualisation.
// Stars the first three messages in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.starMessages(coupleOfMessages);
Paramètres
Nom | Type | Description |
---|---|---|
messages | GmailMessage[] | d'un tableau de messages à suivre |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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)
Supprime le suivi pour ce message et le force à s'actualiser.
// Unstars the first message in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var message = firstThread.getMessages()[0]; GmailApp.unstarMessage(message);
Paramètres
Nom | Type | Description |
---|---|---|
message | GmailMessage | le message pour désactiver le suivi |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants ou des champs d'application appropriés de l'API REST associée:
-
https://mail.google.com/
Voir aussi
unstarMessages(messages)
Supprime les suivis de ces messages et force leur actualisation.
// Unstars the first three messages in the first thread in your inbox var firstThread = GmailApp.getInboxThreads(0,1)[0]; var coupleOfMessages = firstThread.getMessages().slice(0, 3); GmailApp.unstarMessages(coupleOfMessages);
Paramètres
Nom | Type | Description |
---|---|---|
messages | GmailMessage[] | un tableau de messages dont le suivi |
Renvois
GmailApp
: service Gmail, utile pour associer des chaînes
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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/