Class: MicrosoftGraph::Models::EmailSettings

Inherits:
Object
  • Object
show all
Includes:
MicrosoftKiotaAbstractions::AdditionalDataHolder, MicrosoftKiotaAbstractions::Parsable
Defined in:
lib/models/email_settings.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Object

Instantiates a new emailSettings and sets the default values.



40
41
42
 
# File 'lib/models/email_settings.rb', line 40

def initialize()
    @additional_data = Hash.new
end

Class Method Details

.create_from_discriminator_value(parse_node) ⇒ Object

Creates a new instance of the appropriate class based on discriminator value

Parameters:

  • parse_node —

    The parse node to use to read the discriminator value and create the object

Returns:

  • a email_settings

Raises:

  • (StandardError) 


48
49
50
51
 
# File 'lib/models/email_settings.rb', line 48

def self.create_from_discriminator_value(parse_node)
    raise StandardError, 'parse_node cannot be null' if parse_node.nil?
    return EmailSettings.new
end

Instance Method Details

#additional_data ⇒ Object

Gets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Returns:

  • a i_dictionary



25
26
27
 
# File 'lib/models/email_settings.rb', line 25

def additional_data
    return @additional_data
end

#additional_data=(value) ⇒ Object

Sets the additionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.

Parameters:

  • value —

    Value to set for the additionalData property.

Returns:

  • a void



33
34
35
 
# File 'lib/models/email_settings.rb', line 33

def additional_data=(value)
    @additional_data = value
end

#get_field_deserializers ⇒ Object

The deserialization information for the current model

Returns:

  • a i_dictionary



56
57
58
59
60
61
62
 
# File 'lib/models/email_settings.rb', line 56

def get_field_deserializers()
    return {
        "@odata.type" => lambda {|n| @odata_type = n.get_string_value() },
        "senderDomain" => lambda {|n| @sender_domain = n.get_string_value() },
        "useCompanyBranding" => lambda {|n| @use_company_branding = n.get_boolean_value() },
    }
end

#odata_type ⇒ Object

Gets the @odata.type property value. The OdataType property

Returns:

  • a string



67
68
69
 
# File 'lib/models/email_settings.rb', line 67

def odata_type
    return @odata_type
end

#odata_type=(value) ⇒ Object

Sets the @odata.type property value. The OdataType property

Parameters:

  • value —

    Value to set for the @odata.type property.

Returns:

  • a void



75
76
77
 
# File 'lib/models/email_settings.rb', line 75

def odata_type=(value)
    @odata_type = value
end

#sender_domain ⇒ Object

Gets the senderDomain property value. Specifies the domain that should be used when sending email notifications. This domain must be verified in order to be used. We recommend that you use a domain that has the appropriate DNS records to facilitate email validation, like SPF, DKIM, DMARC, and MX, because this then complies with the RFC compliance for sending and receiving email. For details, see Learn more about Exchange Online Email Routing.

Returns:

  • a string



82
83
84
 
# File 'lib/models/email_settings.rb', line 82

def sender_domain
    return @sender_domain
end

#sender_domain=(value) ⇒ Object

Sets the senderDomain property value. Specifies the domain that should be used when sending email notifications. This domain must be verified in order to be used. We recommend that you use a domain that has the appropriate DNS records to facilitate email validation, like SPF, DKIM, DMARC, and MX, because this then complies with the RFC compliance for sending and receiving email. For details, see Learn more about Exchange Online Email Routing.

Parameters:

  • value —

    Value to set for the senderDomain property.

Returns:

  • a void



90
91
92
 
# File 'lib/models/email_settings.rb', line 90

def sender_domain=(value)
    @sender_domain = value
end

#serialize(writer) ⇒ Object

Serializes information the current object

Parameters:

  • writer —

    Serialization writer to use to serialize this model

Returns:

  • a void

Raises:

  • (StandardError) 


98
99
100
101
102
103
104
 
# File 'lib/models/email_settings.rb', line 98

def serialize(writer)
    raise StandardError, 'writer cannot be null' if writer.nil?
    writer.write_string_value("@odata.type", @odata_type)
    writer.write_string_value("senderDomain", @sender_domain)
    writer.write_boolean_value("useCompanyBranding", @use_company_branding)
    writer.write_additional_data(@additional_data)
end

#use_company_branding ⇒ Object

Gets the useCompanyBranding property value. Specifies if the organization’s banner logo should be included in email notifications. The banner logo will replace the Microsoft logo at the top of the email notification. If true the banner logo will be taken from the tenant’s branding settings. This value can only be set to true if the organizationalBranding bannerLogo property is set.

Returns:

  • a boolean



109
110
111
 
# File 'lib/models/email_settings.rb', line 109

def use_company_branding
    return @use_company_branding
end

#use_company_branding=(value) ⇒ Object

Sets the useCompanyBranding property value. Specifies if the organization’s banner logo should be included in email notifications. The banner logo will replace the Microsoft logo at the top of the email notification. If true the banner logo will be taken from the tenant’s branding settings. This value can only be set to true if the organizationalBranding bannerLogo property is set.

Parameters:

  • value —

    Value to set for the useCompanyBranding property.

Returns:

  • a void



117
118
119
 
# File 'lib/models/email_settings.rb', line 117

def use_company_branding=(value)
    @use_company_branding = value
end