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

Constructor Details

#initialize(**args) ⇒ VacationSettings

Returns a new instance of VacationSettings.



1533
1534
1535
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1533

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) 


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

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) 


1489
1490
1491
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1489

def end_time
  @end_time
end

#response_body_html ⇒ String

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

Returns:

  • (String) 


1496
1497
1498
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1496

def response_body_html
  @response_body_html
end

#response_body_plain_text ⇒ String

Response body in plain text format. If both response_body_plain_text and response_body_html are specified, response_body_html will be used. Corresponds to the JSON property responseBodyPlainText

Returns:

  • (String) 


1502
1503
1504
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1502

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) 


1509
1510
1511
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1509

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) 


1515
1516
1517
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1515

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) 


1522
1523
1524
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1522

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) 


1531
1532
1533
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1531

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
 
# File 'generated/google/apis/gmail_v1/classes.rb', line 1538

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