Interface MailQueueItem

All Superinterfaces:
KeyValuePair<String,String>, Persistent, Serializable

public interface MailQueueItem extends Persistent
Item in the mail queue.
  • Method Details

    • getMailAsBytes

      byte[] getMailAsBytes()
      Returns:
      The Message object as byte array.
    • getCreatedAt

      Date getCreatedAt()
      Returns:
      The creation date of the mail queue item.
    • getLastTry

      Date getLastTry()
      Returns:
      The date when email of mail queue item has been tried to send the last time.
    • getStatus

      String getStatus()
      Returns:
      The status of the mail queue item. If a new mail queue item has been inserted (without errors), the status is 'new'. In case of an error during sending the mail, the error message is returned.
    • getSubject

      String getSubject()
      Returns:
      The subject of the mail object.
    • getSender

      Persistent getSender()
      Returns:
      A User or a MailBox object representing the sender. But can be null, if an email has been sent with the default sender settings, e.g. sending an email to the administrator with Admin sendToAdmin() methods.
    • getReferencedObject

      Persistent getReferencedObject()
      Returns:
      The referenced object in "@enterprise" as Persistent, e.g. the "@enterprise" Email object in case of sending email via appropriate tab at process instance.
    • isLogged

      boolean isLogged()
      Returns:
      true, if the message is also stored in MessageJournal, otherwise false
    • setReferencedObject

      void setReferencedObject(Persistent refObj)
      Possibility to set the reference of the mail queue item in "@enterprise" which is represented by a Persistent.
      Parameters:
      refObj - the representation of the Message object in "@enterprise" of that mail queue item.