Gmail Service

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

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

NomBrève description
GmailAppPermet d'accéder aux fils de discussion, aux messages et aux libellés Gmail.
GmailAttachmentUne pièce jointe à partir de Gmail.
GmailDraftBrouillon créé par un utilisateur dans le compte Gmail d'un utilisateur.
GmailLabelLibellé créé par l'utilisateur dans le compte Gmail d'un utilisateur.
GmailMessageMessage dans le compte Gmail d'un utilisateur.
GmailThreadFil de discussion dans le compte Gmail d'un utilisateur.

GmailApp

Méthodes

MéthodeType renvoyéBrève description
createDraft(recipient, subject, body)GmailDraftPermet de créer un brouillon d'e-mail.
createDraft(recipient, subject, body, options)GmailDraftCrée un brouillon d'e-mail avec des arguments facultatifs.
createLabel(name)GmailLabelCréez un libellé utilisateur pour le nom donné.
deleteLabel(label)GmailAppSupprime 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)GmailDraftRé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()IntegerRécupère le nombre de fils de discussion non lus dans la boîte de réception.
getMessageById(id)GmailMessageRé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()IntegerRé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()IntegerRé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()IntegerRécupère le nombre de fils de discussion non lus ajoutés aux favoris.
getThreadById(id)GmailThreadRé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)GmailLabelRé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)GmailAppMarque ce message comme lu et force son actualisation.
markMessageUnread(message)GmailAppMarque ce message comme non lu et force son actualisation.
markMessagesRead(messages)GmailAppPermet de marquer ces messages comme lus et de forcer leur actualisation.
markMessagesUnread(messages)GmailAppMarque ces messages comme non lus et force leur actualisation.
markThreadImportant(thread)GmailAppPermet de marquer ce fil de discussion comme important et de forcer son actualisation.
markThreadRead(thread)GmailAppPermet de marquer ce fil comme lu et de forcer l'actualisation.
markThreadUnimportant(thread)GmailAppPermet de marquer ce fil de discussion comme non important et de forcer l'actualisation.
markThreadUnread(thread)GmailAppMarque ce fil comme non lu et force son actualisation.
markThreadsImportant(threads)GmailAppMarque ces fils comme importants et force leur actualisation.
markThreadsRead(threads)GmailAppMarque ces fils comme lus et force leur actualisation.
markThreadsUnimportant(threads)GmailAppPermet de marquer ces fils de discussion comme non importants et de les forcer à s'actualiser.
markThreadsUnread(threads)GmailAppMarque ces fils de discussion comme non lus et force leur actualisation.
moveMessageToTrash(message)GmailAppPermet de placer le message dans la corbeille et de forcer son actualisation.
moveMessagesToTrash(messages)GmailAppPermet de placer les messages spécifiés dans la corbeille et de forcer leur actualisation.
moveThreadToArchive(thread)GmailAppPermet de déplacer ce fil de discussion vers l'archive et de forcer son actualisation.
moveThreadToInbox(thread)GmailAppPermet de déplacer ce fil de discussion vers la boîte de réception et de forcer l'actualisation.
moveThreadToSpam(thread)GmailAppPermet de déplacer ce fil de discussion vers le dossier "Spam" et de forcer l'actualisation.
moveThreadToTrash(thread)GmailAppPermet de placer ce fil dans la corbeille et de forcer l'actualisation.
moveThreadsToArchive(threads)GmailAppDéplace ces fils de discussion vers l'archive et force leur actualisation.
moveThreadsToInbox(threads)GmailAppPermet de déplacer ces fils de discussion vers la boîte de réception et de forcer leur actualisation.
moveThreadsToSpam(threads)GmailAppPermet de placer ces fils de discussion dans le dossier "Spam" et de forcer leur actualisation.
moveThreadsToTrash(threads)GmailAppPermet de placer ces fils de discussion dans la corbeille et de forcer leur actualisation.
refreshMessage(message)GmailAppActualise le message et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).
refreshMessages(messages)GmailAppActualise les messages et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc., ont changé).
refreshThread(thread)GmailAppIl 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)GmailAppIl 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)GmailAppEnvoie un e-mail.
sendEmail(recipient, subject, body, options)GmailAppEnvoie un e-mail avec des arguments facultatifs.
setCurrentMessageAccessToken(accessToken)voidDéfinit le jeton d'accès aux messages actuel qui permet au script d'accéder aux propriétés GmailMessage actuelles.
starMessage(message)GmailAppAjoute une étoile à ce message et force son actualisation.
starMessages(messages)GmailAppAjoute des messages à ces messages et force leur actualisation.
unstarMessage(message)GmailAppSupprime une étoile de ce message et force son actualisation.
unstarMessages(messages)GmailAppSupprime les étoiles de ces messages et force l'actualisation des messages.

GmailAttachment

Méthodes

MéthodeType renvoyéBrève description
copyBlob()BlobRenvoie une copie de cet objet blob.
getAs(contentType)BlobRenvoyez 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()StringRécupère le type de contenu des octets de cet objet blob.
getDataAsString()StringRécupère les données de cet objet blob sous forme de chaîne avec l'encodage UTF-8.
getDataAsString(charset)StringRécupère les données de cet objet blob sous forme de chaîne avec l'encodage spécifié.
getHash()StringRécupère le hachage de contenu SHA1 pour ce rattachement.
getName()StringRécupère le nom de cet objet blob.
getSize()IntegerRécupère la taille de ce rattachement.
isGoogleType()BooleanIndique si cet objet blob est un fichier Google Workspace (Sheets, Docs, etc.).
setBytes(data)BlobDéfinit les données stockées dans cet objet blob.
setContentType(contentType)BlobDéfinit le type de contenu des octets dans cet objet blob.
setContentTypeFromExtension()BlobDéfinit le type de contenu des octets de cet objet blob en fonction de l'extension de fichier.
setDataFromString(string)BlobDéfinit les données de ce blob à partir d'une chaîne avec un encodage UTF-8.
setDataFromString(string, charset)BlobDéfinit les données de cet objet blob à partir d'une chaîne avec l'encodage spécifié.
setName(name)BlobDéfinit le nom de cet objet blob.

GmailDraft

Méthodes

MéthodeType renvoyéBrève description
deleteDraft()voidSupprime ce brouillon.
getId()StringRécupère l'ID de ce brouillon de message.
getMessage()GmailMessageAffiche un message GmailMessage représentant ce brouillon.
getMessageId()StringRenvoie l'ID de GmailMessage représentant ce brouillon.
send()GmailMessageEnvoie ce brouillon d'e-mail.
update(recipient, subject, body)GmailDraftRemplace le contenu de ce brouillon.
update(recipient, subject, body, options)GmailDraftRemplace le contenu de ce brouillon par des arguments facultatifs.

GmailLabel

Méthodes

MéthodeType renvoyéBrève description
addToThread(thread)GmailLabelAjoute ce libellé au thread donné et force son actualisation (GmailThread.refresh()).
addToThreads(threads)GmailLabelAjoute ce libellé aux fils de discussion donnés et force leur actualisation.
deleteLabel()voidSupprime ce libellé.
getName()StringRé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()IntegerRécupère le nombre de fils de discussion non lus tagués.
removeFromThread(thread)GmailLabelSupprime ce libellé du thread donné et force son actualisation.
removeFromThreads(threads)GmailLabelSupprime ce libellé des fils de discussion donnés et force leur actualisation.

GmailMessage

Méthodes

MéthodeType renvoyéBrève description
createDraftReply(body)GmailDraftCrée un brouillon de réponse à l'expéditeur du message en utilisant l'adresse de réponse.
createDraftReply(body, options)GmailDraftCrée un brouillon de réponse à l'expéditeur en utilisant l'adresse de réponse, avec des arguments facultatifs.
createDraftReplyAll(body)GmailDraftCré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)GmailDraftCrée un brouillon de réponse à l'expéditeur en utilisant l'adresse de réponse et tous les destinataires, avec des arguments facultatifs.
forward(recipient)GmailMessageTransfère ce message aux nouveaux destinataires.
forward(recipient, options)GmailMessageTransfè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()StringRécupère les destinataires séparés par une virgule en copie cachée de ce message.
getBody()StringRécupère le contenu HTML du corps de ce message.
getCc()StringRécupère les destinataires séparés par une virgule en copie de ce message.
getDate()DateRécupère la date et l'heure de ce message.
getFrom()StringRécupère l'expéditeur de ce message.
getHeader(name)StringRécupère la valeur d'un en-tête RFC 2822 en fonction du nom de l'en-tête.
getId()StringRécupère l'identifiant de ce message.
getPlainBody()StringRécupère le contenu du corps de ce message, sans mise en forme HTML.
getRawContent()StringRécupère le contenu brut de ce message.
getReplyTo()StringRécupère l'adresse de réponse de ce message (généralement l'expéditeur).
getSubject()StringRécupère l'objet de ce message.
getThread()GmailThreadRécupère le fil de discussion qui contient ce message.
getTo()StringRécupère les destinataires de ce message séparés par une virgule.
isDraft()BooleanDétermine si ce message est un brouillon.
isInChats()BooleanDétermine si ce message est un chat.
isInInbox()BooleanDétermine si ce message se trouve dans la boîte de réception.
isInPriorityInbox()BooleanRenvoie true si ce message se trouve dans la boîte de réception Prioritaire. Sinon, renvoie false.
isInTrash()BooleanDétermine si ce message se trouve dans la corbeille.
isStarred()BooleanDétermine si ce message est suivi.
isUnread()BooleanDétermine si ce message n'est pas lu.
markRead()GmailMessagePermet de marquer le message comme lu.
markUnread()GmailMessageLe message est marqué comme non lu.
moveToTrash()GmailMessagePermet de placer le message dans la corbeille.
refresh()GmailMessageActualise ce message et l'état associé depuis Gmail (utile en cas de modification des libellés, de l'état de lecture, etc.).
reply(body)GmailMessagePermet de répondre à l'expéditeur de ce message en utilisant l'adresse de réponse.
reply(body, options)GmailMessagePermet de répondre à l'expéditeur de ce message en utilisant l'adresse de réponse, avec des arguments facultatifs.
replyAll(body)GmailMessagePermet de répondre à l'expéditeur en utilisant l'adresse de réponse et tous les destinataires de ce message.
replyAll(body, options)GmailMessagePermet 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()GmailMessageActiver le suivi du message
unstar()GmailMessageAnnule le suivi du message.

GmailThread

Méthodes

MéthodeType renvoyéBrève description
addLabel(label)GmailThreadAjoute ce libellé au fil de discussion.
createDraftReply(body)GmailDraftCré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)GmailDraftCré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)GmailDraftCré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)GmailDraftCré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()StringRécupère l'objet du premier message du fil de discussion.
getId()StringRécupère l'ID de ce thread.
getLabels()GmailLabel[]Renvoie les libellés créés par l'utilisateur sur ce fil de discussion.
getLastMessageDate()DateRécupère la date du message le plus récent de ce fil de discussion.
getMessageCount()IntegerRenvoie le nombre de messages du fil de discussion.
getMessages()GmailMessage[]Récupère les messages de ce fil de discussion.
getPermalink()StringRécupère un lien permanent pour ce fil de discussion.
hasStarredMessages()BooleanIndique si le fil de discussion contient des messages suivis.
isImportant()BooleanIndique si le fil de discussion est marqué comme important.
isInChats()BooleanIndique si le fil de discussion est associé à un libellé de chat.
isInInbox()BooleanIndique si le fil de discussion se trouve dans la boîte de réception.
isInPriorityInbox()BooleanRenvoie la valeur "true" si ce fil de discussion se trouve dans la boîte de réception Prioritaire. Sinon, renvoie la valeur "false".
isInSpam()BooleanIndique si le fil de discussion est marqué comme spam.
isInTrash()BooleanIndique si le fil de discussion se trouve dans la corbeille.
isUnread()BooleanIndique si le fil de discussion contient des messages non lus.
markImportant()GmailThreadMarque ce fil comme important.
markRead()GmailThreadMarque ce fil comme lu.
markUnimportant()GmailThreadMarque ce fil comme non important.
markUnread()GmailThreadMarque ce fil comme non lu.
moveToArchive()GmailThreadDéplace ce fil de discussion vers l'archive.
moveToInbox()GmailThreadPermet de déplacer ce fil de discussion vers la boîte de réception.
moveToSpam()GmailThreadPermet de déplacer ce fil de discussion vers le dossier "Spam".
moveToTrash()GmailThreadPermet de placer ce fil dans la corbeille.
refresh()GmailThreadIl 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)GmailThreadSupprime ce libellé du fil de discussion.
reply(body)GmailThreadRépondez à l'expéditeur du dernier message de ce fil de discussion en utilisant l'adresse "replyTo".
reply(body, options)GmailThreadRépondez à l'expéditeur du dernier message de ce fil de discussion en utilisant l'adresse "replyTo" avec des arguments facultatifs.
replyAll(body)GmailThreadRépondez à l'expéditeur (en utilisant l'adresse "replyTo") et à tous les destinataires du dernier message de ce fil de discussion.
replyAll(body, options)GmailThreadRé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.