Class GmailDraft

GmailDraft

Message brouillon créé par un utilisateur dans son compte Gmail.

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	Renvoie un GmailMessage représentant ce brouillon.
getMessageId()	String	Renvoie 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 de message à l'aide d'arguments facultatifs.

Documentation détaillée

deleteDraft()

Supprime ce brouillon.

const 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 scopes suivants ou les scopes appropriés de l'API REST associée :

• https://mail.google.com/

---

getId()

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

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const draftId = draft.getId();
const 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 scopes suivants ou les scopes appropriés de l'API REST associée :

• https://mail.google.com/

---

getMessage()

Renvoie un GmailMessage représentant ce brouillon.

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const 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 scopes suivants ou les scopes appropriés de l'API REST associée :

• https://mail.google.com/

---

getMessageId()

Renvoie l'ID de l'GmailMessage représentant ce brouillon.

const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const 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 scopes suivants ou les scopes 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 (y compris les en-têtes) est limitée par un quota.

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

Renvois

GmailMessage : le message qui vient d'être envoyé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants ou les scopes 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 (y compris les en-têtes) est limitée par un quota.

// The code below will update a draft email with the current date and time.
const draft =
    GmailApp.getDrafts()[0];  // The first draft message in the drafts folder
const now = new Date();
draft.update(
    '[e-mail]',
    'current time',
    `The time is: ${now.toString()}`,
);

Paramètres

Nom	Type	Description
recipient	String	Liste d'adresses e-mail séparées par une virgule
subject	String	Objet de l'e-mail (250 caractères maximum)
body	String	corps de l'e-mail

Renvois

GmailDraft : le brouillon récemment modifié

Autorisation

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

• https://mail.google.com/

Voir aussi

• GmailApp.createDraft(recipient, subject, body)

---

update(recipient, subject, body, options)

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

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

Paramètres

Nom	Type	Description
recipient	String	Liste d'adresses e-mail séparées par une virgule
subject	String	Objet de l'e-mail (250 caractères maximum)
body	String	corps de l'e-mail
options	Object	Objet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous

Paramètres avancés

Nom	Type	Description
attachments	BlobSource[]	Tableau de fichiers à envoyer avec l'e-mail
bcc	String	Liste d'adresses e-mail à mettre en Cci, séparées par une virgule
cc	String	Liste d'adresses e-mail à mettre en copie, séparées par une virgule.
from	String	Adresse d'envoi de l'e-mail, qui doit être l'une des valeurs renvoyées par GmailApp.getAliases()
htmlBody	String	Si cette option est définie, les appareils capables d'afficher du code HTML l'utiliseront à la place de l'argument de corps requis. Vous pouvez ajouter un champ inlineImages facultatif dans le corps HTML si vous avez intégré des images à votre e-mail.
inlineImages	Object	Objet JavaScript contenant un mappage de la clé d'image (String) aux données d'image (BlobSource). Cela suppose que le paramètre htmlBody est utilisé et contient des références à ces images au format <img src="cid:imageKey" />.
name	String	Nom de l'expéditeur de l'e-mail (par défaut, le nom de l'utilisateur)
replyTo	String	Adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut : adresse e-mail de l'utilisateur)

Renvois

GmailDraft : le brouillon récemment modifié

Autorisation

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

• https://mail.google.com/

Voir aussi

• GmailApp.createDraft(recipient, subject, body, options)