Updates vacation responder settings.

Scopes

You will need authorization for the https://www.googleapis.com/auth/gmail.settings.basic scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/gmail.settings.basic. You can set the scope for this method like this: gmail1 --scope <scope> users settings-update-vacation ...

Required Scalar Argument

• <user-id> (string)
  • User's email address. The special value "me" can be used to indicate the authenticated user.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

VacationSettings:
  enable-auto-reply: boolean
  end-time: string
  response-body-html: string
  response-body-plain-text: string
  response-subject: string
  restrict-to-contacts: boolean
  restrict-to-domain: boolean
  start-time: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

• -r . enable-auto-reply=true
  • Flag that controls whether Gmail automatically replies to messages.
• end-time=dolore
  • 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.
• response-body-html=amet
  • Response body in HTML format. Gmail will sanitize the HTML before storing it. If both response_body_plain_text and response_body_html are specified, response_body_html will be used.
• response-body-plain-text=ut
  • Response body in plain text format. If both response_body_plain_text and response_body_html are specified, response_body_html will be used.
• response-subject=at
  • 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.
• restrict-to-contacts=true
  • Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
• restrict-to-domain=false
  • 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.
• start-time=duo
  • 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.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

• The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
• The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
• You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
• You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

• -o out
  • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

• -p $-xgafv=string

  • V1 error format.

• -p access-token=string

  • OAuth access token.

• -p alt=string

  • Data format for response.

• -p callback=string

  • JSONP

• -p fields=string

  • Selector specifying which fields to include in a partial response.

• -p key=string

  • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

• -p oauth-token=string

  • OAuth 2.0 token for the current user.

• -p pretty-print=boolean

  • Returns response with indentations and line breaks.

• -p quota-user=string

  • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

• -p upload-type=string

  • Legacy upload protocol for media (e.g. "media", "multipart").

• -p upload-protocol=string

  • Upload protocol for media (e.g. "raw", "multipart").