Interface SimpleMessage


  • public interface SimpleMessage
    Represents a mail object that has been retrieved from an external source by a MessageConnector
    Since:
    10.0.46
    • Method Detail

      • getMessageId

        java.lang.String getMessageId()
        The messageId of a message must be globally unique. It must contain only the following characters: [a-z][A-Z][0-9]@.-_ The maximum number of characters is 255.
        Returns:
        the message id as string
        Since:
        10.0.46
      • getParentMessageId

        default java.lang.String getParentMessageId()
        The parent messageId, if set, references the messageId of a previously received message, that relates to this message. Like the messageId it must contain only the following characters: [a-z][A-Z][0-9]@.-_ The maximum number of characters is 255.
        Returns:
        the parent message id as string
        Since:
        10.0.46
      • getFromAddress

        javax.mail.internet.InternetAddress getFromAddress()
        Returns:
        the sender address of the message
        Since:
        10.0.46
      • getSubject

        java.lang.String getSubject()
        Returns:
        the decoded subject as string
        Since:
        10.0.46
      • getText

        java.lang.String getText()
        Returns:
        the decoded plain text of the message as string
        Since:
        10.0.46
      • getDate

        java.util.Date getDate()
        Returns:
        the date when the message has been sent.
        Since:
        10.0.46
      • getHtml

        default java.lang.String getHtml()
        Returns:
        the html text of the message as string
        Since:
        10.0.46
      • getAttachments

        default java.util.Set<MessageAttachmentDataSource> getAttachments()
        Returns:
        a Set of MailAttachmentDataSource objects
        Since:
        10.0.46
      • getXHeaders

        default java.util.Map<java.lang.String,​java.lang.String> getXHeaders()
        This method allows to define additional X-Headers. Allowed characters for the key are: [a-z][A-Z][0-9]-_ All keys contained within the map will be prefixed automatically with a "X-" and added as header to the generated message.
        Returns:
        the Map of additional X-Headers
        Since:
        10.0.142
      • getContactIdentifier

        default java.util.Optional<ContactIdentifier> getContactIdentifier()
        This method returns the additional contact information used as secondary search criteria while searching an existing contact. The attributes will be assigned to the existing or newly created contact.
        Returns:
        the optional contact identifier or an empty optional if no contact identifier is provided
        Since:
        11.32