class MailSlurpClient::CreateInboxDto
Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either `SMTP` or `HTTP` mailboxes. Use `SMTP` for public facing mailboxes and `HTTP` for test email accounts. `SMTP` inboxes are processed by a mail server running at `mx.mailslurp.com` while `HTTP` inboxes are processed by AWS SES. Inboxes can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random).
Attributes
DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox
and Email
Controller endpoints with the inbox ID.
Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
Number of milliseconds that inbox should exist for
Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
HTTP (default) or SMTP inbox type. HTTP inboxes are best for testing while SMTP inboxes are more reliable for public inbound email consumption. When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`.
Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,…}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/mailslurp_client/models/create_inbox_dto.rb, line 71 def self.attribute_map { :'allow_team_access' => :'allowTeamAccess', :'description' => :'description', :'email_address' => :'emailAddress', :'expires_at' => :'expiresAt', :'expires_in' => :'expiresIn', :'favourite' => :'favourite', :'inbox_type' => :'inboxType', :'name' => :'name', :'tags' => :'tags', :'use_domain_pool' => :'useDomainPool' } 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/create_inbox_dto.rb, line 223 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/create_inbox_dto.rb, line 110 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::CreateInboxDto` 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::CreateInboxDto`. 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?(:'allow_team_access') self.allow_team_access = attributes[:'allow_team_access'] 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?(:'expires_in') self.expires_in = attributes[:'expires_in'] end if attributes.key?(:'favourite') self.favourite = attributes[:'favourite'] 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?(:'tags') if (value = attributes[:'tags']).is_a?(Array) self.tags = value end end if attributes.key?(:'use_domain_pool') self.use_domain_pool = attributes[:'use_domain_pool'] end end
List of attributes with nullable: true
# File lib/mailslurp_client/models/create_inbox_dto.rb, line 103 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/mailslurp_client/models/create_inbox_dto.rb, line 87 def self.openapi_types { :'allow_team_access' => :'Boolean', :'description' => :'String', :'email_address' => :'String', :'expires_at' => :'DateTime', :'expires_in' => :'Integer', :'favourite' => :'Boolean', :'inbox_type' => :'String', :'name' => :'String', :'tags' => :'Array<String>', :'use_domain_pool' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/mailslurp_client/models/create_inbox_dto.rb, line 193 def ==(o) return true if self.equal?(o) self.class == o.class && allow_team_access == o.allow_team_access && description == o.description && email_address == o.email_address && expires_at == o.expires_at && expires_in == o.expires_in && favourite == o.favourite && inbox_type == o.inbox_type && name == o.name && tags == o.tags && use_domain_pool == o.use_domain_pool 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/create_inbox_dto.rb, line 251 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/create_inbox_dto.rb, line 320 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/create_inbox_dto.rb, line 230 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/create_inbox_dto.rb, line 210 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/mailslurp_client/models/create_inbox_dto.rb, line 216 def hash [allow_team_access, description, email_address, expires_at, expires_in, favourite, inbox_type, name, tags, use_domain_pool].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] inbox_type
Object to be assigned
# File lib/mailslurp_client/models/create_inbox_dto.rb, line 183 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/create_inbox_dto.rb, line 168 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/create_inbox_dto.rb, line 302 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/create_inbox_dto.rb, line 290 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/create_inbox_dto.rb, line 175 def valid? inbox_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_INBOX"]) return false unless inbox_type_validator.valid?(@inbox_type) true end