Get Vacation
|
|||||
|
|
||||
Gets vacation responder settings
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Read, compose, send, and permanently delete all your email from Gmail
- View and modify but not delete your email
- View your email messages and settings
- Manage your basic mail settings
Input
This building block consumes 1 input parameters
| Name | Format | Description |
|---|---|---|
userId Required |
STRING |
User's email address. The special value "me" can be used to indicate the authenticated user |
= Parameter name
= Format
|
userId STRING Required User's email address. The special value "me" can be used to indicate the authenticated user |
Output
This building block provides 8 output parameters
| Name | Format | Description |
|---|---|---|
enableAutoReply |
BOOLEAN |
Flag that controls whether Gmail automatically replies to messages |
endTime |
INTEGER |
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 |
responseBodyHtml |
STRING |
Response body in HTML format. Gmail will sanitize the HTML before storing it |
responseBodyPlainText |
STRING |
Response body in plain text format |
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 |
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 G Suite users |
startTime |
INTEGER |
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 |
= Parameter name
= Format
|
enableAutoReply BOOLEAN Flag that controls whether Gmail automatically replies to messages |
|
endTime INTEGER 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 |
|
responseBodyHtml STRING Response body in HTML format. Gmail will sanitize the HTML before storing it |
|
responseBodyPlainText STRING Response body in plain text format |
|
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 |
|
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 G Suite users |
|
startTime INTEGER 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 |