com.atlassian.jira.mail

Class IssueMailQueueItem

java.lang.Object

com.atlassian.mail.queue.AbstractMailQueueItem

com.atlassian.jira.mail.IssueMailQueueItem

All Implemented Interfaces:

com.atlassian.mail.queue.MailQueueItem, Comparable<com.atlassian.mail.queue.MailQueueItem>

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

Field Summary

Fields inherited from class com.atlassian.mail.queue.AbstractMailQueueItem

mailThreader

Constructor Summary

Constructors

Constructor and Description

IssueMailQueueItem(TemplateContextFactory templateContextFactory, IssueEvent event, Long templateId, Set<NotificationRecipient> recipientList, String notificationType, JiraAuthenticationContext authenticationContext, MailingListCompiler mailingListCompiler, TemplateManager templateManager, VelocityTemplatingEngine templatingEngine, com.atlassian.mail.server.MailServerManager mailServerManager, PermissionManager permissionManager) Create an issue mail queue item.

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getIssueContextParams(Locale locale, IssueEvent iEvent)
Set<NotificationRecipient>	getRecipientList() Used in testing only
String	getSubject() This is the subject as displayed in the Mail Queue Admin page.
void	send()
String	toString()

Methods inherited from class com.atlassian.mail.queue.AbstractMailQueueItem

compareTo, 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,
                          Long templateId,
                          Set<NotificationRecipient> recipientList,
                          String notificationType,
                          JiraAuthenticationContext authenticationContext,
                          MailingListCompiler mailingListCompiler,
                          TemplateManager templateManager,
                          VelocityTemplatingEngine templatingEngine,
                          com.atlassian.mail.server.MailServerManager mailServerManager,
                          PermissionManager permissionManager)

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

templatingEngine - velocity templating engine

mailServerManager - mail server manager

permissionManager - permission manager

See Also:

IssueMailQueueItemFactory

Method Detail

getSubject

public 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

send

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

Throws:

com.atlassian.mail.MailException

toString

public String toString()

Overrides:

toString in class Object

getIssueContextParams

protected Map<String,Object> getIssueContextParams(Locale locale,
                                                   IssueEvent iEvent)
                                            throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getRecipientList

public Set<NotificationRecipient> getRecipientList()

Used in testing only

Returns:

recipientList the set of recipients to recieve this email notification