VacationSettings
Stay organized with collections
Save and categorize content based on your preferences.
Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface.
| JSON representation |
{
"enableAutoReply": boolean,
"responseSubject": string,
"responseBodyPlainText": string,
"responseBodyHtml": string,
"restrictToContacts": boolean,
"restrictToDomain": boolean,
"startTime": string,
"endTime": string
} |
| Fields |
enableAutoReply |
boolean
Flag that controls whether Gmail automatically replies to messages.
|
responseSubject |
string
Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
|
responseBodyPlainText |
string
Response body in plain text format. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
|
responseBodyHtml |
string
Response body in HTML format. Gmail will sanitize the HTML before storing it. If both responseBodyPlainText and responseBodyHtml are specified, responseBodyHtml will be used.
|
restrictToContacts |
boolean
Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
|
restrictToDomain |
boolean
Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.
|
startTime |
string (int64 format)
An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both startTime and endTime are specified, startTime must precede endTime.
|
endTime |
string (int64 format)
An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both startTime and endTime are specified, startTime must precede endTime.
|
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 2025-03-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# VacationSettings\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nVacation auto-reply settings for an account. These settings correspond to the [\"Vacation responder\"](https://support.google.com/mail/answer/25922) feature in the web interface.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"enableAutoReply\": boolean, \"responseSubject\": string, \"responseBodyPlainText\": string, \"responseBodyHtml\": string, \"restrictToContacts\": boolean, \"restrictToDomain\": boolean, \"startTime\": string, \"endTime\": string } ``` |\n\n| Fields ||\n|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `enableAutoReply` | `boolean` Flag that controls whether Gmail automatically replies to messages. |\n| `responseSubject` | `string` Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty. |\n| `responseBodyPlainText` | `string` Response body in plain text format. If both `responseBodyPlainText` and `responseBodyHtml` are specified, `responseBodyHtml` will be used. |\n| `responseBodyHtml` | `string` Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `responseBodyPlainText` and `responseBodyHtml` are specified, `responseBodyHtml` will be used. |\n| `restrictToContacts` | `boolean` Flag that determines whether responses are sent to recipients who are not in the user's list of contacts. |\n| `restrictToDomain` | `boolean` Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users. |\n| `startTime` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`. |\n| `endTime` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`. |"]]
