public class

MailingListCompiler

extends Object
java.lang.Object
   ↳ com.atlassian.jira.mail.MailingListCompiler
Known Direct Subclasses

Class Overview

Methods responsible for sending a notification email to a list of NotificationRecipients.

Notification format (eg. text/html) is taken into account as well as comment security levels.

Summary

Public Constructors
MailingListCompiler(TemplateManager templateManager, ProjectRoleManager projectRoleManager)
Public Methods
@Deprecated static String getEmailAddresses(Set<String> addresses)
This method is deprecated. just use Joiner.on(",").join(addresses)
void sendLists(Set<NotificationRecipient> recipients, String sender, String senderFrom, Long templateId, String baseUrl, Map<StringObject> contextParams, MailThreader threader)
This function works out where the mail message has originated and then sets up the correct parameters.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public MailingListCompiler (TemplateManager templateManager, ProjectRoleManager projectRoleManager)

Public Methods

@Deprecated public static String getEmailAddresses (Set<String> addresses)

This method is deprecated.
just use Joiner.on(",").join(addresses)

Returns a comma-separated list of the given email addresses.

Parameters
addresses email addresses
Returns
  • the list of addresses.

public void sendLists (Set<NotificationRecipient> recipients, String sender, String senderFrom, Long templateId, String baseUrl, Map<StringObject> contextParams, MailThreader threader)

This function works out where the mail message has originated and then sets up the correct parameters. It allows comments to be hidden in the email from users that do not have permissions to see them.

Parameters
recipients Set of NotificationRecipients
sender sender
senderFrom sender from
templateId the velocity template ID
baseUrl base url
contextParams map of context parameters
threader mail threader
Throws
VelocityException if notification compiler fails