com.atlassian.jira.mail
Class IssueMailQueueItem

java.lang.Object
  extended by com.atlassian.mail.queue.AbstractMailQueueItem
      extended by com.atlassian.jira.mail.IssueMailQueueItem
All Implemented Interfaces:
com.atlassian.core.task.Task, com.atlassian.mail.queue.MailQueueItem, java.io.Serializable

public class IssueMailQueueItem
extends com.atlassian.mail.queue.AbstractMailQueueItem

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.atlassian.mail.queue.AbstractMailQueueItem
mailThreader
 
Constructor Summary
IssueMailQueueItem(TemplateContextFactory templateContextFactory, IssueEvent event, java.lang.Long templateId, java.util.Set recipientList, java.lang.String notificationType, JiraAuthenticationContext authenticationContext, MailingListCompiler mailingListCompiler, TemplateManager templateManager)
          Create an issue mail queue item.
 
Method Summary
 IssueEvent getEvent()
           
protected  java.util.Map getIssueContextParams(IssueEvent iEvent)
           
 java.util.Set getRecipientList()
          Used in testing only
 java.lang.String getSubject()
          This is the subject as displayed in the Mail Queue Admin page.
 java.lang.Long getTemplateId()
           
 void send()
           
 java.lang.String toString()
           
 
Methods inherited from class com.atlassian.mail.queue.AbstractMailQueueItem
execute, getDateQueued, getSendCount, hasError, incrementSendCount, setMailThreader
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IssueMailQueueItem

public IssueMailQueueItem(TemplateContextFactory templateContextFactory,
                          IssueEvent event,
                          java.lang.Long templateId,
                          java.util.Set recipientList,
                          java.lang.String notificationType,
                          JiraAuthenticationContext authenticationContext,
                          MailingListCompiler mailingListCompiler,
                          TemplateManager templateManager)
Create an issue mail queue item.

Parameters:
templateContextFactory - template context factory
event - the event that is the subject of this mail item.
templateId - the template ID for this mail item.
recipientList - a list of recipients for this mail item.
notificationType - notification type
authenticationContext - authentication context
mailingListCompiler - mailing list compiler
See Also:
IssueMailQueueItemFactory
Method Detail

getSubject

public java.lang.String getSubject()
This is the subject as displayed in the Mail Queue Admin page. The subject is displayed in the preference language of the current user viewing items to be sent (i.e. different from items CURRENTLY being sent).

The subject will be displayed in the preference language of the mail recipient once the mail is actually being sent. When the mail is being sent, it is a SingleMailQueueItem.

Specified by:
getSubject in interface com.atlassian.mail.queue.MailQueueItem
Overrides:
getSubject in class com.atlassian.mail.queue.AbstractMailQueueItem
Returns:
String the subject as displayed on the mail queue admin page

getEvent

public IssueEvent getEvent()

getTemplateId

public java.lang.Long getTemplateId()

send

public void send()
          throws com.atlassian.mail.MailException
Throws:
com.atlassian.mail.MailException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getIssueContextParams

protected java.util.Map getIssueContextParams(IssueEvent iEvent)
                                       throws org.ofbiz.core.entity.GenericEntityException,
                                              com.opensymphony.user.EntityNotFoundException
Throws:
org.ofbiz.core.entity.GenericEntityException
com.opensymphony.user.EntityNotFoundException

getRecipientList

public java.util.Set getRecipientList()
Used in testing only

Returns:
recipientList the set of recipients to recieve this email notification


Copyright © 2002-2010 Atlassian. All Rights Reserved.