-
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.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.InboxTypeType of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send). Values: hTTPINBOX,sMTPINBOX
-
Field Summary
Fields Modifier and Type Field Description private final StringemailAddressprivate final Stringnameprivate final Stringdescriptionprivate final BooleanuseDomainPoolprivate final List<String>tagsprivate final OffsetDateTimeexpiresAtprivate final Booleanfavouriteprivate final LongexpiresInprivate final BooleanallowTeamAccessprivate final CreateInboxDto.InboxTypeinboxTypeprivate final BooleanvirtualInbox
-
Constructor Summary
Constructors Constructor Description CreateInboxDto(String emailAddress, String name, String description, Boolean useDomainPool, List<String> tags, OffsetDateTime expiresAt, Boolean favourite, Long expiresIn, Boolean allowTeamAccess, CreateInboxDto.InboxType inboxType, Boolean virtualInbox)
-
Method Summary
Modifier and Type Method Description final StringgetEmailAddress()final StringgetName()final StringgetDescription()final BooleangetUseDomainPool()final List<String>getTags()final OffsetDateTimegetExpiresAt()final BooleangetFavourite()final LonggetExpiresIn()final BooleangetAllowTeamAccess()final CreateInboxDto.InboxTypegetInboxType()final BooleangetVirtualInbox()-
-
Constructor Detail
-
CreateInboxDto
CreateInboxDto(String emailAddress, String name, String description, Boolean useDomainPool, List<String> tags, OffsetDateTime expiresAt, Boolean favourite, Long expiresIn, Boolean allowTeamAccess, CreateInboxDto.InboxType inboxType, Boolean virtualInbox)
- Parameters:
emailAddress- A custom email address to use with the inbox.name- Optional name of the inbox.description- Optional description of the inbox for labelling purposes.useDomainPool- Use the MailSlurp domain name pool with this inbox when creating the email address.tags- Tags that inbox has been tagged with.expiresAt- Optional inbox expiration date.favourite- Is the inbox a favorite.expiresIn- Number of milliseconds that inbox should exist forallowTeamAccess- DEPRECATED (team access is always true).inboxType- Type of inbox.virtualInbox- Virtual inbox prevents any outbound emails from being sent.
-
-
Method Detail
-
getEmailAddress
final String getEmailAddress()
-
getDescription
final String getDescription()
-
getUseDomainPool
final Boolean getUseDomainPool()
-
getExpiresAt
final OffsetDateTime getExpiresAt()
-
getFavourite
final Boolean getFavourite()
-
getExpiresIn
final Long getExpiresIn()
-
getAllowTeamAccess
final Boolean getAllowTeamAccess()
-
getInboxType
final CreateInboxDto.InboxType getInboxType()
-
getVirtualInbox
final Boolean getVirtualInbox()
-
-
-
-