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 les libellés, de marquer des messages et des fils de discussion, et d'effectuer diverses autres tâches de gestion de compte Gmail. Voir également Service de messagerie, un service plus simple qui permet uniquement 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`	Une pièce jointe de Gmail
`GmailDraft`	Brouillon créé par un utilisateur dans son compte Gmail.
`GmailLabel`	Libellé créé par l'utilisateur dans son compte Gmail.
`GmailMessage`	Un 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é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.

`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 contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié.
`getBytes()`	`Byte[]`	Récupère les données stockées dans cet objet blob.
`getContentType()`	`String`	Récupère le type de contenu des octets de cet objet blob.
`getDataAsString()`	`String`	Récupère les données de ce blob sous forme de chaîne avec un encodage UTF-8.
`getDataAsString(charset)`	`String`	Récupère les données de cet objet blob sous forme de chaîne avec l'encodage spécifié.
`getHash()`	`String`	Récupère le hachage de contenu SHA1 pour cette pièce jointe.
`getName()`	`String`	Récupère le nom de ce blob.
`getSize()`	`Integer`	Récupère la taille de ce rattachement.
`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 cet objet blob.
`setContentType(contentType)`	`Blob`	Définit le type de contenu des octets dans cet objet blob.
`setContentTypeFromExtension()`	`Blob`	Définit le type de contenu des octets de cet blob en fonction de l'extension de fichier.
`setDataFromString(string)`	`Blob`	Définit les données de cet objet blob à partir d'une chaîne encodée en UTF-8.
`setDataFromString(string, charset)`	`Blob`	Définit les données de cet objet 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.
`getId()`	`String`	Récupère l'ID de ce brouillon.
`getMessage()`	`GmailMessage`	Affiche un message GmailMessage représentant ce brouillon.
`getMessageId()`	`String`	Affiche 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.
`update(recipient, subject, body, options)`	`GmailDraft`	Remplace le contenu de ce brouillon à 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 de ce thread (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	Ajoute ce libellé aux threads donnés et force l'actualisation de ces derniers.
`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 fils de discussion marqués avec ce libellé.
`getUnreadCount()`	`Integer`	Récupère le nombre de fils de discussion non lus marqués avec ce libellé.
`removeFromThread(thread)`	`GmailLabel`	Supprime ce libellé du thread donné et force l'actualisation du thread.
`removeFromThreads(threads)`	`GmailLabel`	Supprime ce libellé des threads donnés et force l'actualisation de ces derniers.

`GmailMessage`

Méthodes

Méthode	Type renvoyé	Brève description
`createDraftReply(body)`	`GmailDraft`	Crée un brouillon de message en réponse à l'expéditeur à l'aide de l'adresse de réponse.
`createDraftReply(body, options)`	`GmailDraft`	Crée un brouillon de message répondant à l'expéditeur à l'aide de l'adresse de réponse, avec des arguments facultatifs.
`createDraftReplyAll(body)`	`GmailDraft`	Cré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)`	`GmailDraft`	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.
`forward(recipient)`	`GmailMessage`	Transfère ce message aux nouveaux destinataires.
`forward(recipient, options)`	`GmailMessage`	Ce 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()`	`String`	Récupère les destinataires séparés par une virgule en Cci pour ce message.
`getBody()`	`String`	Récupère le contenu HTML du corps de ce message.
`getCc()`	`String`	Récupère les destinataires séparés par une virgule en copie 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 en fonction 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 la 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`	Détermine s'il s'agit d'un brouillon.
`isInChats()`	`Boolean`	Détermine s'il s'agit d'un message de chat.
`isInInbox()`	`Boolean`	Détermine 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, renvoie `false`.
`isInTrash()`	`Boolean`	Détermine si ce message se trouve dans la corbeille.
`isStarred()`	`Boolean`	Détermine si ce message est suivi.
`isUnread()`	`Boolean`	Détermine si ce message est non lu.
`markRead()`	`GmailMessage`	Marque le message comme lu.
`markUnread()`	`GmailMessage`	Marque le message comme non lu.
`moveToTrash()`	`GmailMessage`	Permet de placer 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`	Permet de répondre à l'expéditeur du message en utilisant l'adresse de réponse.
`reply(body, options)`	`GmailMessage`	Permet de répondre à 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 avec l'adresse de réponse et tous les destinataires du message
`replyAll(body, options)`	`GmailMessage`	Répondez à l'expéditeur de ce message en utilisant l'adresse de réponse et tous les destinataires, avec les arguments facultatifs.
`star()`	`GmailMessage`	Permet d'activer le suivi du 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 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 répondant à l'expéditeur du dernier message de ce fil de discussion, en utilisant l'adresse de réponse et tous les destinataires de ce message.
`createDraftReplyAll(body, options)`	`GmailDraft`	Crée un brouillon qui répond à 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 pour ce thread.
`getLastMessageDate()`	`Date`	Récupère la date du message le plus récent de ce fil de discussion.
`getMessageCount()`	`Integer`	Renvoie le nombre de messages du 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 thread est marqué comme important.
`isInChats()`	`Boolean`	Indique si le fil de discussion est associé au libellé "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, renvoie la valeur "false".
`isInSpam()`	`Boolean`	Indique si le fil de discussion est marqué comme spam.
`isInTrash()`	`Boolean`	Indique si le thread 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`	Déplace ce fil de discussion dans le spam.
`moveToTrash()`	`GmailThread`	Place ce fil de discussion dans la corbeille.
`refresh()`	`GmailThread`	Recharge ce thread, ainsi que 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 en utilisant l'adresse ReplyTo.
`reply(body, options)`	`GmailThread`	Répondez à l'expéditeur du dernier message de ce fil de discussion en utilisant l'adresse ReplyTo, avec des arguments facultatifs.
`replyAll(body)`	`GmailThread`	Répondez à l'expéditeur (à l'aide de l'adresse ReplyTo) 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.