Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1EmailTemplate

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

Overview

Email template

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1EmailTemplate

Returns a new instance of GoogleCloudIdentitytoolkitV1EmailTemplate.



625
626
627
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 625

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

Instance Attribute Details

#body ⇒ String

Email body Corresponds to the JSON property body

Returns:

  • (String) 


575
576
577
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 575

def body
  @body
end

#customized ⇒ Boolean Also known as: customized?

Whether the body or subject of the email is customized. Corresponds to the JSON property customized

Returns:

  • (Boolean) 


580
581
582
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 580

def customized
  @customized
end

#disabled ⇒ Boolean Also known as: disabled?

Whether the template is disabled. If true, a default template will be used. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


586
587
588
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 586

def disabled
  @disabled
end

#format ⇒ String

Email body format Corresponds to the JSON property format

Returns:

  • (String) 


592
593
594
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 592

def format
  @format
end

#from ⇒ String

From address of the email Corresponds to the JSON property from

Returns:

  • (String) 


597
598
599
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 597

def from
  @from
end

#from_display_name ⇒ String

From display name Corresponds to the JSON property fromDisplayName

Returns:

  • (String) 


602
603
604
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 602

def from_display_name
  @from_display_name
end

#from_local_part ⇒ String

Local part of From address Corresponds to the JSON property fromLocalPart

Returns:

  • (String) 


607
608
609
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 607

def from_local_part
  @from_local_part
end

#locale ⇒ String

Value is in III language code format (e.g. "zh-CN", "es"). Both '-' and '_' separators are accepted. Corresponds to the JSON property locale

Returns:

  • (String) 


613
614
615
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 613

def locale
  @locale
end

#reply_to ⇒ String

Reply-to address Corresponds to the JSON property replyTo

Returns:

  • (String) 


618
619
620
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 618

def reply_to
  @reply_to
end

#subject ⇒ String

Subject of the email Corresponds to the JSON property subject

Returns:

  • (String) 


623
624
625
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 623

def subject
  @subject
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 630

def update!(**args)
  @body = args[:body] if args.key?(:body)
  @customized = args[:customized] if args.key?(:customized)
  @disabled = args[:disabled] if args.key?(:disabled)
  @format = args[:format] if args.key?(:format)
  @from = args[:from] if args.key?(:from)
  @from_display_name = args[:from_display_name] if args.key?(:from_display_name)
  @from_local_part = args[:from_local_part] if args.key?(:from_local_part)
  @locale = args[:locale] if args.key?(:locale)
  @reply_to = args[:reply_to] if args.key?(:reply_to)
  @subject = args[:subject] if args.key?(:subject)
end