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.

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



1483
1484
1485
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1483

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

Instance Attribute Details

#enable_auto_reply ⇒ Boolean Also known as: enable_auto_reply?

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

Returns:

  • (Boolean) 


1433
1434
1435
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1433

def enable_auto_reply
  @enable_auto_reply
end

#end_time ⇒ Fixnum

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:

  • (Fixnum) 


1442
1443
1444
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1442

def end_time
  @end_time
end

#response_body_html ⇒ String

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

Returns:

  • (String) 


1447
1448
1449
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1447

def response_body_html
  @response_body_html
end

#response_body_plain_text ⇒ String

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

Returns:

  • (String) 


1452
1453
1454
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1452

def response_body_plain_text
  @response_body_plain_text
end

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

Returns:

  • (String) 


1459
1460
1461
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1459

def response_subject
  @response_subject
end

#restrict_to_contacts ⇒ Boolean 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) 


1465
1466
1467
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1465

def restrict_to_contacts
  @restrict_to_contacts
end

#restrict_to_domain ⇒ Boolean 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 G Suite users. Corresponds to the JSON property restrictToDomain

Returns:

  • (Boolean) 


1472
1473
1474
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1472

def restrict_to_domain
  @restrict_to_domain
end

#start_time ⇒ Fixnum

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:

  • (Fixnum) 


1481
1482
1483
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1481

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1488

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