org.sonar.plugins.emailnotifications

Class EmailNotificationChannel

java.lang.Object

org.sonar.api.notifications.NotificationChannel

org.sonar.plugins.emailnotifications.EmailNotificationChannel

All Implemented Interfaces:

Extension, ServerComponent, ServerExtension

public class EmailNotificationChannel
extends NotificationChannel

References:

• Registration of Mail and MIME Header Fields
• List-Id: A Structured Field and Namespace for the Identification of Mailing Lists
• GitHub: Threaded Email Notifications

Since:

2.10

Constructor Summary

Constructors

Constructor and Description
EmailNotificationChannel(EmailConfiguration configuration, EmailTemplate[] templates, UserFinder userFinder)

Method Summary

Methods

Modifier and Type	Method and Description
void	deliver(Notification notification, String username) Implements the delivery of the given notification to the given user.
void	sendTestEmail(String toAddress, String subject, String message) Send test email.

Methods inherited from class org.sonar.api.notifications.NotificationChannel

getKey, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailNotificationChannel

public EmailNotificationChannel(EmailConfiguration configuration,
                        EmailTemplate[] templates,
                        UserFinder userFinder)

Method Detail

deliver

public void deliver(Notification notification,
           String username)

Description copied from class: NotificationChannel

Implements the delivery of the given notification to the given user.

Specified by:

deliver in class NotificationChannel

Parameters:

notification - the notification to deliver

username - the login of the user who should receive the notification

sendTestEmail

public void sendTestEmail(String toAddress,
                 String subject,
                 String message)
                   throws org.apache.commons.mail.EmailException

Send test email. This method called from Ruby.

Throws:

org.apache.commons.mail.EmailException - when unable to send