Taslak ileti oluşturma
Koleksiyonlar ile düzeninizi koruyun
İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.
Eklentinizin, kullanıcının şu anda görüntülediği bir taslağı değiştirmesini istiyorsanız bunun yerine
oluşturma kullanıcı arayüzünü genişletin.
Google Workspace eklentilerinde, bağlı işlemler içeren widget'lar oluşturabilirsiniz. Yeni e-posta taslakları oluşturmak için bir işlem kullanabilir, bunları isteğe bağlı olarak eklenti kullanıcı arayüzüne girilen bilgiler veya açık bir iletideki bilgilerle doldurabilirsiniz.
Örneğin, eklentinizin mesaj kullanıcı arayüzünde, şu anda açık olan mesaja eklentideki bilgilerle önceden doldurulmuş bir yanıt oluşturan bir düğme olabilir.
İleti oluşturan bir işlem tetiklendiğinde Gmail, taslağı oluşturup döndürmek için bir geri çağırma işlevi yürütür. Gmail, bu taslağı kullanıcı arayüzünde standart bir e-posta yazma penceresinde gösterir. Kullanıcı daha sonra bu taslağı düzenleyip gerektiği gibi gönderebilir.
Taslak ileti oluşturma işlemini yapılandırma
Seçildiğinde taslak oluşturma işlemini başlatacak bir widget yapılandırmak için aşağıdakileri yapmanız gerekir:
Manifest dosyanızın action.compose
kapsamını içerdiğinden emin olun:
https://www.googleapis.com/auth/gmail.addons.current.action.compose
Bunun yerine daha izin verici bir kapsam kullanabilirsiniz ancak bunu yalnızca bu kapsam kesinlikle gerekliyse yapmalısınız.
Bir Action
nesnesi oluşturun ve bunu tanımladığınız bir geri çağırma işleviyle ilişkilendirin.
setComposeAction()
widget işleyici işlevini çağırın,
Action
nesnesini sağlayın ve ComposeEmailType
'ı belirtin.
Taslak oluşturma işlemini yürüten geri çağırma işlevini uygulayın. Bu işlev, bağımsız değişken olarak bir etkinlik nesnesi alır. Geri çağırma işlevi şunları yapmalıdır:
GmailDraft
nesnesi oluşturun.
ComposeActionResponseBuilder
sınıfını ve GmailDraft
nesnesini kullanarak bir ComposeActionResponse
nesnesi oluşturun.
- Oluşturulan
ComposeActionResponse
öğesini döndürür.
Geri çağırma işlevinde oluşturduğunuz GmailDraft
iletiyi alıcılar, konu, ileti gövdesi ve eklerle önceden doldurabilirsiniz. Taslağı doldurmak için veriler herhangi bir kaynaktan gelebilir ancak genellikle eklentinin kendisine sağlanan bilgilerden, açık iletideki bilgilerden veya üçüncü taraf hizmetinden toplanan bilgilerden elde edilir. Geri çağırma işlevine iletilen event object, açık mesaj kimliğini ve taslağı önceden doldurmak için kullanabileceğiniz diğer eklenti bilgilerini içerir.
Taslağı yeni bir bağımsız mesaj veya mevcut bir mesaja yanıt olarak oluşturabilirsiniz. Bu, setComposeAction()
öğesine verilen ComposeEmailType
numaralandırmasıyla kontrol edilir.
Yanıt taslaklarını tek yanıt veya "tümünü yanıtla" mesajı olarak oluşturabilirsiniz.
Bağımsız taslaklar
Bağımsız bir taslak, yeni bir ileti dizisi başlatır ve mevcut bir iletiye yanıt değildir. Aşağıdaki Gmail hizmeti işlevlerinden birini kullanarak bağımsız bir taslak oluşturabilirsiniz:
Yanıt taslakları
Yanıt taslağı, mevcut bir mesaj dizisinin parçasıdır. Yanıt taslakları, yalnızca iletinin gönderenine gönderilen tek yanıtlar veya iletiyi alan herkese gönderilen "tümünü yanıtla" taslaklarıdır. Şu Gmail hizmeti işlevlerinden birini kullanarak yanıt taslağı oluşturabilirsiniz:
Örnek
Aşağıdaki kod snippet'inde, yanıta taslağı oluşturan bir işlemin düğmeye nasıl atanacağı gösterilmektedir.
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();
}
Aksi belirtilmediği sürece bu sayfanın içeriği Creative Commons Atıf 4.0 Lisansı altında ve kod örnekleri Apache 2.0 Lisansı altında lisanslanmıştır. Ayrıntılı bilgi için Google Developers Site Politikaları'na göz atın. Java, Oracle ve/veya satış ortaklarının tescilli ticari markasıdır.
Son güncelleme tarihi: 2025-07-25 UTC.
[null,null,["Son güncelleme tarihi: 2025-07-25 UTC."],[[["\u003cp\u003eThis guide explains how to use Google Workspace add-ons to create new email drafts prefilled with information from the add-on or the currently open message.\u003c/p\u003e\n"],["\u003cp\u003eAdd-ons achieve this functionality by using actions associated with widgets like buttons, triggering callback functions to build and return drafts.\u003c/p\u003e\n"],["\u003cp\u003eTo implement this, you need to include a specific scope in your manifest, create an action object with a callback function, and configure the widget to trigger the action.\u003c/p\u003e\n"],["\u003cp\u003eThe callback function creates a GmailDraft object, builds a ComposeActionResponse, and can prefill the draft with data from various sources.\u003c/p\u003e\n"],["\u003cp\u003eDrafts can be created as standalone messages or replies (single or reply-all) using corresponding Gmail service functions.\u003c/p\u003e\n"]]],["Google Workspace add-ons can create new email drafts via linked actions in widgets. To configure this, the manifest needs the `action.compose` scope. A widget's `setComposeAction()` method links an `Action` object and `ComposeEmailType` to a callback function. This function generates a `GmailDraft` object using a `ComposeActionResponseBuilder`, which is then returned to populate the draft in Gmail's UI. Drafts can be standalone or replies, prefilled with data from various sources, including the event object.\n"],null,["# Composing draft messages\n\n| **Note:** The techniques described in this guide are primarily for creating new draft messages in response to user interactions in a [message UI](/workspace/add-ons/gmail/extending-message-ui). If you want your add-on to alter a draft the user is currently viewing, [extend the compose UI](/workspace/add-ons/gmail/extending-compose-ui) instead.\n\nIn a Google Workspace add-on you can create [widgets](/workspace/add-ons/concepts/widgets)\nthat have linked [actions](/workspace/add-ons/concepts/actions). You can use\nan action to compose new email drafts, optionally filling them using\ninformation entered into the add-on UI or information from an open message.\nFor example, you can have a button in your\n[add-on's message UI](/workspace/add-ons/gmail/extending-message-ui)\nthat creates a reply to the currently opened message prepopulated with\ninformation from the add-on.\n\nWhen an action that builds messages is triggered, Gmail executes a callback\nfunction to build and return the draft. Gmail then displays that draft in its\nUI in a standard email compose window, which the user can then edit and send\nas needed.\n\nConfiguring an action to build a draft message\n----------------------------------------------\n\nTo configure a widget to start a draft-building action when selected, you must\ndo the following:\n\n1. Make sure your [manifest](/workspace/add-ons/concepts/workspace-manifests#manifest_structure_for_g_suite_add-ons)\n includes the\n [`action.compose` scope](/workspace/add-ons/concepts/workspace-scopes#gmail_add-on_scopes):\n\n `https://www.googleapis.com/auth/gmail.addons.current.action.compose`\n\n You can use more a permissive scope instead, but should only do so if\n that scope is absolutely necessary.\n2. Create an [`Action`](/apps-script/reference/card-service/action) object\n and associate it with a [callback function](/workspace/add-ons/concepts/actions#callback_functions)\n you define.\n\n3. Call the widget's [`setComposeAction()`](/apps-script/reference/card-service/button#setComposeAction(Action,ComposedEmailType))\n [widget handler function](/workspace/add-ons/concepts/actions#widget_handler_functions),\n providing it the [`Action`](/apps-script/reference/card-service/action)\n object and specifying the\n [`ComposeEmailType`](/apps-script/reference/card-service/composed-email-type).\n\n4. Implement the callback function that executes the draft-building action. This\n function is given an [event object](/workspace/add-ons/concepts/actions#action_event_objects)\n as an argument. The callback function must do the following:\n\n 1. Create a [`GmailDraft`](/apps-script/reference/gmail/gmail-draft) object.\n 2. Build a [`ComposeActionResponse`](/apps-script/reference/card-service/compose-action-response) object using the [`ComposeActionResponseBuilder`](/apps-script/reference/card-service/compose-action-response-builder) class and the [`GmailDraft`](/apps-script/reference/gmail/gmail-draft) object.\n 3. Return the built [`ComposeActionResponse`](/apps-script/reference/card-service/compose-action-response).\n\nYou can prefill the [`GmailDraft`](/apps-script/reference/gmail/gmail-draft)\nyou create in the callback function with\nrecipients, a subject, a message body, and attachments. To fill in the draft,\ndata can come from any source, but typically it derives from information\nprovided to the add-on itself, information in the open message, or\ninformation gathered from a third-party service. The\n[event object](/workspace/add-ons/concepts/event-objects)\npassed to the callback function contains the open message ID and other add-on\ninformation you can use to prefill the draft.\n\nYou can create the draft as a new standalone message or a reply to\nan existing message. This is controlled by the\n[`ComposeEmailType`](/apps-script/reference/card-service/composed-email-type)\nenum given to the\n[`setComposeAction()`](/apps-script/reference/card-service/button#setComposeAction(Action,ComposedEmailType)).\nYou can create reply drafts as single replies or 'reply-all' messages.\n\n### Standalone drafts\n\nA standalone draft starts a new thread and isn't a reply to any existing\nmessage. You can create a standalone draft with one of the following\n[Gmail service](/apps-script/reference/gmail) functions:\n\n- [`GmailApp.createDraft(recipient, subject, body)`](/apps-script/reference/gmail/gmail-app#createDraft(String,String,String))\n- [`GmailApp.createDraft(recipient, subject, body, options)`](/apps-script/reference/gmail/gmail-app#createdraftrecipient-subject-body-options)\n\n### Reply drafts\n\nA reply draft is part of an existing message thread. Reply drafts are either\nsingle replies that only get sent to the sender of a message or \"reply all\"\ndrafts that get sent to everyone who received that message. You can create a\nreply draft with one of these [Gmail service](/apps-script/reference/gmail)\nfunctions:\n\n- [`GmailMessage.createDraftReply(body)`](/apps-script/reference/gmail/gmail-message#createdraftreplybody)\n- [`GmailMessage.createDraftReply(body, options)`](/apps-script/reference/gmail/gmail-message#createdraftreplybody-options)\n- [`GmailMessage.createDraftReplyAll(body)`](/apps-script/reference/gmail/gmail-message#createdraftreplyallbody)\n- [`GmailMessage.createDraftReplyAll(body, options)`](/apps-script/reference/gmail/gmail-message#createdraftreplyallbody-options)\n- [`GmailThread.createDraftReply(body)`](/apps-script/reference/gmail/gmail-thread#createdraftreplybody)\n- [`GmailThread.createDraftReply(body, options)`](/apps-script/reference/gmail/gmail-thread#createdraftreplybody-options)\n- [`GmailThread.createDraftReplyAll(body)`](/apps-script/reference/gmail/gmail-thread#createdraftreplyallbody)\n- [`GmailThread.createDraftReplyAll(body, options)`](/apps-script/reference/gmail/gmail-thread#createdraftreplyallbody-options)\n\nExample\n-------\n\nThe following code snippet shows how to assign an action that builds a reply\ndraft to a button. \n\n var composeAction = CardService.newAction()\n .setFunctionName('createReplyDraft');\n var composeButton = CardService.newTextButton()\n .setText('Compose Reply')\n .setComposeAction(\n composeAction,\n CardService.ComposedEmailType.REPLY_AS_DRAFT);\n\n // ...\n\n /**\n * Creates a draft email (with an attachment and inline image)\n * as a reply to an existing message.\n * @param {Object} e An event object passed by the action.\n * @return {ComposeActionResponse}\n */\n function createReplyDraft(e) {\n // Activate temporary Gmail scopes, in this case to allow\n // a reply to be drafted.\n var accessToken = e.gmail.accessToken;\n GmailApp.setCurrentMessageAccessToken(accessToken);\n\n // Creates a draft reply.\n var messageId = e.gmail.messageId;\n var message = GmailApp.getMessageById(messageId);\n var draft = message.createDraftReply('',\n {\n htmlBody: \"Kitten! \u003cimg src='cid:kitten'/\u003e\",\n attachments: [\n UrlFetchApp.fetch('https://example.com/images/myDog.jpg')\n .getBlob()\n ],\n inlineImages: {\n \"kitten\": UrlFetchApp.fetch('https://example.com/images/myKitten.jpg')\n .getBlob()\n }\n }\n );\n\n // Return a built draft response. This causes Gmail to present a\n // compose window to the user, pre-filled with the content specified\n // above.\n return CardService.newComposeActionResponseBuilder()\n .setGmailDraft(draft).build();\n }"]]