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 des comptes Gmail. Consultez également Service de messagerie, un service plus simple qui permet uniquement d'envoyer des 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 à partir de Gmail.
`GmailDraft`	Brouillon créé par un utilisateur dans le compte Gmail d'un utilisateur.
`GmailLabel`	Libellé créé par l'utilisateur dans le compte Gmail d'un utilisateur.
`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`	Permet de créer 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 pour 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 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 dans Gmail.
`getInboxThreads()`	`GmailThread[]`	Récupère tous les fils de discussion, quels que soient les libellés.
`getInboxThreads(start, max)`	`GmailThread[]`	Récupère un ensemble de fils de discussion, quels que soient les 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[]`	Permet de récupérer tous les messages du fil de discussion spécifié.
`getMessagesForThreads(threads)`	`GmailMessage[][]`	Permet de récupérer tous les messages des fils de discussion spécifiés.
`getPriorityInboxThreads()`	`GmailThread[]`	Récupère tous les fils de discussion prioritaires, 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, 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, quels que soient les libellés.
`getSpamThreads(start, max)`	`GmailThread[]`	Récupère un ensemble de fils de discussion, quel que soit leur libellé.
`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 suivis, 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 ajoutés aux favoris.
`getThreadById(id)`	`GmailThread`	Récupère un thread par ID.
`getTrashThreads()`	`GmailThread[]`	Récupère tous les fils de discussion, quel que soit leur libellé.
`getTrashThreads(start, max)`	`GmailThread[]`	Récupère une plage de fils de discussion, quel que soit leur libellé.
`getUserLabelByName(name)`	`GmailLabel`	Récupère un libellé à partir du nom du libellé.
`getUserLabels()`	`GmailLabel[]`	Récupère la liste des 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`	Permet de marquer ces messages comme lus et de forcer leur actualisation.
`markMessagesUnread(messages)`	`GmailApp`	Marque ces messages comme non lus et force leur actualisation.
`markThreadImportant(thread)`	`GmailApp`	Permet de marquer ce fil de discussion comme important et de forcer son actualisation.
`markThreadRead(thread)`	`GmailApp`	Permet de marquer ce fil comme lu et de forcer l'actualisation.
`markThreadUnimportant(thread)`	`GmailApp`	Permet de marquer ce fil de discussion comme non important et de forcer l'actualisation.
`markThreadUnread(thread)`	`GmailApp`	Marque ce fil comme non lu et force son actualisation.
`markThreadsImportant(threads)`	`GmailApp`	Marque ces fils comme importants et force leur actualisation.
`markThreadsRead(threads)`	`GmailApp`	Marque ces fils comme lus et force leur actualisation.
`markThreadsUnimportant(threads)`	`GmailApp`	Permet de marquer ces fils de discussion comme non importants et de les forcer à s'actualiser.
`markThreadsUnread(threads)`	`GmailApp`	Marque ces fils de discussion comme non lus et force leur actualisation.
`moveMessageToTrash(message)`	`GmailApp`	Permet de placer le message dans la corbeille et de forcer son actualisation.
`moveMessagesToTrash(messages)`	`GmailApp`	Permet de placer les messages spécifiés dans la corbeille et de forcer leur actualisation.
`moveThreadToArchive(thread)`	`GmailApp`	Permet de déplacer ce fil de discussion vers l'archive et de forcer son actualisation.
`moveThreadToInbox(thread)`	`GmailApp`	Permet de déplacer ce fil de discussion vers la boîte de réception et de forcer l'actualisation.
`moveThreadToSpam(thread)`	`GmailApp`	Permet de déplacer ce fil de discussion vers le dossier "Spam" et de forcer l'actualisation.
`moveThreadToTrash(thread)`	`GmailApp`	Permet de placer ce fil dans la corbeille et de forcer l'actualisation.
`moveThreadsToArchive(threads)`	`GmailApp`	Déplace ces fils de discussion vers l'archive et force leur actualisation.
`moveThreadsToInbox(threads)`	`GmailApp`	Permet de déplacer ces fils de discussion vers la boîte de réception et de forcer leur actualisation.
`moveThreadsToSpam(threads)`	`GmailApp`	Permet de placer ces fils de discussion dans le dossier "Spam" et de forcer leur actualisation.
`moveThreadsToTrash(threads)`	`GmailApp`	Permet de placer ces fils de discussion dans la corbeille et de forcer leur actualisation.
`refreshMessage(message)`	`GmailApp`	Actualise le message et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).
`refreshMessages(messages)`	`GmailApp`	Actualise les messages et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).
`refreshThread(thread)`	`GmailApp`	Il actualise 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`	Il actualise 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[]`	Lancez une recherche Gmail dans la requête donnée.
`search(query, start, max)`	`GmailThread[]`	Lancez une recherche Gmail dans 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 des messages à ces messages et force leur actualisation.
`unstarMessage(message)`	`GmailApp`	Supprime une étoile de ce message et force son actualisation.
`unstarMessages(messages)`	`GmailApp`	Supprime les étoiles de ces messages et force l'actualisation des messages.

`GmailAttachment`

Méthodes

Méthode	Type renvoyé	Brève description
`copyBlob()`	`Blob`	Renvoie une copie de cet objet blob.
`getAs(contentType)`	`Blob`	Renvoyez les données de cet objet en tant qu'objet blob converti au 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 cet objet blob sous forme de chaîne avec l'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 ce rattachement.
`getName()`	`String`	Récupère le nom de cet objet blob.
`getSize()`	`Integer`	Récupère la taille de ce rattachement.
`isGoogleType()`	`Boolean`	Indique si cet objet 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 objet blob en fonction de l'extension de fichier.
`setDataFromString(string)`	`Blob`	Définit les données de ce blob à partir d'une chaîne avec un encodage 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 cet objet 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 de message.
`getMessage()`	`GmailMessage`	Affiche un message GmailMessage représentant ce brouillon.
`getMessageId()`	`String`	Renvoie l'ID de `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 par des arguments facultatifs.

`GmailLabel`

Méthodes

Méthode	Type renvoyé	Brève description
`addToThread(thread)`	`GmailLabel`	Ajoute ce libellé au thread donné et force son actualisation (`GmailThread.refresh()`).
`addToThreads(threads)`	`GmailLabel`	Ajoute ce libellé aux fils de discussion 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 fils de discussion 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 tagués.
`removeFromThread(thread)`	`GmailLabel`	Supprime ce libellé du thread donné et force son actualisation.
`removeFromThreads(threads)`	`GmailLabel`	Supprime ce libellé des fils de discussion donnés et force leur actualisation.

`GmailMessage`

Méthodes

Méthode	Type renvoyé	Brève description
`createDraftReply(body)`	`GmailDraft`	Crée un brouillon de réponse à l'expéditeur du message en utilisant l'adresse de réponse.
`createDraftReply(body, options)`	`GmailDraft`	Crée un brouillon de réponse à l'expéditeur en utilisant l'adresse de réponse, avec des arguments facultatifs.
`createDraftReplyAll(body)`	`GmailDraft`	Crée un brouillon de réponse à 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`	Transfère ce message aux 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 copie cachée de 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'identifiant 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 qui contient ce message.
`getTo()`	`String`	Récupère les destinataires de ce message séparés par une virgule.
`isDraft()`	`Boolean`	Détermine si ce message est un brouillon.
`isInChats()`	`Boolean`	Détermine si ce message est un 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 n'est pas lu.
`markRead()`	`GmailMessage`	Permet de marquer le message comme lu.
`markUnread()`	`GmailMessage`	Le message est marqué comme non lu.
`moveToTrash()`	`GmailMessage`	Permet de placer le message dans la corbeille.
`refresh()`	`GmailMessage`	Actualise ce message et l'état associé depuis Gmail (utile en cas de modification des libellés, de l'état de lecture, etc.).
`reply(body)`	`GmailMessage`	Permet de répondre à l'expéditeur de ce 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`	Permet de répondre à l'expéditeur en utilisant l'adresse de réponse et tous les destinataires de ce message.
`replyAll(body, options)`	`GmailMessage`	Permet de répondre à l'expéditeur de ce message en utilisant l'adresse de réponse et tous les destinataires, avec des arguments facultatifs.
`star()`	`GmailMessage`	Activer le suivi du message
`unstar()`	`GmailMessage`	Annule 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 réponse à l'expéditeur du dernier message de ce fil de discussion en utilisant l'adresse de réponse.
`createDraftReply(body, options)`	`GmailDraft`	Crée un brouillon de réponse à l'expéditeur du dernier message de ce fil de discussion en utilisant l'adresse de réponse, avec des arguments facultatifs.
`createDraftReplyAll(body)`	`GmailDraft`	Crée un brouillon de réponse à 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 de réponse à l'expéditeur du dernier message de ce fil de discussion, en utilisant l'adresse de réponse et 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 fil de discussion.
`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 fil de discussion est marqué comme important.
`isInChats()`	`Boolean`	Indique si le fil de discussion est associé à un libellé de 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 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 comme important.
`markRead()`	`GmailThread`	Marque ce fil comme lu.
`markUnimportant()`	`GmailThread`	Marque ce fil comme non important.
`markUnread()`	`GmailThread`	Marque ce fil comme non lu.
`moveToArchive()`	`GmailThread`	Déplace ce fil de discussion vers l'archive.
`moveToInbox()`	`GmailThread`	Permet de déplacer ce fil de discussion vers la boîte de réception.
`moveToSpam()`	`GmailThread`	Permet de déplacer ce fil de discussion vers le dossier "Spam".
`moveToTrash()`	`GmailThread`	Permet de placer ce fil dans la corbeille.
`refresh()`	`GmailThread`	Il actualise ce fil de discussion 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 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 (en utilisant l'adresse "replyTo") et à tous les destinataires du dernier message de ce fil de discussion.
`replyAll(body, options)`	`GmailThread`	Répondez à l'expéditeur (en utilisant l'adresse `replyTo`) et à tous les destinataires du dernier message de ce fil de discussion, avec des arguments facultatifs.