Package software.xdev.mailpit.model

Class Message

java.lang.Object
software.xdev.mailpit.model.Message
public class Message extends Object
Message data excluding physical attachments

  • Field Details

  • Constructor Details

    • Message

      public Message()

  • Method Details

    • attachments

      public Message attachments(@Nullable List<Attachment> attachments)

    • addAttachmentsItem

      public Message addAttachmentsItem(Attachment attachmentsItem)

    • getAttachments

      @Nullable public List<Attachment> getAttachments()
      Message attachments
      Returns:
      attachments

    • setAttachments

      public void setAttachments(@Nullable List<Attachment> attachments)

    • bcc

      public Message bcc(@Nullable List<Address> bcc)

    • addBccItem

      public Message addBccItem(Address bccItem)

    • getBcc

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

    • setBcc

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

    • cc

      public Message cc(@Nullable List<Address> cc)

    • addCcItem

      public Message addCcItem(Address ccItem)

    • getCc

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

    • setCc

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

    • date

      public Message date(@Nullable OffsetDateTime date)

    • getDate

      @Nullable public OffsetDateTime getDate()
      Message RFC3339Nano date & time (if set), else date & time received ([extended RFC3339](https://tools.ietf.org/html/rfc3339#section-5.6) format with optional nano seconds)
      Returns:
      date

    • setDate

      public void setDate(@Nullable OffsetDateTime date)

    • from

      public Message from(@Nullable Address from)

    • getFrom

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

    • setFrom

      public void setFrom(@Nullable Address from)

    • HTML

      public Message HTML(@Nullable String HTML)

    • getHTML

      @Nullable public String getHTML()
      Message body HTML
      Returns:
      HTML

    • setHTML

      public void setHTML(@Nullable String HTML)

    • ID

      public Message ID(@Nullable String ID)

    • getID

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

    • setID

      public void setID(@Nullable String ID)

    • inline

      public Message inline(@Nullable List<Attachment> inline)

    • addInlineItem

      public Message addInlineItem(Attachment inlineItem)

    • getInline

      @Nullable public List<Attachment> getInline()
      Inline message attachments
      Returns:
      inline

    • setInline

      public void setInline(@Nullable List<Attachment> inline)

    • listUnsubscribe

      public Message listUnsubscribe(@Nullable ListUnsubscribe listUnsubscribe)

    • getListUnsubscribe

      @Nullable public ListUnsubscribe getListUnsubscribe()
      Get listUnsubscribe
      Returns:
      listUnsubscribe

    • setListUnsubscribe

      public void setListUnsubscribe(@Nullable ListUnsubscribe listUnsubscribe)

    • messageID

      public Message messageID(@Nullable String messageID)

    • getMessageID

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

    • setMessageID

      public void setMessageID(@Nullable String messageID)

    • replyTo

      public Message replyTo(@Nullable List<Address> replyTo)

    • addReplyToItem

      public Message addReplyToItem(Address replyToItem)

    • getReplyTo

      @Nullable public List<Address> getReplyTo()
      ReplyTo addresses
      Returns:
      replyTo

    • setReplyTo

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

    • returnPath

      public Message returnPath(@Nullable String returnPath)

    • getReturnPath

      @Nullable public String getReturnPath()
      Return-Path
      Returns:
      returnPath

    • setReturnPath

      public void setReturnPath(@Nullable String returnPath)

    • size

      public Message size(@Nullable Integer size)

    • getSize

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

    • setSize

      public void setSize(@Nullable Integer size)

    • subject

      public Message subject(@Nullable String subject)

    • getSubject

      @Nullable public String getSubject()
      Message subject
      Returns:
      subject

    • setSubject

      public void setSubject(@Nullable String subject)

    • tags

      public Message tags(@Nullable List<String> tags)

    • addTagsItem

      public Message addTagsItem(String tagsItem)

    • getTags

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

    • setTags

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

    • text

      public Message text(@Nullable String text)

    • getText

      @Nullable public String getText()
      Message body text
      Returns:
      text

    • setText

      public void setText(@Nullable String text)

    • to

      public Message to(@Nullable List<Address> to)

    • addToItem

      public Message addToItem(Address toItem)

    • getTo

      @Nullable public List<Address> getTo()
      To addresses
      Returns:
      to

    • setTo

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

    • username

      public Message 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