-
public final class CreateInboxDtoOptions 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
SMTPorHTTPmailboxes. UseSMTPfor public facing mailboxes andHTTPfor test email accounts.SMTPinboxes are processed by a mail server running atmx.mailslurp.comwhileHTTPinboxes are processed by AWS SES. Inboxes can use a custom email address (by verifying your own domain) or a randomly assigned email ending in eithermailslurp.comor (ifuseDomainPoolis enabled) ending in a similar domain such asmailslurp.xyz(selected at random).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumCreateInboxDto.InboxTypeHTTP (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. Values: hTTPINBOX,sMTPINBOX
-
Field Summary
Fields Modifier and Type Field Description private final BooleanallowTeamAccessprivate final Stringdescriptionprivate final StringemailAddressprivate final OffsetDateTimeexpiresAtprivate final LongexpiresInprivate final Booleanfavouriteprivate final CreateInboxDto.InboxTypeinboxTypeprivate final Stringnameprivate final List<String>tagsprivate final BooleanuseDomainPool
-
Constructor Summary
Constructors Constructor Description CreateInboxDto(Boolean allowTeamAccess, String description, String emailAddress, OffsetDateTime expiresAt, Long expiresIn, Boolean favourite, CreateInboxDto.InboxType inboxType, String name, List<String> tags, Boolean useDomainPool)
-
Method Summary
Modifier and Type Method Description final BooleangetAllowTeamAccess()final StringgetDescription()final StringgetEmailAddress()final OffsetDateTimegetExpiresAt()final LonggetExpiresIn()final BooleangetFavourite()final CreateInboxDto.InboxTypegetInboxType()final StringgetName()final List<String>getTags()final BooleangetUseDomainPool()-
-
Constructor Detail
-
CreateInboxDto
CreateInboxDto(Boolean allowTeamAccess, String description, String emailAddress, OffsetDateTime expiresAt, Long expiresIn, Boolean favourite, CreateInboxDto.InboxType inboxType, String name, List<String> tags, Boolean useDomainPool)
- Parameters:
allowTeamAccess- DEPRECATED (team access is always true).description- Optional description of the inbox for labelling purposes.emailAddress- A custom email address to use with the inbox.expiresAt- Optional inbox expiration date.expiresIn- Number of milliseconds that inbox should exist forfavourite- Is the inbox a favorite.inboxType- HTTP (default) or SMTP inbox type.name- Optional name of the inbox.tags- Tags that inbox has been tagged with.useDomainPool- Use the MailSlurp domain name pool with this inbox when creating the email address.
-
-
Method Detail
-
getAllowTeamAccess
final Boolean getAllowTeamAccess()
-
getDescription
final String getDescription()
-
getEmailAddress
final String getEmailAddress()
-
getExpiresAt
final OffsetDateTime getExpiresAt()
-
getExpiresIn
final Long getExpiresIn()
-
getFavourite
final Boolean getFavourite()
-
getInboxType
final CreateInboxDto.InboxType getInboxType()
-
getUseDomainPool
final Boolean getUseDomainPool()
-
-
-
-