Class: Google::Apis::GmailV1::VacationSettings

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/gmail_v1/classes.rb,
generated/google/apis/gmail_v1/representations.rb,
generated/google/apis/gmail_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ VacationSettings

Returns a new instance of VacationSettings.


1270
1271
1272
# File 'generated/google/apis/gmail_v1/classes.rb', line 1270

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#enable_auto_replyBoolean Also known as: enable_auto_reply?

Flag that controls whether Gmail automatically replies to messages. Corresponds to the JSON property enableAutoReply

Returns:

  • (Boolean)

1220
1221
1222
# File 'generated/google/apis/gmail_v1/classes.rb', line 1220

def enable_auto_reply
  @enable_auto_reply
end

#end_timeString

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. Corresponds to the JSON property endTime

Returns:

  • (String)

1229
1230
1231
# File 'generated/google/apis/gmail_v1/classes.rb', line 1229

def end_time
  @end_time
end

#response_body_htmlString

Response body in HTML format. Gmail will sanitize the HTML before storing it. Corresponds to the JSON property responseBodyHtml

Returns:

  • (String)

1234
1235
1236
# File 'generated/google/apis/gmail_v1/classes.rb', line 1234

def response_body_html
  @response_body_html
end

#response_body_plain_textString

Response body in plain text format. Corresponds to the JSON property responseBodyPlainText

Returns:

  • (String)

1239
1240
1241
# File 'generated/google/apis/gmail_v1/classes.rb', line 1239

def response_body_plain_text
  @response_body_plain_text
end

#response_subjectString

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. Corresponds to the JSON property responseSubject

Returns:

  • (String)

1246
1247
1248
# File 'generated/google/apis/gmail_v1/classes.rb', line 1246

def response_subject
  @response_subject
end

#restrict_to_contactsBoolean Also known as: restrict_to_contacts?

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

Returns:

  • (Boolean)

1252
1253
1254
# File 'generated/google/apis/gmail_v1/classes.rb', line 1252

def restrict_to_contacts
  @restrict_to_contacts
end

#restrict_to_domainBoolean Also known as: restrict_to_domain?

Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Apps users. Corresponds to the JSON property restrictToDomain

Returns:

  • (Boolean)

1259
1260
1261
# File 'generated/google/apis/gmail_v1/classes.rb', line 1259

def restrict_to_domain
  @restrict_to_domain
end

#start_timeString

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. Corresponds to the JSON property startTime

Returns:

  • (String)

1268
1269
1270
# File 'generated/google/apis/gmail_v1/classes.rb', line 1268

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
# File 'generated/google/apis/gmail_v1/classes.rb', line 1275

def update!(**args)
  @enable_auto_reply = args[:enable_auto_reply] if args.key?(:enable_auto_reply)
  @end_time = args[:end_time] if args.key?(:end_time)
  @response_body_html = args[:response_body_html] if args.key?(:response_body_html)
  @response_body_plain_text = args[:response_body_plain_text] if args.key?(:response_body_plain_text)
  @response_subject = args[:response_subject] if args.key?(:response_subject)
  @restrict_to_contacts = args[:restrict_to_contacts] if args.key?(:restrict_to_contacts)
  @restrict_to_domain = args[:restrict_to_domain] if args.key?(:restrict_to_domain)
  @start_time = args[:start_time] if args.key?(:start_time)
end