class MailSlurpClient::Inbox
Representation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either `SMTP` or `HTTP` mailboxes. The default, `HTTP` inboxes, use AWS SES to process emails and are best suited as test email accounts. `SMTP` inboxes use a custom mail server at `mx.mailslurp.com` and are best used for public facing email addresses. Use the `EmailController` or the `InboxController` methods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching. Inboxes can be private or allow team access. Team access enabled inboxes can be seen by other members of an organization.
Attributes
When the inbox was created. Time stamps are in ISO DateTime Format `yyyy-MM-dd'T'HH:mm:ss.SSSXXX` e.g. `2000-10-31T01:30:00.000-05:00`.
Description of an inbox for labelling and searching purposes
The inbox's email address. Inbox
projections and previews may not include the email address. To view the email address fetch the inbox entity directly. Send an email to this address and the inbox will receive and store it for you. Note the email address in MailSlurp match characters exactly and are case sensitive so `+123` additions are considered different addresses. To retrieve the email use the Inbox
and Email
Controller endpoints with the inbox ID.
Inbox
expiration time. When, if ever, the inbox should expire and be deleted. If null then this inbox is permanent and the emails in it won't be deleted. This is the default behavior unless expiration date is set. If an expiration date is set and the time is reached MailSlurp will expire the inbox and move it to an expired inbox entity. You can still access the emails belonging to it but it can no longer send or receive email.
Is the inbox a favorite inbox. Make an inbox a favorite is typically done in the dashboard for quick access or filtering
ID of the inbox. The ID is a UUID-V4 format string. Use the inboxId for calls to Inbox
and Email
Controller endpoints. See the emailAddress property for the email address or the inbox. To get emails in an inbox use the WaitFor and Inbox
Controller methods `waitForLatestEmail` and `getEmails` methods respectively. Inboxes can be used with aliases to forward emails automatically.
Type of inbox - either HTTP (default) or SMTP. HTTP inboxes are great for testing. SMTP inboxes are processed by a custom SMTP mail server and are better for public facing inboxes that receive emails from Gmail and other large providers. If using a custom domain the domain type must match the inbox type. Use an SMTP domain for SMTP inboxes that includes an MX record pointing to `10 mx.mailslurp.com` for inbound messages.
Name of the inbox and used as the sender name when sending emails .Displayed in the dashboard for easier search
Is the inbox readOnly for the caller. Read only means can not be deleted or modified. This flag is present when using team accounts and shared inboxes.
Does inbox permit team access for organization team members. If so team users can use inbox and emails associated with it. See the team access guide at www.mailslurp.com/guides/team-email-account-sharing/
ID of user that inbox belongs to
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/mailslurp_client/models/inbox.rb, line 77 def self.attribute_map { :'created_at' => :'createdAt', :'description' => :'description', :'email_address' => :'emailAddress', :'expires_at' => :'expiresAt', :'favourite' => :'favourite', :'id' => :'id', :'inbox_type' => :'inboxType', :'name' => :'name', :'read_only' => :'readOnly', :'tags' => :'tags', :'team_access' => :'teamAccess', :'user_id' => :'userId' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/mailslurp_client/models/inbox.rb, line 243 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/mailslurp_client/models/inbox.rb, line 120 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::Inbox` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::Inbox`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'email_address') self.email_address = attributes[:'email_address'] end if attributes.key?(:'expires_at') self.expires_at = attributes[:'expires_at'] end if attributes.key?(:'favourite') self.favourite = attributes[:'favourite'] end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'inbox_type') self.inbox_type = attributes[:'inbox_type'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'read_only') self.read_only = attributes[:'read_only'] end if attributes.key?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self.tags = value end end if attributes.key?(:'team_access') self.team_access = attributes[:'team_access'] end if attributes.key?(:'user_id') self.user_id = attributes[:'user_id'] end end
List of attributes with nullable: true
# File lib/mailslurp_client/models/inbox.rb, line 113 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/mailslurp_client/models/inbox.rb, line 95 def self.openapi_types { :'created_at' => :'DateTime', :'description' => :'String', :'email_address' => :'String', :'expires_at' => :'String', :'favourite' => :'Boolean', :'id' => :'String', :'inbox_type' => :'String', :'name' => :'String', :'read_only' => :'Boolean', :'tags' => :'Array<String>', :'team_access' => :'Boolean', :'user_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/mailslurp_client/models/inbox.rb, line 211 def ==(o) return true if self.equal?(o) self.class == o.class && created_at == o.created_at && description == o.description && email_address == o.email_address && expires_at == o.expires_at && favourite == o.favourite && id == o.id && inbox_type == o.inbox_type && name == o.name && read_only == o.read_only && tags == o.tags && team_access == o.team_access && user_id == o.user_id end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/mailslurp_client/models/inbox.rb, line 271 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model MailSlurpClient.const_get(type).build_from_hash(value) end end
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/mailslurp_client/models/inbox.rb, line 340 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/mailslurp_client/models/inbox.rb, line 250 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(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] Object to be compared
# File lib/mailslurp_client/models/inbox.rb, line 230 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/mailslurp_client/models/inbox.rb, line 236 def hash [created_at, description, email_address, expires_at, favourite, id, inbox_type, name, read_only, tags, team_access, user_id].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] inbox_type
Object to be assigned
# File lib/mailslurp_client/models/inbox.rb, line 201 def inbox_type=(inbox_type) validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"]) unless validator.valid?(inbox_type) fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{validator.allowable_values}." end @inbox_type = inbox_type end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/mailslurp_client/models/inbox.rb, line 186 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/mailslurp_client/models/inbox.rb, line 322 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/mailslurp_client/models/inbox.rb, line 310 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/mailslurp_client/models/inbox.rb, line 193 def valid? inbox_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"]) return false unless inbox_type_validator.valid?(@inbox_type) true end