Class UpdateDraftActionResponseBuilder
Stay organized with collections
Save and categorize content based on your preferences.
Detailed documentation
build()
Builds the current update draft action response and validates it.
Return
UpdateDraftActionResponse
— A validated draft action response.
Throws
Error
— if the constructed UpdateDraftActionResponse isn't valid.
setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)
setUpdateDraftBodyAction(updateDraftBodyAction)
setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)
setUpdateDraftSubjectAction(updateDraftSubjectAction)
setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)
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\u003eUpdateDraftActionResponseBuilder\u003c/code\u003e helps you create responses for actions that modify email drafts.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to set actions for updating various parts of a draft, such as the recipient list, subject, and body.\u003c/p\u003e\n"],["\u003cp\u003eYou can chain these methods together to define multiple update actions within a single response.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ebuild()\u003c/code\u003e method finalizes the response and ensures it's valid before it's used.\u003c/p\u003e\n"]]],[],null,["# Class UpdateDraftActionResponseBuilder\n\nUpdateDraftActionResponseBuilder\n\nA builder for [UpdateDraftActionResponse](/apps-script/reference/card-service/update-draft-action-response) objects. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|-------------------------------------------------------------------|\n| [build()](#build()) | [UpdateDraftActionResponse](/apps-script/reference/card-service/update-draft-action-response) | Builds the current update draft action response and validates it. |\n| [setUpdateDraftBccRecipientsAction(updateDraftBccRecipientsAction)](#setUpdateDraftBccRecipientsAction(UpdateDraftBccRecipientsAction)) | [UpdateDraftActionResponseBuilder](#) | Sets an action that updates the email Bcc recipients of a draft. |\n| [setUpdateDraftBodyAction(updateDraftBodyAction)](#setUpdateDraftBodyAction(UpdateDraftBodyAction)) | [UpdateDraftActionResponseBuilder](#) | Set an action that updates the email body of a draft. |\n| [setUpdateDraftCcRecipientsAction(updateDraftCcRecipientsAction)](#setUpdateDraftCcRecipientsAction(UpdateDraftCcRecipientsAction)) | [UpdateDraftActionResponseBuilder](#) | Sets an action that updates the Cc recipients of a draft. |\n| [setUpdateDraftSubjectAction(updateDraftSubjectAction)](#setUpdateDraftSubjectAction(UpdateDraftSubjectAction)) | [UpdateDraftActionResponseBuilder](#) | Sets an action that updates the subject line of a draft. |\n| [setUpdateDraftToRecipientsAction(updateDraftToRecipientsAction)](#setUpdateDraftToRecipientsAction(UpdateDraftToRecipientsAction)) | [UpdateDraftActionResponseBuilder](#) | Sets an action that updates the To recipients of a draft. |\n\nDetailed documentation\n----------------------\n\n### `build()`\n\nBuilds the current update draft action response and validates it.\n\n#### Return\n\n\n[UpdateDraftActionResponse](/apps-script/reference/card-service/update-draft-action-response) --- A validated draft action response.\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the constructed UpdateDraftActionResponse isn't valid.\n\n*** ** * ** ***\n\n### `set``Update``Draft``Bcc``Recipients``Action(updateDraftBccRecipientsAction)`\n\nSets an action that updates the email Bcc recipients of a draft.\n\n#### Parameters\n\n| Name | Type | Description |\n|------------------------------------------|----------------------------------------------------------------------------------------------------------|---------------------------------------------------|\n| `update``Draft``Bcc``Recipients``Action` | [UpdateDraftBccRecipientsAction](/apps-script/reference/card-service/update-draft-bcc-recipients-action) | The action that updates the draft Bcc recipients. |\n\n#### Return\n\n\n[UpdateDraftActionResponseBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Update``Draft``Body``Action(updateDraftBodyAction)`\n\nSet an action that updates the email body of a draft.\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------------------------|---------------------------------------------------------------------------------------|-----------------------------------------|\n| `update``Draft``Body``Action` | [UpdateDraftBodyAction](/apps-script/reference/card-service/update-draft-body-action) | The action that updates the draft body. |\n\n#### Return\n\n\n[UpdateDraftActionResponseBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Update``Draft``Cc``Recipients``Action(updateDraftCcRecipientsAction)`\n\nSets an action that updates the Cc recipients of a draft.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------------------------------|--------------------------------------------------------------------------------------------------------|--------------------------------------------------|\n| `update``Draft``Cc``Recipients``Action` | [UpdateDraftCcRecipientsAction](/apps-script/reference/card-service/update-draft-cc-recipients-action) | The action that updates the draft Cc recipients. |\n\n#### Return\n\n\n[UpdateDraftActionResponseBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Update``Draft``Subject``Action(updateDraftSubjectAction)`\n\nSets an action that updates the subject line of a draft.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------------------------------|---------------------------------------------------------------------------------------------|-------------------------------------------|\n| `update``Draft``Subject``Action` | [UpdateDraftSubjectAction](/apps-script/reference/card-service/update-draft-subject-action) | The action that updates the subject line. |\n\n#### Return\n\n\n[UpdateDraftActionResponseBuilder](#) --- This object, for chaining.\n\n*** ** * ** ***\n\n### `set``Update``Draft``To``Recipients``Action(updateDraftToRecipientsAction)`\n\nSets an action that updates the To recipients of a draft.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------------------------------|--------------------------------------------------------------------------------------------------------|--------------------------------------------|\n| `update``Draft``To``Recipients``Action` | [UpdateDraftToRecipientsAction](/apps-script/reference/card-service/update-draft-to-recipients-action) | The action that updates the To recipients. |\n\n#### Return\n\n\n[UpdateDraftActionResponseBuilder](#) --- This object, for chaining."]]