Class GmailMessage

Message dans le compte Gmail d'un utilisateur.

Méthodes

Méthode	Type renvoyé	Brève description
`createDraftReply(body)`	`GmailDraft`	Crée un brouillon de message en réponse à l'expéditeur de ce message à l'aide de l'adresse de réponse.
`createDraftReply(body, options)`	`GmailDraft`	Crée un brouillon de message en réponse à l'expéditeur de ce message à l'aide de l'adresse de réponse, avec des arguments facultatifs.
`createDraftReplyAll(body)`	`GmailDraft`	Crée un brouillon de message en répondant à l'expéditeur à l'aide de l'adresse de réponse et de tous les destinataires de ce message.
`createDraftReplyAll(body, options)`	`GmailDraft`	Crée un brouillon de message en répondant à l'expéditeur de ce message à l'aide de l'adresse de réponse et de tous les destinataires, avec des arguments facultatifs.
`forward(recipient)`	`GmailMessage`	Transfère ce message à de nouveaux destinataires.
`forward(recipient, options)`	`GmailMessage`	Transfère ce message à 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()`	`String`	Récupère les destinataires en copie cachée de ce message, séparés par une virgule.
`getBody()`	`String`	Récupère le contenu HTML du corps de ce message.
`getCc()`	`String`	Récupère les destinataires en copie de ce message, séparés par une virgule.
`getDate()`	`Date`	Récupère la date et l'heure de ce message.
`getFrom()`	`String`	Récupère l'expéditeur de ce message.
`getHeader(name)`	`String`	Récupère la valeur d'un en-tête RFC 2822 à partir du nom de l'en-tête.
`getId()`	`String`	Récupère l'ID de ce message.
`getPlainBody()`	`String`	Récupère le contenu du corps de ce message sans mise en forme HTML.
`getRawContent()`	`String`	Récupère le contenu brut de ce message.
`getReplyTo()`	`String`	Récupère l'adresse de réponse de ce message (généralement l'expéditeur).
`getSubject()`	`String`	Récupère l'objet de ce message.
`getThread()`	`GmailThread`	Récupère le fil de discussion contenant ce message.
`getTo()`	`String`	Récupère les destinataires de ce message, séparés par une virgule.
`isDraft()`	`Boolean`	Indique si ce message est un brouillon.
`isInChats()`	`Boolean`	Indique si ce message est un chat.
`isInInbox()`	`Boolean`	Indique si ce message se trouve dans la boîte de réception.
`isInPriorityInbox()`	`Boolean`	Renvoie `true` si ce message se trouve dans la boîte de réception prioritaire, ou `false` dans le cas contraire.
`isInTrash()`	`Boolean`	Indique si ce message se trouve dans la corbeille.
`isStarred()`	`Boolean`	Indique si ce message est suivi.
`isUnread()`	`Boolean`	Indique si ce message n'a pas été lu.
`markRead()`	`GmailMessage`	Marque le message comme lu.
`markUnread()`	`GmailMessage`	Marque le message comme non lu.
`moveToTrash()`	`GmailMessage`	Place le message dans la corbeille.
`refresh()`	`GmailMessage`	Recharge ce message et l'état associé depuis Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
`reply(body)`	`GmailMessage`	Répond à l'expéditeur de ce message en utilisant l'adresse de réponse.
`reply(body, options)`	`GmailMessage`	Répond à l'expéditeur de ce message en utilisant l'adresse de réponse, avec des arguments facultatifs.
`replyAll(body)`	`GmailMessage`	Répondre à l'expéditeur en utilisant l'adresse de réponse et à tous les destinataires de ce message.
`replyAll(body, options)`	`GmailMessage`	Répond à l'expéditeur de ce message en utilisant l'adresse de réponse et tous les destinataires, avec des arguments facultatifs.
`star()`	`GmailMessage`	Ajoute le message aux favoris.
`unstar()`	`GmailMessage`	Désactive le suivi du message.

Documentation détaillée

`createDraftReply(body)`

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

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

Paramètres

Nom	Type	Description
`body`	`String`	Corps de l'e-mail.

Renvois

GmailDraft : le brouillon de message qui vient d'être créé.

Autorisation

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

https://mail.google.com/

`createDraftReply(body, options)`

Crée un brouillon de message en réponse à l'expéditeur de ce message à l'aide de 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 par un quota.

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

Paramètres

Nom	Type	Description
`body`	`String`	Corps de l'e-mail.
`options`	`Object`	Objet JavaScript qui spécifie les paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

Nom	Type	Description
`attachments`	`BlobSource[]`	Tableau de fichiers à envoyer avec l'e-mail
`bcc`	`String`	Liste d'adresses e-mail à mettre en Cci, séparées par une virgule
`cc`	`String`	Liste d'adresses e-mail à mettre en copie, séparées par une virgule.
`from`	`String`	Adresse d'envoi de l'e-mail, qui doit être l'une des valeurs renvoyées par `GmailApp.getAliases()`
`htmlBody`	`String`	Lorsqu'il est défini, les appareils capables d'afficher du code HTML l'utilisent à la place de l'argument de corps requis. Vous pouvez ajouter un champ `inlineImages` facultatif dans le corps HTML si vous avez des images intégrées dans votre e-mail.
`inlineImages`	`Object`	Objet JavaScript contenant un mappage de la clé d'image (`String`) aux données d'image (`BlobSource`). Cela suppose que le paramètre `htmlBody` est utilisé et contient des références à ces images au format `<img src="cid:imageKey" />`.
`name`	`String`	Nom de l'expéditeur de l'e-mail (par défaut, le nom de l'utilisateur)
`replyTo`	`String`	Adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut : adresse e-mail de l'utilisateur)
`subject`	`String`	Nouvel objet de l'e-mail, jusqu'à 250 caractères.

Renvois

GmailDraft : le brouillon de message qui vient d'être créé.

Autorisation

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

https://mail.google.com/

Voir aussi

reply(body, options)
createDraftReply(body)
createDraftReplyAll(body)
createDraftReplyAll(body, options)

`createDraftReplyAll(body)`

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

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

Paramètres

Nom	Type	Description
`body`	`String`	Corps de l'e-mail.

Renvois

GmailDraft : le brouillon de message qui vient d'être créé.

Autorisation

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

https://mail.google.com/

Voir aussi

replyAll(body)
createDraftReply(body)
createDraftReply(body, options)
createDraftReplyAll(body, options)

`createDraftReplyAll(body, options)`

Crée un brouillon de message en répondant à l'expéditeur de ce message à l'aide de l'adresse de réponse et de tous les 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 par un quota.

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

Paramètres

Nom	Type	Description
`body`	`String`	Corps de l'e-mail.
`options`	`Object`	Objet JavaScript qui spécifie les paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

Nom	Type	Description
`attachments`	`BlobSource[]`	Tableau de fichiers à envoyer avec l'e-mail
`bcc`	`String`	Liste d'adresses e-mail à mettre en Cci, séparées par une virgule
`cc`	`String`	Liste d'adresses e-mail à mettre en copie, séparées par une virgule.
`from`	`String`	Adresse d'envoi de l'e-mail, qui doit être l'une des valeurs renvoyées par `GmailApp.getAliases()`
`htmlBody`	`String`	Lorsqu'il est défini, les appareils capables d'afficher du code HTML l'utilisent à la place de l'argument de corps requis. Vous pouvez ajouter un champ `inlineImages` facultatif dans le corps HTML si vous avez des images intégrées dans votre e-mail.
`inlineImages`	`Object`	Objet JavaScript contenant un mappage de la clé d'image (`String`) aux données d'image (`BlobSource`). Cela suppose que le paramètre `htmlBody` est utilisé et contient des références à ces images au format `<img src="cid:imageKey" />`.
`name`	`String`	Nom de l'expéditeur de l'e-mail (par défaut, le nom de l'utilisateur)
`replyTo`	`String`	Adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut : adresse e-mail de l'utilisateur)
`subject`	`String`	Nouvel objet de l'e-mail, jusqu'à 250 caractères.

Renvois

GmailDraft : le brouillon de message qui vient d'être créé.

Autorisation

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

https://mail.google.com/

Voir aussi

replyAll(body, options)
createDraftReply(body)
createDraftReply(body, options)
createDraftReplyAll(body)

`forward(recipient)`

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

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

Paramètres

Nom	Type	Description
`recipient`	`String`	Liste d'adresses e-mail séparées par une virgule.

Renvois

GmailMessage : ce message est utile pour le chaînage.

Autorisation

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

https://mail.google.com/

Voir aussi

forward(recipient, options)

`forward(recipient, options)`

Transfère ce message à 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 (en-têtes inclus) est limitée par un quota.

const firstThread = GmailApp.getInboxThreads(0, 1)[0];
const 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

Nom	Type	Description
`recipient`	`String`	Liste d'adresses e-mail séparées par une virgule.
`options`	`Object`	Objet JavaScript qui spécifie les paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

Nom	Type	Description
`attachments`	`BlobSource[]`	Tableau de fichiers à envoyer avec l'e-mail
`bcc`	`String`	Liste d'adresses e-mail à mettre en Cci, séparées par une virgule
`cc`	`String`	Liste d'adresses e-mail à mettre en copie, séparées par une virgule.
`from`	`String`	Adresse d'envoi de l'e-mail, qui doit être l'une des valeurs renvoyées par `GmailApp.getAliases()`
`htmlBody`	`String`	Lorsqu'il est défini, les appareils capables d'afficher du code HTML l'utilisent à la place de l'argument de corps requis. Vous pouvez ajouter un champ `inlineImages` facultatif dans le corps HTML si vous avez des images intégrées dans votre e-mail.
`inlineImages`	`Object`	Objet JavaScript contenant un mappage de la clé d'image (`String`) aux données d'image (`BlobSource`). Cela suppose que le paramètre `htmlBody` est utilisé et contient des références à ces images au format `<img src="cid:imageKey" />`.
`name`	`String`	Nom de l'expéditeur de l'e-mail (par défaut, le nom de l'utilisateur)
`noReply`	`Boolean`	`true` si l'e-mail doit être envoyé depuis une adresse e-mail générique no-reply pour dissuader les destinataires de répondre aux e-mails. Cette option n'est disponible que pour les comptes Google Workspace, et non pour les utilisateurs Gmail.
`replyTo`	`String`	Adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut : adresse e-mail de l'utilisateur)
`subject`	`String`	Nouvel objet de l'e-mail, jusqu'à 250 caractères.

Renvois

GmailMessage : ce message est utile pour le chaînage.

Autorisation

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

https://mail.google.com/

Voir aussi

forward(recipient)

`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 avec un ou plusieurs des scopes suivants ou les scopes 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

Nom	Type	Description
`options`	`Object`	Objet JavaScript qui spécifie les paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

Nom	Type	Description
`includeInlineImages`	`Boolean`	`true` si le tableau renvoyé de pièces jointes Blob doit inclure des images intégrées (la valeur par défaut est `true`).
`includeAttachments`	`Boolean`	`true` si le tableau renvoyé des pièces jointes Blob doit inclure les 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 avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

https://mail.google.com/

`getBcc()`

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

Par définition, cette valeur est vide pour tous les messages reçus.

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

Renvois

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

Autorisation

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

https://mail.google.com/

Voir aussi

getTo()

`getBody()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

https://mail.google.com/

Voir aussi

getSubject()

`getCc()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

https://mail.google.com/

Voir aussi

getTo()

`getDate()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

https://mail.google.com/

`getFrom()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

https://mail.google.com/

Voir aussi

getReplyTo()

`getHeader(name)`

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

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

Paramètres

Nom	Type	Description
`name`	`String`	Nom de l'en-tête RFC, sans les deux-points qui le séparent 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 avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

https://mail.google.com/

`getId()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
const id = message.getId();
const 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 mise en forme HTML. Cette méthode est plus complexe que getBody() et prend plus de temps.

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

Renvois

String : contenu brut du corps de ce message.

Autorisation

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

https://mail.google.com/

Voir aussi

getSubject()

`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 avec un ou plusieurs des scopes suivants ou les scopes 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).

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

Renvois

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

Autorisation

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

https://mail.google.com/

Voir aussi

getCc()

`getSubject()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

https://mail.google.com/

Voir aussi

getAttachments()

`getThread()`

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

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

Renvois

GmailThread : GmailThread contenant ce message.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes 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.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

https://mail.google.com/

Voir aussi

getCc()

`isDraft()`

Indique si ce message est un brouillon.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is draft? ${message.isDraft()}`);

Renvois

Boolean : indique si ce message est un brouillon.

Autorisation

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

https://mail.google.com/

`isInChats()`

Indique si ce message est un chat.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is a chat? ${message.isInChats()}`);

Renvois

Boolean : indique si ce message est un chat.

`isInInbox()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 avec un ou plusieurs des scopes suivants ou les scopes 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, ou false dans le cas contraire.

const thread = GmailApp.getPriorityInboxThreads(
    0, 1)[0];  // Get first thread in priority inbox
const messages = thread.getMessages();
for (let 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 avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

https://mail.google.com/

`isInTrash()`

Indique si ce message se trouve dans la corbeille.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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()`

Indique si ce message est suivi.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const message = thread.getMessages()[0];           // Get first message
Logger.log(`is starred? ${message.isStarred()}`);

Renvois

Boolean : indique si le message est suivi.

`isUnread()`

Indique si ce message n'a pas été lu.

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 avec un ou plusieurs des scopes suivants ou les scopes appropriés de l'API REST associée :

https://mail.google.com/

`markRead()`

Marque le message comme lu.

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

Renvois

GmailMessage : ce GmailMessage est utile pour l'enchaînement.

Autorisation

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

https://mail.google.com/

Voir aussi

isUnread()

`markUnread()`

Marque le message comme non lu.

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

Renvois

GmailMessage : ce GmailMessage est utile pour l'enchaînement.

Autorisation

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

https://mail.google.com/

Voir aussi

isUnread()

`moveToTrash()`

Place le message dans la corbeille.

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

Renvois

GmailMessage : ce GmailMessage est utile pour l'enchaînement.

Autorisation

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

https://mail.google.com/

Voir aussi

isInTrash()

`refresh()`

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

const thread = GmailApp.getInboxThreads(0, 1)[0];  // Get first thread in inbox
const 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 : ce message pour le chaînage.

Autorisation

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

https://mail.google.com/

`reply(body)`

Répond à l'expéditeur de ce message en utilisant l'adresse de réponse. La taille de l'e-mail (en-têtes inclus) est limitée par un quota.

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

Paramètres

Nom	Type	Description
`body`	`String`	Corps de l'e-mail.

Renvois

GmailMessage : ce message est utile pour le chaînage.

Autorisation

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

https://mail.google.com/

Voir aussi

reply(body, options)
replyAll(body)
replyAll(body, options)

`reply(body, options)`

Répond à 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 (en-têtes inclus) est limitée par un quota.

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

Paramètres

Nom	Type	Description
`body`	`String`	Corps de l'e-mail.
`options`	`Object`	Objet JavaScript qui spécifie les paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

Nom	Type	Description
`attachments`	`BlobSource[]`	Tableau de fichiers à envoyer avec l'e-mail
`bcc`	`String`	Liste d'adresses e-mail à mettre en Cci, séparées par une virgule
`cc`	`String`	Liste d'adresses e-mail à mettre en copie, séparées par une virgule.
`from`	`String`	Adresse d'envoi de l'e-mail, qui doit être l'une des valeurs renvoyées par `GmailApp.getAliases()`
`htmlBody`	`String`	Lorsqu'il est défini, les appareils capables d'afficher du code HTML l'utilisent à la place de l'argument de corps requis. Vous pouvez ajouter un champ `inlineImages` facultatif dans le corps HTML si vous avez des images intégrées dans votre e-mail.
`inlineImages`	`Object`	Objet JavaScript contenant un mappage de la clé d'image (`String`) aux données d'image (`BlobSource`). Cela suppose que le paramètre `htmlBody` est utilisé et contient des références à ces images au format `<img src="cid:imageKey" />`.
`name`	`String`	Nom de l'expéditeur de l'e-mail (par défaut, le nom de l'utilisateur)
`noReply`	`Boolean`	`true` si l'e-mail doit être envoyé depuis une adresse e-mail générique no-reply pour dissuader les destinataires de répondre aux e-mails. Cette option n'est disponible que pour les comptes Google Workspace, et non pour les utilisateurs Gmail.
`replyTo`	`String`	Adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut : adresse e-mail de l'utilisateur)
`subject`	`String`	Nouvel objet de l'e-mail, jusqu'à 250 caractères.

Renvois

GmailMessage : ce message est utile pour le chaînage.

Autorisation

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

https://mail.google.com/

Voir aussi

reply(body)
replyAll(body)
replyAll(body, options)

`replyAll(body)`

Répondre à 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 par un quota.

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

Paramètres

Nom	Type	Description
`body`	`String`	Corps de l'e-mail.

Renvois

GmailMessage : ce message est utile pour le chaînage.

Autorisation

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

https://mail.google.com/

Voir aussi

reply(body)
reply(body, options)
replyAll(body, options)

`replyAll(body, options)`

Répond à l'expéditeur de ce message en utilisant l'adresse de réponse et tous les 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 (en-têtes inclus) est limitée par un quota.

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

Paramètres

Nom	Type	Description
`body`	`String`	Corps de l'e-mail.
`options`	`Object`	Objet JavaScript qui spécifie les paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

Nom	Type	Description
`attachments`	`BlobSource[]`	Tableau de fichiers à envoyer avec l'e-mail
`bcc`	`String`	Liste d'adresses e-mail à mettre en Cci, séparées par une virgule
`cc`	`String`	Liste d'adresses e-mail à mettre en copie, séparées par une virgule.
`from`	`String`	Adresse d'envoi de l'e-mail, qui doit être l'une des valeurs renvoyées par `GmailApp.getAliases()`
`htmlBody`	`String`	Lorsqu'il est défini, les appareils capables d'afficher du code HTML l'utilisent à la place de l'argument de corps requis. Vous pouvez ajouter un champ `inlineImages` facultatif dans le corps HTML si vous avez des images intégrées dans votre e-mail.
`inlineImages`	`Object`	Objet JavaScript contenant un mappage de la clé d'image (`String`) aux données d'image (`BlobSource`). Cela suppose que le paramètre `htmlBody` est utilisé et contient des références à ces images au format `<img src="cid:imageKey" />`.
`name`	`String`	Nom de l'expéditeur de l'e-mail (par défaut, le nom de l'utilisateur)
`noReply`	`Boolean`	`true` si l'e-mail doit être envoyé depuis une adresse e-mail générique no-reply pour dissuader les destinataires de répondre aux e-mails. Cette option n'est disponible que pour les comptes Google Workspace, et non pour les utilisateurs Gmail.
`replyTo`	`String`	Adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut : adresse e-mail de l'utilisateur)
`subject`	`String`	Nouvel objet de l'e-mail, jusqu'à 250 caractères.

Renvois

GmailMessage : ce message est utile pour le chaînage.

Autorisation

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

https://mail.google.com/

Voir aussi

reply(body)
reply(body, options)
replyAll(body)

`star()`

Ajoute le message aux favoris.

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

Renvois

GmailMessage : ce GmailMessage est utile pour l'enchaînement.

Autorisation

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

https://mail.google.com/

Voir aussi

unstar()

`unstar()`

Désactive le suivi du message.

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

Renvois

GmailMessage : ce GmailMessage est utile pour l'enchaînement.

Autorisation

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

https://mail.google.com/

Voir aussi

star()

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

Méthodes

Documentation détaillée

createDraftReply(body)

Paramètres

Renvois

Autorisation

Voir aussi

createDraftReply(body, options)

Paramètres

Paramètres avancés

Renvois

Autorisation

Voir aussi

createDraftReplyAll(body)

Paramètres

Renvois

Autorisation

Voir aussi

createDraftReplyAll(body, options)

Paramètres

Paramètres avancés

Renvois

Autorisation

Voir aussi

forward(recipient)

Paramètres

Renvois

Autorisation

Voir aussi

forward(recipient, options)

Paramètres

Paramètres avancés

Renvois

Autorisation

Voir aussi

getAttachments()

Renvois

Autorisation

getAttachments(options)

Paramètres

Paramètres avancés

Renvois

Autorisation

getBcc()

Renvois

Autorisation

Voir aussi

getBody()

Renvois

Autorisation

Voir aussi

getCc()

Renvois

Autorisation

Voir aussi

getDate()

Renvois

Autorisation

getFrom()

Renvois

Autorisation

Voir aussi

getHeader(name)

Paramètres

Renvois

Autorisation

getId()

Renvois

getPlainBody()

Renvois

Autorisation

Voir aussi

getRawContent()

Renvois

Autorisation

getReplyTo()

Renvois

Autorisation

Voir aussi

Class GmailMessage

`createDraftReply(body)`

`createDraftReply(body, options)`

`createDraftReplyAll(body)`

`createDraftReplyAll(body, options)`

`forward(recipient)`

`forward(recipient, options)`

`getAttachments()`

`getAttachments(options)`

`getBcc()`

`getBody()`

`getCc()`

`getDate()`

`getFrom()`

`getHeader(name)`

`getId()`

`getPlainBody()`

`getRawContent()`

`getReplyTo()`

`getSubject()`

`getThread()`

`getTo()`

`isDraft()`

`isInChats()`

`isInInbox()`

`isInPriorityInbox()`

`isInTrash()`

`isStarred()`

`isUnread()`

`markRead()`

`markUnread()`

`moveToTrash()`

`refresh()`

`reply(body)`

`reply(body, options)`

`replyAll(body)`

`replyAll(body, options)`

`star()`