lib/mail_slurp_api/model/create_inbox_dto.ex

# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
# https://openapi-generator.tech
# Do not edit the class manually.

defmodule MailSlurpAPI.Model.CreateInboxDto do
  @moduledoc """
  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. `SMTP` inboxes are processed by a mail server running at `mailslurp.mx` while `HTTP` inboxes are processed by AWS SES backed mailservers. An inbox email address is randomly assigned by default ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random). To specify an address use a custom domain: either pass the `emailAddress` options with `<your-recipient>@<your-domain>`. To create a randomized address for your domain set the `domainName` to the domain you have verified or pass the `domainId`. Virtual inboxes prevent outbound sending and instead trap mail.
  """

  @derive [Poison.Encoder]
  defstruct [
    :"emailAddress",
    :"domainName",
    :"domainId",
    :"name",
    :"description",
    :"useDomainPool",
    :"tags",
    :"expiresAt",
    :"favourite",
    :"expiresIn",
    :"allowTeamAccess",
    :"inboxType",
    :"virtualInbox",
    :"useShortAddress"
  ]

  @type t :: %__MODULE__{
    :"emailAddress" => String.t | nil,
    :"domainName" => String.t | nil,
    :"domainId" => String.t | nil,
    :"name" => String.t | nil,
    :"description" => String.t | nil,
    :"useDomainPool" => boolean() | nil,
    :"tags" => [String.t] | nil,
    :"expiresAt" => DateTime.t | nil,
    :"favourite" => boolean() | nil,
    :"expiresIn" => integer() | nil,
    :"allowTeamAccess" => boolean() | nil,
    :"inboxType" => String.t | nil,
    :"virtualInbox" => boolean() | nil,
    :"useShortAddress" => boolean() | nil
  }
end

defimpl Poison.Decoder, for: MailSlurpAPI.Model.CreateInboxDto do
  def decode(value, _options) do
    value
  end
end