Class: Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2EmailTemplate

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

Overview

Email template. The subject and body fields can contain the following placeholders which will be replaced with the appropriate values: %LINK% - The link to use to redeem the send OOB code. %EMAIL% - The email where the email is being sent. %NEW_EMAIL% - The new email being set for the account (when applicable). %APP_NAME% - The GCP project's display name. %DISPLAY_NAME% - The user's display name.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitAdminV2EmailTemplate

Returns a new instance of GoogleCloudIdentitytoolkitAdminV2EmailTemplate.



488
489
490
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 488

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

Instance Attribute Details

#body ⇒ String

Email body Corresponds to the JSON property body

Returns:

  • (String) 


455
456
457
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 455

def body
  @body
end

#body_format ⇒ String

Email body format Corresponds to the JSON property bodyFormat

Returns:

  • (String) 


460
461
462
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 460

def body_format
  @body_format
end

#customized ⇒ Boolean Also known as: customized?

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

Returns:

  • (Boolean) 


465
466
467
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 465

def customized
  @customized
end

#reply_to ⇒ String

Reply-to address Corresponds to the JSON property replyTo

Returns:

  • (String) 


471
472
473
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 471

def reply_to
  @reply_to
end

#sender_display_name ⇒ String

Sender display name Corresponds to the JSON property senderDisplayName

Returns:

  • (String) 


476
477
478
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 476

def sender_display_name
  @sender_display_name
end

#sender_local_part ⇒ String

Local part of From address Corresponds to the JSON property senderLocalPart

Returns:

  • (String) 


481
482
483
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 481

def sender_local_part
  @sender_local_part
end

#subject ⇒ String

Subject of the email Corresponds to the JSON property subject

Returns:

  • (String) 


486
487
488
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 486

def subject
  @subject
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



493
494
495
496
497
498
499
500
501
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 493

def update!(**args)
  @body = args[:body] if args.key?(:body)
  @body_format = args[:body_format] if args.key?(:body_format)
  @customized = args[:customized] if args.key?(:customized)
  @reply_to = args[:reply_to] if args.key?(:reply_to)
  @sender_display_name = args[:sender_display_name] if args.key?(:sender_display_name)
  @sender_local_part = args[:sender_local_part] if args.key?(:sender_local_part)
  @subject = args[:subject] if args.key?(:subject)
end