class OCI::Email::Models::Suppression
The full information representing an email suppression.
Constants
- REASON_ENUM
Attributes
[Required] The OCID of the compartment to contain the suppression. Since suppressions are at the customer level, this must be the tenancy OCID.
@return [String]
[Required] Email
address of the suppression. @return [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.
@return [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.
@return [String]
[Required] The unique ID of the suppression. @return [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.
@return [String]
The reason that the email address was suppressed. For more information on the types of bounces, see [Suppression List](docs.cloud.oracle.com/Content/Email/Concepts/overview.htm#components). @return [String]
The date and time the suppression was added in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
@return [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.
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/email/models/suppression.rb, line 77 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :email_address The value to assign to the {#email_address} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :reason The value to assign to the {#reason} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_last_suppressed The value to assign to the {#time_last_suppressed} property @option attributes [String] :message_id The value to assign to the {#message_id} property @option attributes [String] :error_detail The value to assign to the {#error_detail} property @option attributes [String] :error_source The value to assign to the {#error_source} property
# File lib/oci/email/models/suppression.rb, line 125 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
Attribute type mapping.
# File lib/oci/email/models/suppression.rb, line 94 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/email/models/suppression.rb, line 198 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/email/models/suppression.rb, line 236 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/email/models/suppression.rb, line 216 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/email/models/suppression.rb, line 225 def hash [compartment_id, email_address, id, reason, time_created, time_last_suppressed, message_id, error_detail, error_source].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] reason Object
to be assigned
# File lib/oci/email/models/suppression.rb, line 182 def reason=(reason) # rubocop:disable Style/ConditionalAssignment if reason && !REASON_ENUM.include?(reason) OCI.logger.debug("Unknown value for 'reason' [" + reason + "]. Mapping to 'REASON_UNKNOWN_ENUM_VALUE'") if OCI.logger @reason = REASON_UNKNOWN_ENUM_VALUE else @reason = reason end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/email/models/suppression.rb, line 269 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/email/models/suppression.rb, line 263 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/email/models/suppression.rb, line 286 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end