Cette page a été traduite par l'API Cloud Translation.

Gmail Service

Ce service vous permet d'envoyer des e-mails, de rédiger des brouillons, de gérer des libellés, de marquer des messages et des fils de discussion, et d'effectuer diverses autres tâches de gestion de compte Gmail. Consultez également le service de messagerie, un service plus simple qui n'autorise que l'envoi d'e-mails.

Classes

Nom	Brève description
`GmailApp`	Permet d'accéder aux fils de discussion, aux messages et aux libellés Gmail.
`GmailAttachment`	Pièce jointe Gmail.
`GmailDraft`	Message brouillon créé par un utilisateur dans son compte Gmail.
`GmailLabel`	Libellé créé par l'utilisateur dans son compte Gmail.
`GmailMessage`	Message dans le compte Gmail d'un utilisateur.
`GmailThread`	Fil de discussion dans le compte Gmail d'un utilisateur.

`GmailApp`

Méthodes

Méthode	Type renvoyé	Brève description
`createDraft(recipient, subject, body)`	`GmailDraft`	Crée un brouillon d'e-mail.
`createDraft(recipient, subject, body, options)`	`GmailDraft`	Crée un brouillon d'e-mail avec des arguments facultatifs.
`createLabel(name)`	`GmailLabel`	Créez un libellé utilisateur avec le nom donné.
`deleteLabel(label)`	`GmailApp`	Supprime le libellé spécifié.
`getAliases()`	`String[]`	Récupère la liste des adresses e-mail configurées en tant qu'alias pour ce compte dans Gmail.
`getDraft(draftId)`	`GmailDraft`	Récupérez une ébauche de message par ID.
`getDraftMessages()`	`GmailMessage[]`	Récupère tous les brouillons.
`getDrafts()`	`GmailDraft[]`	Récupère tous les brouillons Gmail.
`getInboxThreads()`	`GmailThread[]`	Récupère tous les fils de discussion Inbox, quels que soient les libellés.
`getInboxThreads(start, max)`	`GmailThread[]`	Récupère une plage de fils de discussion de la boîte de réception, quelle que soit la balise.
`getInboxUnreadCount()`	`Integer`	Récupère le nombre de fils de discussion non lus dans la boîte de réception.
`getMessageById(id)`	`GmailMessage`	Récupère un message par ID.
`getMessagesForThread(thread)`	`GmailMessage[]`	Récupérez tous les messages du fil de discussion spécifié.
`getMessagesForThreads(threads)`	`GmailMessage[][]`	Récupérez tous les messages des fils de discussion spécifiés.
`getPriorityInboxThreads()`	`GmailThread[]`	Récupère tous les fils de discussion de la boîte de réception prioritaire, quel que soit le libellé.
`getPriorityInboxThreads(start, max)`	`GmailThread[]`	Récupère une plage de fils de discussion de la boîte de réception prioritaire, quel que soit le libellé.
`getPriorityInboxUnreadCount()`	`Integer`	Récupère le nombre de fils de discussion non lus dans la boîte de réception prioritaire.
`getSpamThreads()`	`GmailThread[]`	Récupère tous les fils de discussion considérés comme du spam, quels que soient les libellés.
`getSpamThreads(start, max)`	`GmailThread[]`	Récupère une plage de fils de discussion de spam, quels que soient les libellés.
`getSpamUnreadCount()`	`Integer`	Récupère le nombre de fils de discussion non lus qui sont du spam.
`getStarredThreads()`	`GmailThread[]`	Récupère tous les fils épinglés, quels que soient les libellés.
`getStarredThreads(start, max)`	`GmailThread[]`	Récupère une plage de fils épinglés, quelle que soit la balise.
`getStarredUnreadCount()`	`Integer`	Récupère le nombre de fils non lus avec une étoile.
`getThreadById(id)`	`GmailThread`	Récupère un thread par ID.
`getTrashThreads()`	`GmailThread[]`	Récupère tous les threads de corbeille, quels que soient les libellés.
`getTrashThreads(start, max)`	`GmailThread[]`	Récupère une plage de threads de corbeille, quel que soit le libellé.
`getUserLabelByName(name)`	`GmailLabel`	Récupère un libellé à partir de son nom.
`getUserLabels()`	`GmailLabel[]`	Récupère une liste de libellés créés par l'utilisateur.
`markMessageRead(message)`	`GmailApp`	Marque ce message comme lu et force son actualisation.
`markMessageUnread(message)`	`GmailApp`	Marque ce message comme non lu et force son actualisation.
`markMessagesRead(messages)`	`GmailApp`	Marque ces messages comme lus et force leur actualisation.
`markMessagesUnread(messages)`	`GmailApp`	Marquez ces messages comme non lus et forcez leur actualisation.
`markThreadImportant(thread)`	`GmailApp`	Marque ce thread comme important et force son actualisation.
`markThreadRead(thread)`	`GmailApp`	Marque ce fil de discussion comme lu et force son actualisation.
`markThreadUnimportant(thread)`	`GmailApp`	Marque ce fil de discussion comme non important et force son actualisation.
`markThreadUnread(thread)`	`GmailApp`	Marque ce fil de discussion comme non lu et force son actualisation.
`markThreadsImportant(threads)`	`GmailApp`	Marque ces threads comme importants et force leur actualisation.
`markThreadsRead(threads)`	`GmailApp`	Marque ces fils de discussion comme lus et force leur actualisation.
`markThreadsUnimportant(threads)`	`GmailApp`	Marque ces threads comme non importants et force leur actualisation.
`markThreadsUnread(threads)`	`GmailApp`	Marque ces fils de discussion comme non lus et force leur actualisation.
`moveMessageToTrash(message)`	`GmailApp`	Place le message dans la corbeille et force l'actualisation du message.
`moveMessagesToTrash(messages)`	`GmailApp`	Déplace les messages spécifiés dans la corbeille et force leur actualisation.
`moveThreadToArchive(thread)`	`GmailApp`	Déplace ce thread dans l'archive et force son actualisation.
`moveThreadToInbox(thread)`	`GmailApp`	Déplace ce fil de discussion dans la boîte de réception et force son actualisation.
`moveThreadToSpam(thread)`	`GmailApp`	Place ce thread dans le dossier de spam et force son actualisation.
`moveThreadToTrash(thread)`	`GmailApp`	Déplace ce thread dans la corbeille et force son actualisation.
`moveThreadsToArchive(threads)`	`GmailApp`	Déplace ces threads vers l'archive et force leur actualisation.
`moveThreadsToInbox(threads)`	`GmailApp`	Déplace ces fils de discussion dans la boîte de réception et les force à s'actualiser.
`moveThreadsToSpam(threads)`	`GmailApp`	Déplace ces fils de discussion dans le spam et les force à s'actualiser.
`moveThreadsToTrash(threads)`	`GmailApp`	Place ces threads dans la corbeille et force leur actualisation.
`refreshMessage(message)`	`GmailApp`	Recharge le message et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
`refreshMessages(messages)`	`GmailApp`	Recharge les messages et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
`refreshThread(thread)`	`GmailApp`	Recharge le fil de discussion et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
`refreshThreads(threads)`	`GmailApp`	Recharge les fils de discussion et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
`search(query)`	`GmailThread[]`	Recherchez dans Gmail la requête indiquée.
`search(query, start, max)`	`GmailThread[]`	Recherchez dans Gmail la requête indiquée.
`sendEmail(recipient, subject, body)`	`GmailApp`	Envoie un e-mail.
`sendEmail(recipient, subject, body, options)`	`GmailApp`	Envoie un e-mail avec des arguments facultatifs.
`setCurrentMessageAccessToken(accessToken)`	`void`	Définit le jeton d'accès au message actuel qui permet au script d'accéder aux propriétés `GmailMessage` actuelles.
`starMessage(message)`	`GmailApp`	Ajoute une étoile à ce message et force son actualisation.
`starMessages(messages)`	`GmailApp`	Ajoute une étoile à ces messages et force leur actualisation.
`unstarMessage(message)`	`GmailApp`	Supprime une étoile de ce message et force l'actualisation du message.
`unstarMessages(messages)`	`GmailApp`	Supprime les étoiles de ces messages et force leur actualisation.

`GmailAttachment`

Méthodes

Méthode	Type renvoyé	Brève description
`copyBlob()`	`Blob`	Renvoie une copie de ce blob.
`getAs(contentType)`	`Blob`	Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié.
`getBytes()`	`Byte[]`	Récupère les données stockées dans ce blob.
`getContentType()`	`String`	Récupère le type de contenu des octets de ce blob.
`getDataAsString()`	`String`	Récupère les données de ce blob sous la forme d'une chaîne encodée en UTF-8.
`getDataAsString(charset)`	`String`	Récupère les données de ce blob sous la forme d'une chaîne avec l'encodage spécifié.
`getHash()`	`String`	Récupère le hachage de contenu SHA1 de cette pièce jointe.
`getName()`	`String`	Récupère le nom de ce blob.
`getSize()`	`Integer`	Récupère la taille de cette pièce jointe.
`isGoogleType()`	`Boolean`	Indique si ce blob est un fichier Google Workspace (Sheets, Docs, etc.).
`setBytes(data)`	`Blob`	Définit les données stockées dans ce blob.
`setContentType(contentType)`	`Blob`	Définit le type de contenu des octets de ce blob.
`setContentTypeFromExtension()`	`Blob`	Définit le type de contenu des octets de ce blob en fonction de l'extension du fichier.
`setDataFromString(string)`	`Blob`	Définit les données de ce blob à partir d'une chaîne encodée en UTF-8.
`setDataFromString(string, charset)`	`Blob`	Définit les données de ce blob à partir d'une chaîne avec l'encodage spécifié.
`setName(name)`	`Blob`	Définit le nom de ce blob.

`GmailDraft`

Méthodes

Méthode	Type renvoyé	Brève description
`deleteDraft()`	`void`	Supprime ce brouillon de message.
`getId()`	`String`	Récupère l'ID de ce message brouillon.
`getMessage()`	`GmailMessage`	Renvoie un GmailMessage représentant ce brouillon.
`getMessageId()`	`String`	Renvoie l'ID de l'`GmailMessage` représentant ce brouillon.
`send()`	`GmailMessage`	Envoie ce brouillon d'e-mail.
`update(recipient, subject, body)`	`GmailDraft`	Remplace le contenu de ce brouillon de message.
`update(recipient, subject, body, options)`	`GmailDraft`	Remplace le contenu de ce message d'envoi préliminaire à l'aide d'arguments facultatifs.

`GmailLabel`

Méthodes

Méthode	Type renvoyé	Brève description
`addToThread(thread)`	`GmailLabel`	Ajoute ce libellé au thread donné et force l'actualisation du thread (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	Ajoute ce libellé aux threads donnés et force leur actualisation.
`deleteLabel()`	`void`	Supprime ce libellé.
`getName()`	`String`	Récupère le nom de ce libellé.
`getThreads()`	`GmailThread[]`	Récupère les threads marqués avec ce libellé.
`getThreads(start, max)`	`GmailThread[]`	Récupère une plage de threads marqués avec ce libellé.
`getUnreadCount()`	`Integer`	Récupère le nombre de fils de discussion non lus tagués avec ce libellé.
`removeFromThread(thread)`	`GmailLabel`	Supprime ce libellé du fil de discussion donné et force l'actualisation du fil.
`removeFromThreads(threads)`	`GmailLabel`	Supprime ce libellé des threads donnés et force leur actualisation.

`GmailMessage`

Méthodes

Méthode	Type renvoyé	Brève description
`createDraftReply(body)`	`GmailDraft`	Crée un brouillon de message répondant à l'expéditeur de ce message à l'aide de l'adresse de réponse.
`createDraftReply(body, options)`	`GmailDraft`	Crée un brouillon de message répondant à 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 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 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 (séparés par une virgule) de ce message.
`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 une discussion.
`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, sinon `false`.
`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 est 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é à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
`reply(body)`	`GmailMessage`	Répond à l'expéditeur de ce message à l'aide de l'adresse de réponse.
`reply(body, options)`	`GmailMessage`	Répond à l'expéditeur de ce message à l'aide de l'adresse de réponse, avec des arguments facultatifs.
`replyAll(body)`	`GmailMessage`	Répond à l'expéditeur à l'aide de l'adresse de réponse et à tous les destinataires de ce message.
`replyAll(body, options)`	`GmailMessage`	Répond à l'expéditeur de ce message à l'aide de l'adresse de réponse et de tous les destinataires, avec des arguments facultatifs.
`star()`	`GmailMessage`	Ajoute une étoile au message.
`unstar()`	`GmailMessage`	Désactive le suivi du message.

`GmailThread`

Méthodes

Méthode	Type renvoyé	Brève description
`addLabel(label)`	`GmailThread`	Ajoute ce libellé au fil de discussion.
`createDraftReply(body)`	`GmailDraft`	Crée un brouillon de message répondant à l'expéditeur du dernier message de ce fil de discussion à l'aide de l'adresse de réponse.
`createDraftReply(body, options)`	`GmailDraft`	Crée un brouillon de message répondant à l'expéditeur du dernier message de ce fil de discussion à l'aide de l'adresse de réponse, avec des arguments facultatifs.
`createDraftReplyAll(body)`	`GmailDraft`	Crée un brouillon de message répondant à l'expéditeur du dernier message de ce fil de discussion, à 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 répondant à l'expéditeur du dernier message de ce fil de discussion, à l'aide de l'adresse de réponse et de tous les destinataires, avec des arguments facultatifs.
`getFirstMessageSubject()`	`String`	Récupère l'objet du premier message du fil de discussion.
`getId()`	`String`	Récupère l'ID de ce thread.
`getLabels()`	`GmailLabel[]`	Renvoie les libellés créés par l'utilisateur sur ce thread.
`getLastMessageDate()`	`Date`	Récupère la date du dernier message de ce fil de discussion.
`getMessageCount()`	`Integer`	Renvoie le nombre de messages dans le fil de discussion.
`getMessages()`	`GmailMessage[]`	Récupère les messages de ce fil de discussion.
`getPermalink()`	`String`	Récupère un lien permanent pour ce fil de discussion.
`hasStarredMessages()`	`Boolean`	Indique si le fil de discussion contient des messages suivis.
`isImportant()`	`Boolean`	Indique si le fil de discussion est marqué comme important.
`isInChats()`	`Boolean`	Indique si le fil de discussion est marqué comme chat.
`isInInbox()`	`Boolean`	Indique si le fil de discussion se trouve dans la boîte de réception.
`isInPriorityInbox()`	`Boolean`	Renvoie la valeur "true" si ce fil de discussion se trouve dans la boîte de réception prioritaire, sinon "false".
`isInSpam()`	`Boolean`	Indique si le fil de discussion est marqué comme spam.
`isInTrash()`	`Boolean`	Indique si le fil de discussion se trouve dans la corbeille.
`isUnread()`	`Boolean`	Indique si le fil de discussion contient des messages non lus.
`markImportant()`	`GmailThread`	Marque ce fil de discussion comme important.
`markRead()`	`GmailThread`	Marque ce fil de discussion comme lu.
`markUnimportant()`	`GmailThread`	Marque ce fil de discussion comme non important.
`markUnread()`	`GmailThread`	Marque ce fil de discussion comme non lu.
`moveToArchive()`	`GmailThread`	Déplace ce fil de discussion vers l'archive.
`moveToInbox()`	`GmailThread`	Déplace ce fil de discussion dans la boîte de réception.
`moveToSpam()`	`GmailThread`	Place ce fil de discussion dans le spam.
`moveToTrash()`	`GmailThread`	Place ce fil de discussion dans la corbeille.
`refresh()`	`GmailThread`	Recharge ce thread et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
`removeLabel(label)`	`GmailThread`	Supprime ce libellé du fil de discussion.
`reply(body)`	`GmailThread`	Répondez à l'expéditeur du dernier message de ce fil de discussion à l'aide de l'adresse replyTo.
`reply(body, options)`	`GmailThread`	Répondez à l'expéditeur du dernier message de ce fil de discussion à l'aide de l'adresse replyTo, avec des arguments facultatifs.
`replyAll(body)`	`GmailThread`	Répondez à l'expéditeur (à l'aide de l'adresse de réponse) et à tous les destinataires du dernier message de ce fil de discussion.
`replyAll(body, options)`	`GmailThread`	Répondez à l'expéditeur (à l'aide de l'adresse `replyTo`) et à tous les destinataires du dernier message de ce fil de discussion, avec des arguments facultatifs.