Class: Telnyx::Models::EmailDmarcPolicy

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/email_dmarc_policy.rb,
sig/telnyx/models/email_dmarc_policy.rbs

Defined Under Namespace

Modules: P, Sp

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(p_: nil, pct: nil, rua: nil, sp: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::EmailDmarcPolicy for more details.

DMARC policy for a sending domain. Drives the recommended _dmarc. TXT record. DMARC is advisory and never blocks sending. When omitted or null, the domain uses the advisory default (v=DMARC1; p=none; rua=mailto:dmarc@telnyx.com).

Parameters:

  • p_ (Symbol, Telnyx::Models::EmailDmarcPolicy::P) (defaults to: nil) —

    Policy applied to messages that fail alignment.

  • pct (Integer) (defaults to: nil) —

    Percentage of messages the policy applies to. Omitted from the record when 100.

  • rua (String, nil) (defaults to: nil) —

    URI for aggregate reports. Defaults to the Telnyx address when absent; null omit

  • sp (Symbol, Telnyx::Models::EmailDmarcPolicy::Sp, nil) (defaults to: nil) —

    Policy for subdomains. Omitted from the record when null.




# File 'lib/telnyx/models/email_dmarc_policy.rb', line 31

Instance Attribute Details

#p_ ⇒ Symbol, ...

Policy applied to messages that fail alignment.

Returns:



10
 
# File 'lib/telnyx/models/email_dmarc_policy.rb', line 10

optional :p_, enum: -> { Telnyx::EmailDmarcPolicy::P }, api_name: :p

#pct ⇒ Integer?

Percentage of messages the policy applies to. Omitted from the record when 100.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


16
 
# File 'lib/telnyx/models/email_dmarc_policy.rb', line 16

optional :pct, Integer

#rua ⇒ String?

URI for aggregate reports. Defaults to the Telnyx address when absent; null omits it.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


23
 
# File 'lib/telnyx/models/email_dmarc_policy.rb', line 23

optional :rua, String, nil?: true

#sp ⇒ Symbol, ...

Policy for subdomains. Omitted from the record when null.

Parameters:

  • value (Telnyx::Models::EmailDmarcPolicy::sp, nil)

Returns:



29
 
# File 'lib/telnyx/models/email_dmarc_policy.rb', line 29

optional :sp, enum: -> { Telnyx::EmailDmarcPolicy::Sp }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/email_dmarc_policy.rb', line 58

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


33
 
# File 'sig/telnyx/models/email_dmarc_policy.rbs', line 33

def to_hash: -> {