Package com.atlassian.bamboo.notification.transports

Class TextEmailTransport

java.lang.Object

com.atlassian.bamboo.notification.transports.TextEmailTransport

All Implemented Interfaces:

NotificationTransport

@ThreadSafe
public class TextEmailTransport
extends Object

Knows how to send text emails to the given email address.

Constructor Summary

Constructors

Constructor	Description
TextEmailTransport(String emailAddress, com.atlassian.event.api.EventPublisher eventPublisher, AdministrationConfigurationAccessor administrationConfigurationAccessor)

Method Summary

Modifier and Type	Method	Description
protected com.atlassian.mail.Email	beginEmail(@NotNull Notification notification)	Creates a new Email object with information that is common to all e-mail notifications.
int	compareTo(Object obj)
boolean	equals(Object o)
String	getEmailAddress()
int	hashCode()
protected void	send(com.atlassian.mail.Email email)	Publishes the e-mail event to the publishing service
void	sendNotification(@NotNull Notification notification)	Send off the notification of this transport type.
protected com.atlassian.mail.Email	updateEmail(@NotNull com.atlassian.mail.Email email, @NotNull Notification notification)	Applies notification-specific customizations to the e-mail as provided for in the ExtendedNotification interface.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextEmailTransport

public TextEmailTransport(String emailAddress,
                          com.atlassian.event.api.EventPublisher eventPublisher,
                          AdministrationConfigurationAccessor administrationConfigurationAccessor)

Method Detail

sendNotification

public void sendNotification(@NotNull
                             @NotNull Notification notification)

Description copied from interface: NotificationTransport

Send off the notification of this transport type.

Parameters:

notification - object (used to generate notification content)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

compareTo

public int compareTo(Object obj)

beginEmail

protected com.atlassian.mail.Email beginEmail(@NotNull
                                              @NotNull Notification notification)
                                       throws Exception

Creates a new Email object with information that is common to all e-mail notifications.

Parameters:

notification - the notification to be sent to the transport

Returns:

the newly initialized e-mail data

Throws:

Exception - if Notification.getEmailSubject() does

updateEmail

protected com.atlassian.mail.Email updateEmail(@NotNull
                                               @NotNull com.atlassian.mail.Email email,
                                               @NotNull
                                               @NotNull Notification notification)

Applies notification-specific customizations to the e-mail as provided for in the ExtendedNotification interface.

Parameters:

email - the e-mail to be altered

notification - the notification to be sent to the transport

Returns:

email, possibly with modifications

send

protected void send(com.atlassian.mail.Email email)

Publishes the e-mail event to the publishing service

Parameters:

email - the completed e-mail to be sent

getEmailAddress

public String getEmailAddress()