Package com.atlassian.confluence.mail.template

Class AbstractMailNotificationQueueItem

java.lang.Object
com.atlassian.confluence.mail.template.AbstractMailNotificationQueueItem
All Implemented Interfaces:
com.atlassian.core.task.Task, com.atlassian.mail.queue.MailQueueItem, Serializable, Comparable<com.atlassian.mail.queue.MailQueueItem>
Direct Known Subclasses:
MailNotificationQueueItem, NonUserMailNotificationQueueItem
@Deprecated(forRemoval=true, since="9.4") public abstract class AbstractMailNotificationQueueItem extends Object implements com.atlassian.mail.queue.MailQueueItem, com.atlassian.core.task.Task
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4
An abstract mail notification queue item that provides default implementations of most methods.
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    AbstractMailNotificationQueueItem.EncodeUtil
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected String
    body
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected Date
    dateQueued
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    MIME_TYPE_HTML
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    MIME_TYPE_TEXT
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractMailNotificationQueueItem(String templateContent)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    AbstractMailNotificationQueueItem(String templateLocation, String templateFileName)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addUtilsToContext(Map<String,Object> contextParams)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    addVelocityContextParam(String name, Object value)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    clearContext()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    compareTo(com.atlassian.mail.queue.MailQueueItem that)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected abstract com.atlassian.mail.Email
    createMailObject()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    execute()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getBody()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Date
    getDateQueued()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getLastError()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getRenderedContent()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getRenderedContent(String content)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    int
    getSendCount()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getSubject()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getTemplateContent()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getTemplateFileName()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    String
    getTemplateLocation()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Object
    getVelocityContextParam(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    hasError()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    incrementSendCount()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected static boolean
    isRecognisedMimeType(String mimePref)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    preRenderBody(Map<String,Object> contextMap)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method will not retain a local copy of the contextMap - making it advantageous for pre-rendering templates with contexts comprising of transient or session-based data.
    Object
    removeVelocityContextParam(String name)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    renderTemplate(String templateLocation, String templateName, Map<String,Object> contextMap)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected com.atlassian.mail.server.SMTPMailServer
    retrieveMailServer()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    send()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setBody(String body)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected void
    setLastError(String lastError)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setSubject(String subject)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTemplateContent(String templateContent)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTemplateFileName(String templateFileName)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    setTemplateLocation(String templateLocation)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    protected String
    transformForEmail(String input)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • dateQueued

      protected Date dateQueued
      Deprecated, for removal: This API element is subject to removal in a future version.

    • MIME_TYPE_HTML

      public static final String MIME_TYPE_HTML
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • MIME_TYPE_TEXT

      public static final String MIME_TYPE_TEXT
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • body

      protected String body
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • AbstractMailNotificationQueueItem

      public AbstractMailNotificationQueueItem(String templateContent)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • AbstractMailNotificationQueueItem

      public AbstractMailNotificationQueueItem(String templateLocation, String templateFileName)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • compareTo

      public int compareTo(com.atlassian.mail.queue.MailQueueItem that)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      compareTo in interface Comparable<com.atlassian.mail.queue.MailQueueItem>

    • getLastError

      public String getLastError()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setLastError

      protected void setLastError(String lastError)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getSubject

      public String getSubject()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getSubject in interface com.atlassian.mail.queue.MailQueueItem

    • getDateQueued

      public Date getDateQueued()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getDateQueued in interface com.atlassian.mail.queue.MailQueueItem

    • getSendCount

      public int getSendCount()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      getSendCount in interface com.atlassian.mail.queue.MailQueueItem

    • setSubject

      public void setSubject(String subject)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • hasError

      public boolean hasError()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      hasError in interface com.atlassian.mail.queue.MailQueueItem

    • execute

      public void execute() throws Exception
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      execute in interface com.atlassian.core.task.Task
      Throws:
      Exception

    • send

      public void send() throws com.atlassian.mail.MailException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      send in interface com.atlassian.mail.queue.MailQueueItem
      Throws:
      com.atlassian.mail.MailException

    • createMailObject

      protected abstract com.atlassian.mail.Email createMailObject()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • retrieveMailServer

      protected com.atlassian.mail.server.SMTPMailServer retrieveMailServer() throws com.atlassian.mail.MailException
      Deprecated, for removal: This API element is subject to removal in a future version.
      Throws:
      com.atlassian.mail.MailException

    • incrementSendCount

      protected void incrementSendCount()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isRecognisedMimeType

      protected static boolean isRecognisedMimeType(String mimePref)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • addVelocityContextParam

      public void addVelocityContextParam(String name, Object value)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • removeVelocityContextParam

      public Object removeVelocityContextParam(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • clearContext

      public void clearContext()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getVelocityContextParam

      public Object getVelocityContextParam(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • preRenderBody

      public void preRenderBody(Map<String,Object> contextMap)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method will not retain a local copy of the contextMap - making it advantageous for pre-rendering templates with contexts comprising of transient or session-based data.

    • getRenderedContent

      public String getRenderedContent(String content)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getRenderedContent

      public String getRenderedContent()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • addUtilsToContext

      public static void addUtilsToContext(Map<String,Object> contextParams)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTemplateFileName

      public String getTemplateFileName()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTemplateFileName

      public void setTemplateFileName(String templateFileName)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTemplateContent

      public String getTemplateContent()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTemplateContent

      public void setTemplateContent(String templateContent)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getTemplateLocation

      public String getTemplateLocation()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setTemplateLocation

      public void setTemplateLocation(String templateLocation)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getBody

      public String getBody()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setBody

      public void setBody(String body)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • transformForEmail

      protected String transformForEmail(String input)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • renderTemplate

      protected String renderTemplate(String templateLocation, String templateName, Map<String,Object> contextMap)
      Deprecated, for removal: This API element is subject to removal in a future version.