Dans un module complémentaire Google Workspace, vous pouvez créer des widgets associés à des actions. Vous pouvez utiliser une action pour rédiger des brouillons d'e-mails, en les remplissant éventuellement à l'aide des informations saisies dans l'interface utilisateur du module complémentaire ou des informations d'un message ouvert. Par exemple, vous pouvez ajouter un bouton dans l'interface utilisateur des messages de votre module complémentaire qui crée une réponse au message actuellement ouvert, prérempli d'informations provenant du module complémentaire.
Lorsqu'une action qui crée des messages est déclenchée, Gmail exécute une fonction de rappel pour créer et renvoyer le brouillon. Gmail affiche ensuite ce brouillon dans son UI dans une fenêtre de rédaction d'e-mail standard, que l'utilisateur peut ensuite modifier et envoyer si nécessaire.
Configurer une action pour créer un brouillon de message
Pour configurer un widget de sorte qu'il lance une action de création de brouillon lorsqu'il est sélectionné, procédez comme suit:
Assurez-vous que votre fichier manifeste inclut le champ d'application
action.compose
:https://www.googleapis.com/auth/gmail.addons.current.action.compose
Vous pouvez utiliser un champ d'application plus permissif, mais ne le faites que si ce champ est absolument nécessaire.
Créez un objet
Action
et associez-le à une fonction de rappel que vous définissez.Appelez la fonction de gestionnaire de widget
setComposeAction()
du widget, en lui fournissant l'objetAction
et en spécifiantComposeEmailType
.Implémentez la fonction de rappel qui exécute l'action de création de brouillon. Cette fonction reçoit un objet d'événement en tant qu'argument. La fonction de rappel doit effectuer les opérations suivantes:
- Créez un objet
GmailDraft
. - Créez un objet
ComposeActionResponse
à l'aide de la classeComposeActionResponseBuilder
et de l'objetGmailDraft
. - Renvoyez l'
ComposeActionResponse
compilé.
- Créez un objet
Vous pouvez préremplir l'objet GmailDraft
que vous créez dans la fonction de rappel avec des destinataires, un objet, un corps de message et des pièces jointes. Pour remplir le brouillon, les données peuvent provenir de n'importe quelle source, mais elles proviennent généralement des informations fournies au module complémentaire lui-même, des informations du message ouvert ou des informations collectées auprès d'un service tiers. L'objet d'événement transmis à la fonction de rappel contient l'ID du message ouvert et d'autres informations sur le module complémentaire que vous pouvez utiliser pour préremplir le brouillon.
Vous pouvez créer le brouillon en tant que nouveau message autonome ou en tant que réponse à un message existant. Ce paramètre est contrôlé par l'énumération ComposeEmailType
attribuée à setComposeAction()
.
Vous pouvez créer des brouillons de réponse en tant que réponses individuelles ou en tant que messages de réponse à tous.
Suggestions autonomes
Un brouillon autonome démarre un nouveau fil de discussion et ne répond à aucun message existant. Vous pouvez créer un brouillon autonome à l'aide de l'une des fonctions du service Gmail suivantes:
GmailApp.createDraft(recipient, subject, body)
GmailApp.createDraft(recipient, subject, body, options)
Brouillons de réponses
Un brouillon de réponse fait partie d'un fil de discussion existant. Les brouillons de réponse sont des réponses uniques qui ne sont envoyées qu'à l'expéditeur d'un message ou des brouillons de réponse "Répondre à tous" qui sont envoyés à tous les destinataires de ce message. Vous pouvez créer un brouillon de réponse à l'aide de l'une des fonctions du service Gmail suivantes:
GmailMessage.createDraftReply(body)
GmailMessage.createDraftReply(body, options)
GmailMessage.createDraftReplyAll(body)
GmailMessage.createDraftReplyAll(body, options)
GmailThread.createDraftReply(body)
GmailThread.createDraftReply(body, options)
GmailThread.createDraftReplyAll(body)
GmailThread.createDraftReplyAll(body, options)
Exemple
L'extrait de code suivant montre comment attribuer une action qui crée un brouillon de réponse à un bouton.
var composeAction = CardService.newAction()
.setFunctionName('createReplyDraft');
var composeButton = CardService.newTextButton()
.setText('Compose Reply')
.setComposeAction(
composeAction,
CardService.ComposedEmailType.REPLY_AS_DRAFT);
// ...
/**
* Creates a draft email (with an attachment and inline image)
* as a reply to an existing message.
* @param {Object} e An event object passed by the action.
* @return {ComposeActionResponse}
*/
function createReplyDraft(e) {
// Activate temporary Gmail scopes, in this case to allow
// a reply to be drafted.
var accessToken = e.gmail.accessToken;
GmailApp.setCurrentMessageAccessToken(accessToken);
// Creates a draft reply.
var messageId = e.gmail.messageId;
var message = GmailApp.getMessageById(messageId);
var draft = message.createDraftReply('',
{
htmlBody: "Kitten! <img src='cid:kitten'/>",
attachments: [
UrlFetchApp.fetch('https://example.com/images/myDog.jpg')
.getBlob()
],
inlineImages: {
"kitten": UrlFetchApp.fetch('https://example.com/images/myKitten.jpg')
.getBlob()
}
}
);
// Return a built draft response. This causes Gmail to present a
// compose window to the user, pre-filled with the content specified
// above.
return CardService.newComposeActionResponseBuilder()
.setGmailDraft(draft).build();
}