Class: Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2SendEmail

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

Options for email sending.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitAdminV2SendEmail

Returns a new instance of GoogleCloudIdentitytoolkitAdminV2SendEmail.



1630
1631
1632
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1630

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

Instance Attribute Details

#callback_uri ⇒ String

action url in email template. Corresponds to the JSON property callbackUri

Returns:

  • (String) 


1562
1563
1564
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1562

def callback_uri
  @callback_uri
end

#change_email_template ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2EmailTemplate

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

Returns:



1572
1573
1574
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1572

def change_email_template
  @change_email_template
end

#dns_info ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2DnsInfo

Information of custom domain DNS verification. By default, default_domain will be used. A custom domain can be configured using VerifyCustomDomain. Corresponds to the JSON property dnsInfo

Returns:



1578
1579
1580
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1578

def dns_info
  @dns_info
end

#legacy_reset_password_template ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2EmailTemplate

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

Returns:



1588
1589
1590
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1588

def legacy_reset_password_template
  @legacy_reset_password_template
end

#method_prop ⇒ String

The method used for sending an email. Corresponds to the JSON property method

Returns:

  • (String) 


1593
1594
1595
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1593

def method_prop
  @method_prop
end

#reset_password_template ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2EmailTemplate

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

Returns:



1603
1604
1605
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1603

def reset_password_template
  @reset_password_template
end

#revert_second_factor_addition_template ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2EmailTemplate

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

Returns:



1613
1614
1615
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1613

def revert_second_factor_addition_template
  @revert_second_factor_addition_template
end

#smtp ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Smtp

Configuration for SMTP relay Corresponds to the JSON property smtp

Returns:



1618
1619
1620
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1618

def smtp
  @smtp
end

#verify_email_template ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2EmailTemplate

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

Returns:



1628
1629
1630
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1628

def verify_email_template
  @verify_email_template
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1635

def update!(**args)
  @callback_uri = args[:callback_uri] if args.key?(:callback_uri)
  @change_email_template = args[:change_email_template] if args.key?(:change_email_template)
  @dns_info = args[:dns_info] if args.key?(:dns_info)
  @legacy_reset_password_template = args[:legacy_reset_password_template] if args.key?(:legacy_reset_password_template)
  @method_prop = args[:method_prop] if args.key?(:method_prop)
  @reset_password_template = args[:reset_password_template] if args.key?(:reset_password_template)
  @revert_second_factor_addition_template = args[:revert_second_factor_addition_template] if args.key?(:revert_second_factor_addition_template)
  @smtp = args[:smtp] if args.key?(:smtp)
  @verify_email_template = args[:verify_email_template] if args.key?(:verify_email_template)
end