mailslurp
v15.17.22

MailSlurpAPI.Model.CreateInboxDto (mailslurp v15.17.22)

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.

Summary

Types

t()

Types

Link to this type

t()

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