Class MessagesSummary

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

public class MessagesSummary extends Object
MessagesSummary is a summary of a list of messages
  • Field Details

  • Constructor Details

    • MessagesSummary

      public MessagesSummary()
  • Method Details

    • messages

      public MessagesSummary messages(@Nullable List<MessageSummary> messages)
    • addMessagesItem

      public MessagesSummary addMessagesItem(MessageSummary messagesItem)
    • getMessages

      @Nullable public List<MessageSummary> getMessages()
      Messages summary in: body
      Returns:
      messages
    • setMessages

      public void setMessages(@Nullable List<MessageSummary> messages)
    • messagesCount

      public MessagesSummary messagesCount(@Nullable Integer messagesCount)
    • getMessagesCount

      @Nullable public Integer getMessagesCount()
      Total number of messages matching current query
      Returns:
      messagesCount
    • setMessagesCount

      public void setMessagesCount(@Nullable Integer messagesCount)
    • messagesUnread

      public MessagesSummary messagesUnread(@Nullable Integer messagesUnread)
    • getMessagesUnread

      @Nullable public Integer getMessagesUnread()
      Total number of unread messages matching current query
      Returns:
      messagesUnread
    • setMessagesUnread

      public void setMessagesUnread(@Nullable Integer messagesUnread)
    • start

      public MessagesSummary start(@Nullable Long start)
    • getStart

      @Nullable public Long getStart()
      Pagination offset
      Returns:
      start
    • setStart

      public void setStart(@Nullable Long start)
    • tags

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

      public MessagesSummary addTagsItem(String tagsItem)
    • getTags

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

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

      public MessagesSummary total(@Nullable Integer total)
    • getTotal

      @Nullable public Integer getTotal()
      Total number of messages in mailbox
      Returns:
      total
    • setTotal

      public void setTotal(@Nullable Integer total)
    • unread

      public MessagesSummary unread(@Nullable Integer unread)
    • getUnread

      @Nullable public Integer getUnread()
      Total number of unread messages in mailbox
      Returns:
      unread
    • setUnread

      public void setUnread(@Nullable Integer unread)
    • 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