Class GmailMessage

GmailMessage

Un message dans le compte Gmail d'un utilisateur

Méthodes

MéthodeType renvoyéBrève description
createDraftReply(body)GmailDraftCrée un brouillon de message en réponse à l'expéditeur à l'aide de l'adresse de réponse.
createDraftReply(body, options)GmailDraftCrée un brouillon de message répondant à l'expéditeur à l'aide de l'adresse de réponse, avec des arguments facultatifs.
createDraftReplyAll(body)GmailDraftCrée un brouillon qui répond à l'expéditeur en utilisant l'adresse de réponse et tous les destinataires de ce message.
createDraftReplyAll(body, options)GmailDraftCrée un brouillon de réponse à l'expéditeur en utilisant l'adresse de réponse et tous les destinataires, avec des arguments facultatifs.
forward(recipient)GmailMessageTransfère ce message aux nouveaux destinataires.
forward(recipient, options)GmailMessageCe message est transféré à de nouveaux destinataires, avec des arguments facultatifs.
getAttachments()GmailAttachment[]Récupère toutes les pièces jointes de ce message.
getAttachments(options)GmailAttachment[]Récupère toutes les pièces jointes de ce message.
getBcc()StringRécupère les destinataires séparés par une virgule en Cci pour ce message.
getBody()StringRécupère le contenu HTML du corps de ce message.
getCc()StringRécupère les destinataires séparés par une virgule en copie de ce message.
getDate()DateRécupère la date et l'heure de ce message.
getFrom()StringRécupère l'expéditeur de ce message.
getHeader(name)StringRécupère la valeur d'un en-tête RFC 2822 en fonction du nom de l'en-tête.
getId()StringRécupère l'ID de ce message.
getPlainBody()StringRécupère le contenu du corps de ce message sans la mise en forme HTML.
getRawContent()StringRécupère le contenu brut de ce message.
getReplyTo()StringRécupère l'adresse de réponse de ce message (généralement l'expéditeur).
getSubject()StringRécupère l'objet de ce message.
getThread()GmailThreadRécupère le fil de discussion contenant ce message.
getTo()StringRécupère les destinataires de ce message, séparés par une virgule.
isDraft()BooleanDétermine s'il s'agit d'un brouillon.
isInChats()BooleanDétermine s'il s'agit d'un message de chat.
isInInbox()BooleanDétermine si ce message se trouve dans la boîte de réception.
isInPriorityInbox()BooleanRenvoie true si ce message se trouve dans la boîte de réception prioritaire. Sinon, renvoie false.
isInTrash()BooleanDétermine si ce message se trouve dans la corbeille.
isStarred()BooleanDétermine si ce message est suivi.
isUnread()BooleanDétermine si ce message est non lu.
markRead()GmailMessageMarque le message comme lu.
markUnread()GmailMessageMarque le message comme non lu.
moveToTrash()GmailMessagePermet de placer le message dans la corbeille.
refresh()GmailMessageRecharge ce message et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
reply(body)GmailMessagePermet de répondre à l'expéditeur du message en utilisant l'adresse de réponse.
reply(body, options)GmailMessagePermet de répondre à l'expéditeur de ce message en utilisant l'adresse de réponse, avec des arguments facultatifs.
replyAll(body)GmailMessageRépondre à l'expéditeur avec l'adresse de réponse et tous les destinataires du message
replyAll(body, options)GmailMessageRépondez à l'expéditeur de ce message en utilisant l'adresse de réponse et tous les destinataires, avec les arguments facultatifs.
star()GmailMessagePermet d'activer le suivi du message.
unstar()GmailMessageDésactive le suivi du message.

Documentation détaillée

createDraftReply(body)

Crée un brouillon de message en réponse à l'expéditeur à l'aide de l'adresse de réponse. La taille de l'e-mail (en-têtes compris) est limitée à un quota.

// Create a draft reply to the original message with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("Got your message");

Paramètres

NomTypeDescription
bodyStringCorps de l'e-mail.

Renvois

GmailDraft : brouillon du message 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


createDraftReply(body, options)

Crée un brouillon de message répondant à l'expéditeur à l'aide de l'adresse de réponse, avec des arguments facultatifs.

L'e-mail peut contenir du texte brut et un corps HTML. La taille de l'e-mail (y compris les en-têtes) est limitée à un quota.

// Create a draft response with an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

Paramètres

NomTypeDescription
bodyStringCorps de l'e-mail.
optionsObjectObjet JavaScript qui spécifie les paramètres avancés répertoriés ci-dessous.

Paramètres avancés

NomTypeDescription
attachmentsBlobSource[]Tableau de fichiers à envoyer avec l'adresse e-mail
bccStringd'une liste d'adresses e-mail séparées par une virgule en Cci
ccStringd'une liste d'adresses e-mail séparées par une virgule en copie
fromStringAdresse à partir de laquelle l'e-mail doit être envoyé, qui doit correspondre à l'une des valeurs renvoyées par GmailApp.getAliases()
htmlBodyStringLorsqu'elle est définie, les appareils capables d'afficher le code HTML l'utilisent à la place de l'argument obligatoire du corps. Vous pouvez ajouter un champ inlineImages facultatif dans le corps HTML si vous avez intégré des images à votre e-mail
inlineImagesObjectObjet 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" />
nameStringNom de l'expéditeur de l'e-mail (par défaut: le nom de l'utilisateur)
replyToStringUne adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut: l'adresse e-mail de l'utilisateur)
subjectStringUne nouvelle ligne d'objet pour l'e-mail, jusqu'à 250 caractères.

Renvois

GmailDraft : brouillon du message 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


createDraftReplyAll(body)

Crée un brouillon qui répond à l'expéditeur en utilisant l'adresse de réponse et tous les destinataires de ce message. La taille de l'e-mail (y compris les en-têtes) est limitée à un quota.

// Create a draft response to all recipients (except those bcc'd) with an acknowledgment.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("Got your message");

Paramètres

NomTypeDescription
bodyStringCorps de l'e-mail.

Renvois

GmailDraft : brouillon du message 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


createDraftReplyAll(body, options)

Crée un brouillon de réponse à l'expéditeur en utilisant l'adresse de réponse et tous les destinataires, avec des arguments facultatifs.

L'e-mail peut contenir du texte brut et un corps HTML. La taille de l'e-mail (y compris les en-têtes) est limitée à un quota.

// Create a draft response to all recipients (except those bcc'd) using an HTML text body.
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.createDraftReplyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  cc: "another@example.com"
});

Paramètres

NomTypeDescription
bodyStringCorps de l'e-mail.
optionsObjectObjet JavaScript qui spécifie les paramètres avancés répertoriés ci-dessous.

Paramètres avancés

NomTypeDescription
attachmentsBlobSource[]Tableau de fichiers à envoyer avec l'adresse e-mail
bccStringd'une liste d'adresses e-mail séparées par une virgule en Cci
ccStringd'une liste d'adresses e-mail séparées par une virgule en copie
fromStringAdresse à partir de laquelle l'e-mail doit être envoyé, qui doit correspondre à l'une des valeurs renvoyées par GmailApp.getAliases()
htmlBodyStringLorsqu'elle est définie, les appareils capables d'afficher le code HTML l'utilisent à la place de l'argument obligatoire du corps. Vous pouvez ajouter un champ inlineImages facultatif dans le corps HTML si vous avez intégré des images à votre e-mail
inlineImagesObjectObjet 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" />
nameStringNom de l'expéditeur de l'e-mail (par défaut: le nom de l'utilisateur)
replyToStringUne adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut: l'adresse e-mail de l'utilisateur)
subjectStringUne nouvelle ligne d'objet pour l'e-mail, jusqu'à 250 caractères.

Renvois

GmailDraft : brouillon du message 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


forward(recipient)

Transfère ce message aux nouveaux destinataires. La taille de l'e-mail (y compris les en-têtes) est limitée à un quota.

// Forward first message of first inbox thread to recipient1 & recipient2, both @example.com
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com");

Paramètres

NomTypeDescription
recipientStringListe d'adresses e-mail séparées par une virgule.

Renvois

GmailMessage : message 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


forward(recipient, options)

Ce message est transféré à de nouveaux destinataires, avec des arguments facultatifs.

L'e-mail peut contenir à la fois du texte brut et un corps HTML. La taille de l'e-mail (y compris les en-têtes) est limitée à un quota.

var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.forward("recipient1@example.com,recipient2@example.com", {
  cc: "myboss@example.com",
  bcc: "mybosses-boss@example.com,vp@example.com"
});

Paramètres

NomTypeDescription
recipientStringListe d'adresses e-mail séparées par une virgule.
optionsObjectObjet JavaScript qui spécifie les paramètres avancés répertoriés ci-dessous.

Paramètres avancés

NomTypeDescription
attachmentsBlobSource[]Tableau de fichiers à envoyer avec l'adresse e-mail
bccStringd'une liste d'adresses e-mail séparées par une virgule en Cci
ccStringd'une liste d'adresses e-mail séparées par une virgule en copie
fromStringAdresse à partir de laquelle l'e-mail doit être envoyé, qui doit correspondre à l'une des valeurs renvoyées par GmailApp.getAliases()
htmlBodyStringLorsqu'elle est définie, les appareils capables d'afficher le code HTML l'utilisent à la place de l'argument obligatoire du corps. Vous pouvez ajouter un champ inlineImages facultatif dans le corps HTML si vous avez intégré des images à votre e-mail
inlineImagesObjectObjet 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" />
nameStringNom de l'expéditeur de l'e-mail (par défaut: le nom de l'utilisateur)
noReplyBooleantrue 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)
replyToStringUne adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut: l'adresse e-mail de l'utilisateur)
subjectStringUne nouvelle ligne d'objet pour l'e-mail, jusqu'à 250 caractères.

Renvois

GmailMessage : message 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


getAttachments()

Récupère toutes les pièces jointes de ce message.

Renvois

GmailAttachment[] : tableau de pièces jointes Blob pour ce message.

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/

getAttachments(options)

Récupère toutes les pièces jointes de ce message.

Paramètres

NomTypeDescription
optionsObjectObjet JavaScript qui spécifie les paramètres avancés répertoriés ci-dessous.

Paramètres avancés

NomTypeDescription
includeInlineImagesBooleantrue si le tableau de pièces jointes Blob renvoyé doit inclure des images intégrées (la valeur par défaut est true).
includeAttachmentsBooleantrue si le tableau de pièces jointes Blob renvoyé doit inclure des pièces jointes standards (non intégrées) (la valeur par défaut est true).

Renvois

GmailAttachment[] : tableau de pièces jointes Blob pour ce message.

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/

getBcc()

Récupère les destinataires séparés par une virgule en Cci pour ce message.

Ce champ est par définition vide pour tous les messages reçus.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBcc()); // Log bcc'd addresses

Renvois

String : destinataires séparés par une virgule en Cci de ce message.

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


getBody()

Récupère le contenu HTML du corps de ce message.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getBody()); // Log contents of the body

Renvois

String : contenu du corps de ce message.

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


getCc()

Récupère les destinataires séparés par une virgule en copie de ce message.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getCc()); // Log cc'd addresses

Renvois

String : destinataires en copie de ce message, séparés par une virgule.

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


getDate()

Récupère la date et l'heure de ce message.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getDate()); // Log date and time of the message

Renvois

Date : date et heure de ce message.

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/

getFrom()

Récupère l'expéditeur de ce message.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getFrom()); // Log from address of the message

Renvois

String : adresse e-mail de l'expéditeur du message.

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


getHeader(name)

Récupère la valeur d'un en-tête RFC 2822 en fonction du nom de l'en-tête.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox.
var message = thread.getMessages()[0];         // Get the first message.
Logger.log(message.getHeader("Message-ID"));   // Logs the Message-ID RFC 2822 header.

Paramètres

NomTypeDescription
nameStringNom de l'en-tête RFC, sans le signe deux-points qui le sépare de la valeur.

Renvois

String : valeur de l'en-tête ou chaîne vide si l'en-tête n'existe pas dans le message.

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/

getId()

Récupère l'ID de ce message.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
var id = message.getId();
var messageById = GmailApp.getMessageById(id);
Logger.log(message.getSubject() == messageById.getMessage()); // Always logs true

Renvois

String : ID du message.


getPlainBody()

Récupère le contenu du corps de ce message sans la mise en forme HTML. Cette opération est plus complexe que getBody() et prend plus de temps.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getPlainBody()); // Log contents of the body

Renvois

String : contenu brut de ce message.

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


getRawContent()

Récupère le contenu brut de ce message. Cela équivaut à "Afficher l'original" dans l'interface utilisateur de Gmail.

Renvois

String : contenu brut de ce message.

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/

getReplyTo()

Récupère l'adresse de réponse de ce message (généralement l'expéditeur).

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getReplyTo()); // Logs reply-to address

Renvois

String : adresse e-mail à utiliser pour les réponses.

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


getSubject()

Récupère l'objet de ce message.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getSubject()); // Log subject line

Renvois

String : objet de ce message.

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


getThread()

Récupère le fil de discussion contenant ce message.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getThread().getFirstMessageSubject() ==
           thread.getFirstMessageSubject()); // Always logs true

Renvois

GmailThread : le GmailThread qui contient ce message.

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/

getTo()

Récupère les destinataires de ce message, séparés par une virgule.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log(message.getTo()); // Log the recipient of message

Renvois

String : destinataires de ce message, séparés par une virgule.

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


isDraft()

Détermine s'il s'agit d'un brouillon.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is draft? " + message.isDraft());

Renvois

Boolean : indique si le message est un brouillon.

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/

isInChats()

Détermine s'il s'agit d'un message de chat.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is a chat? " + message.isInChats());

Renvois

Boolean : indique s'il s'agit d'un message de chat.


isInInbox()

Détermine si ce message se trouve dans la boîte de réception.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in inbox? " + message.isInInbox());

Renvois

Boolean : indique si le message se trouve 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/

isInPriorityInbox()

Renvoie true si ce message se trouve dans la boîte de réception prioritaire. Sinon, renvoie false.

var thread = GmailApp.getPriorityInboxThreads(0,1)[0]; // Get first thread in priority inbox
var messages = thread.getMessages();
for (var i = 0; i < messages.length; i++) {
  // At least one of the messages is in priority inbox
  Logger.log("is in priority inbox? " + messages[i].isInPriorityInbox());
}

Renvois

Boolean : indique si le message se trouve 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/

isInTrash()

Détermine si ce message se trouve dans la corbeille.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is in the trash? " + message.isInTrash());

Renvois

Boolean : indique si le message se trouve dans la corbeille.


isStarred()

Détermine si ce message est suivi.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is starred? " + message.isStarred());

Renvois

Boolean : indique si ce message est suivi ou non.


isUnread()

Détermine si ce message est non lu.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
Logger.log("is unread? " + message.isUnread());

Renvois

Boolean : état non lu de ce message.

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/

markRead()

Marque le message comme lu.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markRead(); // Mark as read

Renvois

GmailMessage : message GmailMessage, 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


markUnread()

Marque le message comme non lu.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.markUnread(); // Mark as unread

Renvois

GmailMessage : message GmailMessage, 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


moveToTrash()

Permet de placer le message dans la corbeille.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.moveToTrash(); // Move message to trash

Renvois

GmailMessage : message GmailMessage, 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


refresh()

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

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
// .. Do bunch of stuff here
message.refresh(); // Make sure it's up to date
// Do more stuff to message

Renvois

GmailMessage : message lié au 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/

reply(body)

Permet de répondre à l'expéditeur du message en utilisant l'adresse de réponse. La taille de l'e-mail (y compris les en-têtes) est limitée à un quota.

// Respond to author of message with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("Got your message");

Paramètres

NomTypeDescription
bodyStringCorps de l'e-mail.

Renvois

GmailMessage : message 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


reply(body, options)

Permet de répondre à l'expéditeur de ce message en utilisant l'adresse de réponse, avec des arguments facultatifs.

L'e-mail peut contenir à la fois du texte brut et un corps HTML. La taille de l'e-mail (y compris les en-têtes) est limitée à un quota.

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.reply("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

Paramètres

NomTypeDescription
bodyStringCorps de l'e-mail.
optionsObjectObjet JavaScript qui spécifie les paramètres avancés répertoriés ci-dessous.

Paramètres avancés

NomTypeDescription
attachmentsBlobSource[]Tableau de fichiers à envoyer avec l'adresse e-mail
bccStringd'une liste d'adresses e-mail séparées par une virgule en Cci
ccStringd'une liste d'adresses e-mail séparées par une virgule en copie
fromStringAdresse à partir de laquelle l'e-mail doit être envoyé, qui doit correspondre à l'une des valeurs renvoyées par GmailApp.getAliases()
htmlBodyStringLorsqu'elle est définie, les appareils capables d'afficher le code HTML l'utilisent à la place de l'argument obligatoire du corps. Vous pouvez ajouter un champ inlineImages facultatif dans le corps HTML si vous avez intégré des images à votre e-mail
inlineImagesObjectObjet 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" />
nameStringNom de l'expéditeur de l'e-mail (par défaut: le nom de l'utilisateur)
noReplyBooleantrue 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)
replyToStringUne adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut: l'adresse e-mail de l'utilisateur)
subjectStringUne nouvelle ligne d'objet pour l'e-mail, jusqu'à 250 caractères.

Renvois

GmailMessage : message 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


replyAll(body)

Répondre à l'expéditeur avec l'adresse de réponse et tous les destinataires du message La taille de l'e-mail (y compris les en-têtes) est limitée à un quota.

// Respond to all recipients (except bcc'd) of last email in thread with acknowledgment
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
message.replyAll("Got your message");

Paramètres

NomTypeDescription
bodyStringCorps de l'e-mail.

Renvois

GmailMessage : message 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


replyAll(body, options)

Répondez à l'expéditeur de ce message en utilisant l'adresse de réponse et tous les destinataires, avec les arguments facultatifs.

L'e-mail peut contenir à la fois du texte brut et un corps HTML. La taille de l'e-mail (y compris les en-têtes) est limitée à un quota.

// Respond with HTML body text
var firstThread = GmailApp.getInboxThreads(0,1)[0];
var message = firstThread.getMessages()[0];
messageThread.replyAll("incapable of HTML", {
  htmlBody: "<b>some HTML body text</b>",
  noReply: true
});

Paramètres

NomTypeDescription
bodyStringCorps de l'e-mail.
optionsObjectObjet JavaScript qui spécifie les paramètres avancés répertoriés ci-dessous.

Paramètres avancés

NomTypeDescription
attachmentsBlobSource[]Tableau de fichiers à envoyer avec l'adresse e-mail
bccStringd'une liste d'adresses e-mail séparées par une virgule en Cci
ccStringd'une liste d'adresses e-mail séparées par une virgule en copie
fromStringAdresse à partir de laquelle l'e-mail doit être envoyé, qui doit correspondre à l'une des valeurs renvoyées par GmailApp.getAliases()
htmlBodyStringLorsqu'elle est définie, les appareils capables d'afficher le code HTML l'utilisent à la place de l'argument obligatoire du corps. Vous pouvez ajouter un champ inlineImages facultatif dans le corps HTML si vous avez intégré des images à votre e-mail
inlineImagesObjectObjet 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" />
nameStringNom de l'expéditeur de l'e-mail (par défaut: le nom de l'utilisateur)
noReplyBooleantrue 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)
replyToStringUne adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut: l'adresse e-mail de l'utilisateur)
subjectStringUne nouvelle ligne d'objet pour l'e-mail, jusqu'à 250 caractères.

Renvois

GmailMessage : message 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


star()

Permet d'activer le suivi du message.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.star(); // Star the message

Renvois

GmailMessage : message GmailMessage, 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


unstar()

Désactive le suivi du message.

var thread = GmailApp.getInboxThreads(0,1)[0]; // Get first thread in inbox
var message = thread.getMessages()[0]; // Get first message
message.unstar(); // Unstar the message

Renvois

GmailMessage : message GmailMessage, 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