Class ComposeActionResponse
Stay organized with collections
Save and categorize content based on your preferences.
ComposeActionResponse
The response object that may be returned from a callback method for compose action in a Gmail add-on.
const composeActionResponse =
CardService.newComposeActionResponseBuilder()
.setGmailDraft(GmailApp.createDraft('recipient', 'subject', 'body'))
.build();
Methods
| Method | Return type | Brief description |
printJson() | String | Prints the JSON representation of this object. |
Detailed documentation
printJson()
Prints the JSON representation of this object. This is for debugging only.
Return
String
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eComposeActionResponse\u003c/code\u003e is used specifically for responses from callback methods that handle compose actions in Gmail add-ons.\u003c/p\u003e\n"],["\u003cp\u003eIt's crucial to understand that this object is for actions that create draft messages, not for actions used for extending the compose UI.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers use this object to structure the response when a UI element triggers a compose action, allowing the add-on to pre-fill a Gmail draft.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eprintJson()\u003c/code\u003e method assists in debugging by displaying the object's JSON representation.\u003c/p\u003e\n"]]],[],null,["# Class ComposeActionResponse\n\nComposeActionResponse\n\nThe response object that may be returned from a callback method for compose action in a [Gmail add-on](/gmail/add-ons).\n\n\n| **Note** : This object isn't related to **compose actions** that are used to [extend the compose UI](/gmail/add-ons/how-tos/extending-compose-ui). Rather, this object is a response to an [Action](/apps-script/reference/card-service/action) that [composes draft messages](/gmail/add-ons/how-tos/compose) when a specific UI element is selected.\n\n\u003cbr /\u003e\n\n```javascript\nconst composeActionResponse =\n CardService.newComposeActionResponseBuilder()\n .setGmailDraft(GmailApp.createDraft('recipient', 'subject', 'body'))\n .build();\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------|-------------|------------------------------------------------|\n| [printJson()](#printJson()) | `String` | Prints the JSON representation of this object. |\n\nDetailed documentation\n----------------------\n\n### `print``Json()`\n\nPrints the JSON representation of this object. This is for debugging only.\n\n#### Return\n\n\n`String`"]]
