Class: OCI::Email::Models::Suppression

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/email/models/suppression.rb

Overview

The full information representing an email suppression.

Constant Summary collapse

REASON_ENUM = 
[
  REASON_UNKNOWN = 'UNKNOWN'.freeze,
  REASON_HARDBOUNCE = 'HARDBOUNCE'.freeze,
  REASON_COMPLAINT = 'COMPLAINT'.freeze,
  REASON_MANUAL = 'MANUAL'.freeze,
  REASON_SOFTBOUNCE = 'SOFTBOUNCE'.freeze,
  REASON_UNSUBSCRIBE = 'UNSUBSCRIBE'.freeze,
  REASON_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Suppression

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :email_address (String) —

    The value to assign to the #email_address property

  • :id (String) —

    The value to assign to the #id property

  • :reason (String) —

    The value to assign to the #reason property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_last_suppressed (DateTime) —

    The value to assign to the #time_last_suppressed property

  • :message_id (String) —

    The value to assign to the #message_id property

  • :error_detail (String) —

    The value to assign to the #error_detail property

  • :error_source (String) —

    The value to assign to the #error_source property



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/email/models/suppression.rb', line 126

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.email_address = attributes[:'emailAddress'] if attributes[:'emailAddress']

  raise 'You cannot provide both :emailAddress and :email_address' if attributes.key?(:'emailAddress') && attributes.key?(:'email_address')

  self.email_address = attributes[:'email_address'] if attributes[:'email_address']

  self.id = attributes[:'id'] if attributes[:'id']

  self.reason = attributes[:'reason'] if attributes[:'reason']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_last_suppressed = attributes[:'timeLastSuppressed'] if attributes[:'timeLastSuppressed']

  raise 'You cannot provide both :timeLastSuppressed and :time_last_suppressed' if attributes.key?(:'timeLastSuppressed') && attributes.key?(:'time_last_suppressed')

  self.time_last_suppressed = attributes[:'time_last_suppressed'] if attributes[:'time_last_suppressed']

  self.message_id = attributes[:'messageId'] if attributes[:'messageId']

  raise 'You cannot provide both :messageId and :message_id' if attributes.key?(:'messageId') && attributes.key?(:'message_id')

  self.message_id = attributes[:'message_id'] if attributes[:'message_id']

  self.error_detail = attributes[:'errorDetail'] if attributes[:'errorDetail']

  raise 'You cannot provide both :errorDetail and :error_detail' if attributes.key?(:'errorDetail') && attributes.key?(:'error_detail')

  self.error_detail = attributes[:'error_detail'] if attributes[:'error_detail']

  self.error_source = attributes[:'errorSource'] if attributes[:'errorSource']

  raise 'You cannot provide both :errorSource and :error_source' if attributes.key?(:'errorSource') && attributes.key?(:'error_source')

  self.error_source = attributes[:'error_source'] if attributes[:'error_source']
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/email/models/suppression.rb', line 27

def compartment_id
  @compartment_id
end

#email_address ⇒ String

[Required] Email address of the suppression.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/email/models/suppression.rb', line 31

def email_address
  @email_address
end

#error_detail ⇒ String

The specific error message returned by a system that resulted in the suppression. This message is usually an SMTP error code with additional descriptive text. Not provided for all types of suppressions.

Returns:

  • (String) 


66
67
68
 
# File 'lib/oci/email/models/suppression.rb', line 66

def error_detail
  @error_detail
end

#error_source ⇒ String

DNS name of the source of the error that caused the suppression. Will be set to either the remote-mta or reporting-mta field from a delivery status notification (RFC 3464) when available. Not provided for all types of suppressions, and not always known.

Note: Most SMTP errors that cause suppressions come from software run by email receiving systems rather than from OCI email delivery itself.

Returns:

  • (String) 


75
76
77
 
# File 'lib/oci/email/models/suppression.rb', line 75

def error_source
  @error_source
end

#id ⇒ String

[Required] The unique ID of the suppression.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/email/models/suppression.rb', line 35

def id
  @id
end

#message_id ⇒ String

The value of the Message-ID header from the email that triggered a suppression. This value is as defined in RFC 5322 section 3.6.4, excluding angle-brackets. Not provided for all types of suppressions.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/email/models/suppression.rb', line 59

def message_id
  @message_id
end

#reason ⇒ String

The reason that the email address was suppressed. For more information on the types of bounces, see Suppression List.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/email/models/suppression.rb', line 39

def reason
  @reason
end

#time_created ⇒ DateTime

The date and time the suppression was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oci/email/models/suppression.rb', line 45

def time_created
  @time_created
end

#time_last_suppressed ⇒ DateTime

The last date and time the suppression prevented submission in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/email/models/suppression.rb', line 52

def time_last_suppressed
  @time_last_suppressed
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/email/models/suppression.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'email_address': :'emailAddress',
    'id': :'id',
    'reason': :'reason',
    'time_created': :'timeCreated',
    'time_last_suppressed': :'timeLastSuppressed',
    'message_id': :'messageId',
    'error_detail': :'errorDetail',
    'error_source': :'errorSource'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/email/models/suppression.rb', line 95

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'email_address': :'String',
    'id': :'String',
    'reason': :'String',
    'time_created': :'DateTime',
    'time_last_suppressed': :'DateTime',
    'message_id': :'String',
    'error_detail': :'String',
    'error_source': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/oci/email/models/suppression.rb', line 199

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    email_address == other.email_address &&
    id == other.id &&
    reason == other.reason &&
    time_created == other.time_created &&
    time_last_suppressed == other.time_last_suppressed &&
    message_id == other.message_id &&
    error_detail == other.error_detail &&
    error_source == other.error_source
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/oci/email/models/suppression.rb', line 237

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
 
# File 'lib/oci/email/models/suppression.rb', line 217

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



226
227
228
 
# File 'lib/oci/email/models/suppression.rb', line 226

def hash
  [compartment_id, email_address, id, reason, time_created, time_last_suppressed, message_id, error_detail, error_source].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/oci/email/models/suppression.rb', line 270

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



264
265
266
 
# File 'lib/oci/email/models/suppression.rb', line 264

def to_s
  to_hash.to_s
end