-
public final class InboxDtoRepresentation of a MailSlurp inbox. An inbox has an ID and a real email address. Emails can be sent to or from this email address. Inboxes are either
SMTPorHTTPmailboxes. The default,HTTPinboxes, use AWS SES to process emails and are best suited as test email accounts.SMTPinboxes use a custom mail server atmx.mailslurp.comand can only receive emails - they are best used for public facing email addresses. Use theEmailControlleror theInboxControllermethods to send and receive emails and attachments. Inboxes may have a description, name, and tags for display purposes. You can also favourite an inbox for easier searching. Inboxes can be private or allow team access. Team access enabled inboxes can be seen by other members of an organization.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enumInboxDto.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 UUIDidprivate final OffsetDateTimecreatedAtprivate final StringemailAddressprivate final Booleanfavouriteprivate final BooleanreadOnlyprivate final UUIDuserIdprivate final Stringnameprivate final Stringdescriptionprivate final StringexpiresAtprivate final List<String>tagsprivate final InboxDto.InboxTypeinboxType
-
Method Summary
Modifier and Type Method Description final UUIDgetId()final OffsetDateTimegetCreatedAt()final StringgetEmailAddress()final BooleangetFavourite()final BooleangetReadOnly()final UUIDgetUserId()final StringgetName()final StringgetDescription()final StringgetExpiresAt()final List<String>getTags()final InboxDto.InboxTypegetInboxType()-
-
Constructor Detail
-
InboxDto
InboxDto(UUID id, OffsetDateTime createdAt, String emailAddress, Boolean favourite, Boolean readOnly, UUID userId, String name, String description, String expiresAt, List<String> tags, InboxDto.InboxType inboxType)
- Parameters:
id- ID of the inbox.createdAt- When the inbox was created.emailAddress- The inbox's email address.favourite- Is the inbox a favorite inbox.readOnly- Is the inbox readOnly for the caller.userId- ID of user that inbox belongs toname- Name of the inbox and used as the sender name when sending emails .description- Description of an inbox for labelling and searching purposesexpiresAt- Inbox expiration time.tags- Tags that inbox has been tagged with.inboxType- Type of inbox.
-
-
Method Detail
-
getCreatedAt
final OffsetDateTime getCreatedAt()
-
getEmailAddress
final String getEmailAddress()
-
getFavourite
final Boolean getFavourite()
-
getReadOnly
final Boolean getReadOnly()
-
getDescription
final String getDescription()
-
getExpiresAt
final String getExpiresAt()
-
getInboxType
final InboxDto.InboxType getInboxType()
-
-
-
-