Cette page a été traduite par l'API Cloud Translation.

Class GmailDraft

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`	Affiche un message GmailMessage représentant ce brouillon.
`getMessageId()`	`String`	Affiche 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 à l'aide d'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 associée à 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 associée à 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 message 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 associée à 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 de l'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 associée à 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 (y compris les en-têtes) est limitée à un 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 associée à 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 (y compris les en-têtes) est limitée à un 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

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 : brouillon récemment mis à jour

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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

GmailApp.createDraft(recipient, subject, body)

`update(recipient, subject, body, options)`

Remplace le contenu de ce brouillon à 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 à un 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

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`	un objet JavaScript qui spécifie les paramètres avancés, listés ci-dessous ;

Paramètres avancés

Nom	Type	Description
`attachments`	`BlobSource[]`	Tableau de fichiers à envoyer avec l'adresse e-mail
`bcc`	`String`	d'une liste d'adresses e-mail séparées par une virgule en Cci
`cc`	`String`	d'une liste d'adresses e-mail séparées par une virgule en copie
`from`	`String`	Adresse à partir de laquelle l'e-mail doit être envoyé, qui doit correspondre à l'une des valeurs renvoyées par `GmailApp.getAliases()`
`htmlBody`	`String`	Si cette valeur est définie, les appareils capables d'afficher le code HTML l'utiliseront à la place de l'argument obligatoire du corps. Vous pouvez ajouter un champ facultatif `inlineImages` dans le corps HTML si vous avez intégré des images à votre e-mail
`inlineImages`	`Object`	Objet JavaScript contenant un mappage entre clé d'image (`String`) et 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" />`
`name`	`String`	Nom de l'expéditeur de l'e-mail (par défaut: le nom de l'utilisateur)
`replyTo`	`String`	Une adresse e-mail à utiliser comme adresse de réponse par défaut (par défaut: l'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 associée à 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

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