Class MessageSummary

java.lang.Object
software.xdev.mailpit.model.MessageSummary

public class MessageSummary extends Object
MessageSummary struct for frontend messages
  • Field Details

  • Constructor Details

    • MessageSummary

      public MessageSummary()
  • Method Details

    • attachments

      public MessageSummary attachments(@Nullable Long attachments)
    • getAttachments

      @Nullable public Long getAttachments()
      Whether the message has any attachments
      Returns:
      attachments
    • setAttachments

      public void setAttachments(@Nullable Long attachments)
    • bcc

      public MessageSummary bcc(@Nullable List<Address> bcc)
    • addBccItem

      public MessageSummary addBccItem(Address bccItem)
    • getBcc

      @Nullable public List<Address> getBcc()
      Bcc addresses
      Returns:
      bcc
    • setBcc

      public void setBcc(@Nullable List<Address> bcc)
    • cc

      public MessageSummary cc(@Nullable List<Address> cc)
    • addCcItem

      public MessageSummary addCcItem(Address ccItem)
    • getCc

      @Nullable public List<Address> getCc()
      Cc addresses
      Returns:
      cc
    • setCc

      public void setCc(@Nullable List<Address> cc)
    • created

      public MessageSummary created(@Nullable OffsetDateTime created)
    • getCreated

      @Nullable public OffsetDateTime getCreated()
      Received RFC3339Nano date & time ([extended RFC3339](https://tools.ietf.org/html/rfc3339#section-5.6) format with optional nano seconds)
      Returns:
      created
    • setCreated

      public void setCreated(@Nullable OffsetDateTime created)
    • from

      public MessageSummary from(@Nullable Address from)
    • getFrom

      @Nullable public Address getFrom()
      Get from
      Returns:
      from
    • setFrom

      public void setFrom(@Nullable Address from)
    • ID

      public MessageSummary ID(@Nullable String ID)
    • getID

      @Nullable public String getID()
      Database ID
      Returns:
      ID
    • setID

      public void setID(@Nullable String ID)
    • messageID

      public MessageSummary messageID(@Nullable String messageID)
    • getMessageID

      @Nullable public String getMessageID()
      Message ID
      Returns:
      messageID
    • setMessageID

      public void setMessageID(@Nullable String messageID)
    • read

      public MessageSummary read(@Nullable Boolean read)
    • getRead

      @Nullable public Boolean getRead()
      Read status
      Returns:
      read
    • setRead

      public void setRead(@Nullable Boolean read)
    • replyTo

      public MessageSummary replyTo(@Nullable List<Address> replyTo)
    • addReplyToItem

      public MessageSummary addReplyToItem(Address replyToItem)
    • getReplyTo

      @Nullable public List<Address> getReplyTo()
      Reply-To address
      Returns:
      replyTo
    • setReplyTo

      public void setReplyTo(@Nullable List<Address> replyTo)
    • size

      public MessageSummary size(@Nullable Integer size)
    • getSize

      @Nullable public Integer getSize()
      Message size in bytes (total)
      Returns:
      size
    • setSize

      public void setSize(@Nullable Integer size)
    • snippet

      public MessageSummary snippet(@Nullable String snippet)
    • getSnippet

      @Nullable public String getSnippet()
      Message snippet includes up to 250 characters
      Returns:
      snippet
    • setSnippet

      public void setSnippet(@Nullable String snippet)
    • subject

      public MessageSummary subject(@Nullable String subject)
    • getSubject

      @Nullable public String getSubject()
      Email subject
      Returns:
      subject
    • setSubject

      public void setSubject(@Nullable String subject)
    • tags

      public MessageSummary tags(@Nullable List<String> tags)
    • addTagsItem

      public MessageSummary addTagsItem(String tagsItem)
    • getTags

      @Nullable public List<String> getTags()
      Message tags
      Returns:
      tags
    • setTags

      public void setTags(@Nullable List<String> tags)
    • to

      public MessageSummary to(@Nullable List<Address> to)
    • addToItem

      public MessageSummary addToItem(Address toItem)
    • getTo

      @Nullable public List<Address> getTo()
      To address
      Returns:
      to
    • setTo

      public void setTo(@Nullable List<Address> to)
    • username

      public MessageSummary username(@Nullable String username)
    • getUsername

      @Nullable public String getUsername()
      Username used for authentication (if provided) with the SMTP or Send API
      Returns:
      username
    • setUsername

      public void setUsername(@Nullable String username)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • toUrlQueryString

      public String toUrlQueryString()
      Convert the instance into URL query string.
      Returns:
      URL query string
    • toUrlQueryString

      public String toUrlQueryString(String prefix)
      Convert the instance into URL query string.
      Parameters:
      prefix - prefix of the query string
      Returns:
      URL query string