Class GmailDraft

GmailDraft

Brouillon de message créé par un utilisateur dans son compte Gmail

Méthodes

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

Documentation détaillée

deleteDraft()

Supprime ce brouillon.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
draft.deleteDraft();
draft.getMessage(); // Throws exception.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des champs d'application appropriés de l'API REST associée:

  • https://mail.google.com/

getId()

Récupère l'ID de ce brouillon.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var draftId = draft.getId();
var draftById = GmailApp.getDraft(draftId);
Logger.log(draft.getMessage().getSubject() == draftById.getMessage().getSubject());

Renvois

String : ID du brouillon

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des champs d'application appropriés de l'API REST associée:

  • https://mail.google.com/

getMessage()

Affiche un GmailMessage représentant ce brouillon.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var message = draft.getMessage();
Logger.log(message.getSubject());

Renvois

GmailMessage : message représentant le contenu de ce brouillon

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des champs d'application appropriés de l'API REST associée:

  • https://mail.google.com/

getMessageId()

Affiche l'ID du GmailMessage représentant ce brouillon.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var messageId = draft.getMessageId();
Logger.log(messageId == draft.getMessage().getId());

Renvois

String : ID du message

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des champs d'application appropriés de l'API REST associée:

  • https://mail.google.com/

send()

Envoie ce brouillon d'e-mail. La taille de l'e-mail (en-têtes compris) est limitée par le quota.

var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var msg = draft.send(); // Send it
Logger.log(msg.getDate()); // Should be approximately the current timestamp

Renvois

GmailMessage : message nouvellement envoyé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des champs d'application appropriés de l'API REST associée:

  • https://mail.google.com/

update(recipient, subject, body)

Remplace le contenu de ce brouillon. La taille de l'e-mail (en-têtes compris) est limitée par le quota.

// The code below will update a draft email with the current date and time.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var now = new Date();
draft.update("mike@example.com", "current time", "The time is: " + now.toString());

Paramètres

NomTypeDescription
recipientStringliste d'adresses e-mail séparées par une virgule
subjectStringobjet de l'e-mail (250 caractères maximum)
bodyStringcorps de l'e-mail

Renvois

GmailDraft : brouillon récemment mis à jour

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des champs d'application appropriés de l'API REST associée:

  • https://mail.google.com/

Voir aussi


update(recipient, subject, body, options)

Remplace le contenu de ce brouillon par des arguments facultatifs. L'e-mail peut contenir du texte brut ou du corps HTML. La taille de l'e-mail (en-têtes compris) est limitée par le quota.

// Update a draft email with a file from Google Drive attached as a PDF.
var draft = GmailApp.getDrafts()[0]; // The first draft message in the drafts folder
var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
draft.update('mike@example.com', 'Attachment example', 'Please see attached file.', {
    attachments: [file.getAs(MimeType.PDF)],
    name: 'Automatic Emailer Script'
});

Paramètres

NomTypeDescription
recipientStringliste d'adresses e-mail séparées par une virgule
subjectStringobjet de l'e-mail (250 caractères maximum)
bodyStringcorps de l'e-mail
optionsObjectUn objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

NomTypeDescription
attachmentsBlobSource[]une tableau de fichiers à envoyer avec l'adresse e-mail
bccStringune liste d'adresses e-mail séparées par une virgule à mettre en Cci
ccStringune liste d'adresses e-mail séparées par une virgule à mettre en Cc
fromStringl'adresse d'envoi de l'e-mail, qui doit être une des valeurs renvoyées par GmailApp.getAliases()
htmlBodyStringSi cette règle est définie, les appareils capables d'afficher le code HTML l'utilisent à la place de l'argument "body" requis ; vous pouvez ajouter un champ inlineImages facultatif en HTML corps si vous avez des images intégrées pour votre e-mail
inlineImagesObjectObjet JavaScript contenant un mappage à partir de la clé d'image (String) vers les données d'image (BlobSource) Cela suppose que le paramètre htmlBody est utilisé et qu'il contient des références à ces images au format <img src="cid:imageKey" />.
nameStringNom de l'expéditeur de l'e-mail (par défaut: nom de l'utilisateur)
replyToStringUne adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut: adresse e-mail de l'utilisateur)

Renvois

GmailDraft : brouillon récemment mis à jour

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants, ou des champs d'application appropriés de l'API REST associée:

  • https://mail.google.com/

Voir aussi