com.atlassian.jira.event.listeners.mail

Class MailListener

java.lang.Object

com.atlassian.jira.event.issue.AbstractIssueEventListener

com.atlassian.jira.event.listeners.mail.MailListener

All Implemented Interfaces:

IssueEventListener, JiraListener, UserEventListener, EventListener

Direct Known Subclasses:

DebugMailListener

public class MailListener
extends AbstractIssueEventListener
implements IssueEventListener, UserEventListener

A listener for emailing notifications.

At the moment when this listener is activated it will email the reporter, assignee and any watchers.

The content of the emails is governed by Velocity templates (in /templates) and the emails are sent out by the MailSender.

Parameters: email.from - who the emails should be sent from email.server - the SMTP server to send email through email.session - the JNDI location of a MailSession to use when sending email subject.prefix - (optional) any prefix for the subject, like "[FooBar]" -> Subject: [FooBar] BazBat

See Also:

DebugMailListener

Constructor Summary

Constructors

Constructor and Description
MailListener(UserManager userManager, IssueEventBundleMailHandler issueEventBundleMailHandler, com.atlassian.mail.queue.MailQueue mailQueue, IssueEventBundleFactory issueEventBundleFactory)

Method Summary

Modifier and Type	Method and Description
String[]	getAcceptedParams() Returns the parameters used by this listener.
String	getDescription() Returns a textual description of the listener.
protected void	handleDefaultIssueEvent(IssueEvent event) If you need to treat all the issue events equally, override this method and add logic to handle events.
void	handleIssueEventBundle(IssueEventBundle bundle)
void	init(Map params) Initialises the listener with the given parameters.
boolean	isInternal() Indicates whether this listener is internal, meaning it cannot be removed by an administrator.
boolean	isUnique() Indicates whether JIRA should only create one instance of this listener.
protected void	sendUserMail(UserEvent event, String subject, String subjectKey, String template)
void	userCannotChangePassword(UserEvent event) Fired when a user tries to change their password, and the password cannot be updated
void	userCreated(UserEvent event) Fired when a user is created automatically
void	userForgotPassword(UserEvent event) Fired when a user indicates they have forgotten their password
void	userForgotUsername(UserEvent event) Fired when a user indicates they have forgotten their username
void	userSignup(UserEvent event) Fired when a user signs up manually

Methods inherited from class com.atlassian.jira.event.issue.AbstractIssueEventListener

customEvent, getI18NBean, issueAssigned, issueClosed, issueCommentDeleted, issueCommented, issueCommentEdited, issueCreated, issueDeleted, issueGenericEvent, issueMoved, issueReopened, issueResolved, issueStarted, issueStopped, issueUpdated, issueWorklogDeleted, issueWorkLogged, issueWorklogUpdated, workflowEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.event.issue.IssueEventListener

customEvent, issueAssigned, issueClosed, issueCommented, issueCreated, issueDeleted, issueGenericEvent, issueMoved, issueReopened, issueResolved, issueStarted, issueStopped, issueUpdated, issueWorkLogged, workflowEvent

Constructor Detail

MailListener

public MailListener(UserManager userManager,
                    IssueEventBundleMailHandler issueEventBundleMailHandler,
                    com.atlassian.mail.queue.MailQueue mailQueue,
                    IssueEventBundleFactory issueEventBundleFactory)

Method Detail

init

public void init(Map params)

Description copied from interface: JiraListener

Initialises the listener with the given parameters.

Specified by:

init in interface JiraListener

Overrides:

init in class AbstractIssueEventListener

Parameters:

params - the initialisation parameters given in the Listener Properties

getAcceptedParams

public String[] getAcceptedParams()

Description copied from interface: JiraListener

Returns the parameters used by this listener.

Specified by:

getAcceptedParams in interface JiraListener

Overrides:

getAcceptedParams in class AbstractIssueEventListener

Returns:

a non-null array (can be empty)

isInternal

public boolean isInternal()

Description copied from interface: JiraListener

Indicates whether this listener is internal, meaning it cannot be removed by an administrator.

Specified by:

isInternal in interface JiraListener

Overrides:

isInternal in class AbstractIssueEventListener

Returns:

true if this is an Atlassian listener, otherwise false

isUnique

public boolean isUnique()

Description copied from interface: JiraListener

Indicates whether JIRA should only create one instance of this listener. For example, having multiple mail listeners would be fine if you wanted multiple mails sent out. For other listeners, such as cache listeners, it makes no sense to have multiple instances.

Specified by:

isUnique in interface JiraListener

Overrides:

isUnique in class AbstractIssueEventListener

Returns:

whether this listener should be a singleton

getDescription

public String getDescription()

Description copied from interface: JiraListener

Returns a textual description of the listener. You can include HTML if required, but do not use tables or DHTML, as the description may be displayed inside tables or frames.

A good description will describe what this listener does and explain the parameters required for configuring it.

Specified by:

getDescription in interface JiraListener

Overrides:

getDescription in class AbstractIssueEventListener

Returns:

a description of the listener, or null if no description is appropriate

userSignup

public void userSignup(UserEvent event)

Description copied from interface: UserEventListener

Fired when a user signs up manually

Specified by:

userSignup in interface UserEventListener

Parameters:

event - the event in play

userCreated

public void userCreated(UserEvent event)

Description copied from interface: UserEventListener

Fired when a user is created automatically

Specified by:

userCreated in interface UserEventListener

Parameters:

event - the event in play

userForgotPassword

public void userForgotPassword(UserEvent event)

Description copied from interface: UserEventListener

Fired when a user indicates they have forgotten their password

Specified by:

userForgotPassword in interface UserEventListener

Parameters:

event - the event in play

userForgotUsername

public void userForgotUsername(UserEvent event)

Description copied from interface: UserEventListener

Fired when a user indicates they have forgotten their username

Specified by:

userForgotUsername in interface UserEventListener

Parameters:

event - the event in play

userCannotChangePassword

public void userCannotChangePassword(UserEvent event)

Description copied from interface: UserEventListener

Fired when a user tries to change their password, and the password cannot be updated

Specified by:

userCannotChangePassword in interface UserEventListener

Parameters:

event - the event in play

sendUserMail

protected void sendUserMail(UserEvent event,
                            String subject,
                            String subjectKey,
                            String template)

handleIssueEventBundle

@EventListener
public void handleIssueEventBundle(IssueEventBundle bundle)

handleDefaultIssueEvent

protected void handleDefaultIssueEvent(IssueEvent event)

Description copied from class: AbstractIssueEventListener

If you need to treat all the issue events equally, override this method and add logic to handle events. All legacy event handler methods (unless overridden) in this class call this method.

Overrides:

handleDefaultIssueEvent in class AbstractIssueEventListener

Parameters:

event - The received event