Gmail Service

Gmail

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

NomBrève description
GmailAppPermet d'accéder aux fils de discussion, aux messages et aux libellés Gmail.
GmailAttachmentUne pièce jointe de Gmail
GmailDraftBrouillon créé par un utilisateur dans son compte Gmail.
GmailLabelLibellé créé par l'utilisateur dans son compte Gmail.
GmailMessageUn message 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)GmailDraftCrée un brouillon d'e-mail.
createDraft(recipient, subject, body, options)GmailDraftCrée un brouillon d'e-mail avec des arguments facultatifs.
createLabel(name)GmailLabelCrée un nouveau libellé d'utilisateur du 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é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()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[]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()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 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()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 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()IntegerRécupère le nombre de fils de discussion non lus suivis.
getThreadById(id)GmailThreadRé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)GmailLabelRé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)GmailAppMarque ce message comme lu et force son actualisation.
markMessageUnread(message)GmailAppMarque ce message comme non lu et force son actualisation.
markMessagesRead(messages)GmailAppMarque ces messages comme lus et force leur actualisation.
markMessagesUnread(messages)GmailAppMarque ces messages comme non lus et force leur actualisation.
markThreadImportant(thread)GmailAppMarque ce thread comme important et le force à s'actualiser.
markThreadRead(thread)GmailAppMarque ce thread comme lu et force son actualisation.
markThreadUnimportant(thread)GmailAppMarque ce thread comme non important et le force à s'actualiser.
markThreadUnread(thread)GmailAppMarque ce fil de discussion comme non lu et force son actualisation.
markThreadsImportant(threads)GmailAppMarque ces threads comme importants et force leur actualisation.
markThreadsRead(threads)GmailAppMarque ces threads comme lus et force leur actualisation.
markThreadsUnimportant(threads)GmailAppMarque ces threads comme non importants et force leur actualisation.
markThreadsUnread(threads)GmailAppMarque ces fils comme non lus et force leur actualisation.
moveMessageToTrash(message)GmailAppPlace le message dans la corbeille et force son actualisation.
moveMessagesToTrash(messages)GmailAppPlace les messages spécifiés dans la corbeille et force leur actualisation.
moveThreadToArchive(thread)GmailAppDéplace ce thread vers l'archive et force son actualisation.
moveThreadToInbox(thread)GmailAppDéplace ce fil de discussion vers la boîte de réception et le force à s'actualiser.
moveThreadToSpam(thread)GmailAppPlace ce fil de discussion dans le spam et le force à s'actualiser.
moveThreadToTrash(thread)GmailAppPlace ce thread dans la corbeille et force son actualisation.
moveThreadsToArchive(threads)GmailAppDéplace ces fils de discussion vers l'archive et force leur actualisation.
moveThreadsToInbox(threads)GmailAppDéplace ces fils de discussion vers la boîte de réception et force leur actualisation.
moveThreadsToSpam(threads)GmailAppDéplace ces fils dans le spam et force leur actualisation.
moveThreadsToTrash(threads)GmailAppDéplace ces threads dans la corbeille et force leur actualisation.
refreshMessage(message)GmailAppActualise le message et son état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
refreshMessages(messages)GmailAppRecharge les messages et leur état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
refreshThread(thread)GmailAppRecharge le thread et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
refreshThreads(threads)GmailAppRecharge 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)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 le suivi de ces messages et force leur actualisation.
unstarMessage(message)GmailAppSupprime le suivi pour ce message et le force à s'actualiser.
unstarMessages(messages)GmailAppSupprime les suivis de ces messages et force leur actualisation.

GmailAttachment

Méthodes

MéthodeType renvoyéBrève description
copyBlob()BlobRenvoie une copie de ce blob.
getAs(contentType)BlobRenvoie 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()StringRécupère le type de contenu des octets de cet objet blob.
getDataAsString()StringRécupère les données de ce blob sous forme de chaîne avec un 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 cette pièce jointe.
getName()StringRécupère le nom de ce blob.
getSize()IntegerRécupère la taille de ce rattachement.
isGoogleType()BooleanIndique si ce 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 blob en fonction de l'extension de fichier.
setDataFromString(string)BlobDéfinit les données de cet objet blob à partir d'une chaîne encodée en 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 ce blob.

GmailDraft

Méthodes

MéthodeType renvoyéBrève description
deleteDraft()voidSupprime ce brouillon.
getId()StringRécupère l'ID de ce brouillon.
getMessage()GmailMessageAffiche un message GmailMessage représentant ce brouillon.
getMessageId()StringAffiche l'ID de l'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 à l'aide d'arguments facultatifs.

GmailLabel

Méthodes

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

GmailMessage

Méthodes

MéthodeType renvoyéBrève description
createDraftReply(body)GmailDraftCrée un brouillon de message en réponse à l'expéditeur à l'aide de l'adresse de réponse.
createDraftReply(body, options)GmailDraftCrée un brouillon de message répondant à l'expéditeur à l'aide de l'adresse de réponse, avec des arguments facultatifs.
createDraftReplyAll(body)GmailDraftCré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)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)GmailMessageCe 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()StringRécupère les destinataires séparés par une virgule en Cci pour 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'ID de ce message.
getPlainBody()StringRécupère le contenu du corps de ce message sans la 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 contenant ce message.
getTo()StringRécupère les destinataires de ce message, séparés par une virgule.
isDraft()BooleanDétermine s'il s'agit d'un brouillon.
isInChats()BooleanDétermine s'il s'agit d'un message de 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 est non lu.
markRead()GmailMessageMarque le message comme lu.
markUnread()GmailMessageMarque le message comme non lu.
moveToTrash()GmailMessagePermet de placer le message dans la corbeille.
refresh()GmailMessageRecharge ce message et l'état associé à partir de Gmail (utile si les libellés, l'état de lecture, etc. ont changé).
reply(body)GmailMessagePermet de répondre à l'expéditeur du 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)GmailMessageRépondre à l'expéditeur avec l'adresse de réponse et tous les destinataires du message
replyAll(body, options)GmailMessageRépondez à l'expéditeur de ce message en utilisant l'adresse de réponse et tous les destinataires, avec les arguments facultatifs.
star()GmailMessagePermet d'activer le suivi du message.
unstar()GmailMessageDésactive 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 répondant à l'expéditeur du dernier message de ce fil de discussion à l'aide de l'adresse de réponse.
createDraftReply(body, options)GmailDraftCré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)GmailDraftCré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)GmailDraftCré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()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 pour ce thread.
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 thread est marqué comme important.
isInChats()BooleanIndique si le fil de discussion est associé au libellé "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 thread se trouve dans la corbeille.
isUnread()BooleanIndique si le fil de discussion contient des messages non lus.
markImportant()GmailThreadMarque ce fil de discussion comme important.
markRead()GmailThreadMarque ce fil de discussion comme lu.
markUnimportant()GmailThreadMarque ce fil de discussion comme non important.
markUnread()GmailThreadMarque ce fil de discussion comme non lu.
moveToArchive()GmailThreadDéplace ce fil de discussion vers l'archive.
moveToInbox()GmailThreadDéplace ce fil de discussion dans la boîte de réception.
moveToSpam()GmailThreadDéplace ce fil de discussion dans le spam.
moveToTrash()GmailThreadPlace ce fil de discussion dans la corbeille.
refresh()GmailThreadRecharge ce thread, ainsi que 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 (à l'aide de l'adresse ReplyTo) et à tous les destinataires du dernier message de ce fil de discussion.
replyAll(body, options)GmailThreadRé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.