com.google.api.services.gmail.model

Class VacationSettings

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.gmail.model.VacationSettings

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class VacationSettings
extends com.google.api.client.json.GenericJson

Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Gmail API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
VacationSettings()

Method Summary

Modifier and Type	Method and Description
VacationSettings	clone()
Boolean	getEnableAutoReply() Flag that controls whether Gmail automatically replies to messages.
Long	getEndTime() An optional end time for sending auto-replies (epoch ms).
String	getResponseBodyHtml() Response body in HTML format.
String	getResponseBodyPlainText() Response body in plain text format.
String	getResponseSubject() Optional text to prepend to the subject line in vacation responses.
Boolean	getRestrictToContacts() Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
Boolean	getRestrictToDomain() Flag that determines whether responses are sent to recipients who are outside of the user's domain.
Long	getStartTime() An optional start time for sending auto-replies (epoch ms).
VacationSettings	set(String fieldName, Object value)
VacationSettings	setEnableAutoReply(Boolean enableAutoReply) Flag that controls whether Gmail automatically replies to messages.
VacationSettings	setEndTime(Long endTime) An optional end time for sending auto-replies (epoch ms).
VacationSettings	setResponseBodyHtml(String responseBodyHtml) Response body in HTML format.
VacationSettings	setResponseBodyPlainText(String responseBodyPlainText) Response body in plain text format.
VacationSettings	setResponseSubject(String responseSubject) Optional text to prepend to the subject line in vacation responses.
VacationSettings	setRestrictToContacts(Boolean restrictToContacts) Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
VacationSettings	setRestrictToDomain(Boolean restrictToDomain) Flag that determines whether responses are sent to recipients who are outside of the user's domain.
VacationSettings	setStartTime(Long startTime) An optional start time for sending auto-replies (epoch ms).

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

VacationSettings

public VacationSettings()

Method Detail

getEnableAutoReply

public Boolean getEnableAutoReply()

Flag that controls whether Gmail automatically replies to messages.

Returns:

value or null for none

setEnableAutoReply

public VacationSettings setEnableAutoReply(Boolean enableAutoReply)

Flag that controls whether Gmail automatically replies to messages.

Parameters:

enableAutoReply - enableAutoReply or null for none

getEndTime

public Long getEndTime()

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`.

Returns:

value or null for none

setEndTime

public VacationSettings setEndTime(Long endTime)

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`.

Parameters:

endTime - endTime or null for none

getResponseBodyHtml

public String getResponseBodyHtml()

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.

Returns:

value or null for none

setResponseBodyHtml

public VacationSettings setResponseBodyHtml(String responseBodyHtml)

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.

Parameters:

responseBodyHtml - responseBodyHtml or null for none

getResponseBodyPlainText

public String getResponseBodyPlainText()

Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.

Returns:

value or null for none

setResponseBodyPlainText

public VacationSettings setResponseBodyPlainText(String responseBodyPlainText)

Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.

Parameters:

responseBodyPlainText - responseBodyPlainText or null for none

getResponseSubject

public String getResponseSubject()

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.

Returns:

value or null for none

setResponseSubject

public VacationSettings setResponseSubject(String responseSubject)

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.

Parameters:

responseSubject - responseSubject or null for none

getRestrictToContacts

public Boolean getRestrictToContacts()

Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.

Returns:

value or null for none

setRestrictToContacts

public VacationSettings setRestrictToContacts(Boolean restrictToContacts)

Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.

Parameters:

restrictToContacts - restrictToContacts or null for none

getRestrictToDomain

public Boolean getRestrictToDomain()

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.

Returns:

value or null for none

setRestrictToDomain

public VacationSettings setRestrictToDomain(Boolean restrictToDomain)

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.

Parameters:

restrictToDomain - restrictToDomain or null for none

getStartTime

public Long getStartTime()

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`.

Returns:

value or null for none

setStartTime

public VacationSettings setStartTime(Long startTime)

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`.

Parameters:

startTime - startTime or null for none

set

public VacationSettings set(String fieldName,
                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public VacationSettings clone()

Overrides:

clone in class com.google.api.client.json.GenericJson