com.atlassian.crowd.manager.mail

Class MailManagerImpl

java.lang.Object

com.atlassian.crowd.manager.mail.MailManagerImpl

All Implemented Interfaces:

MailManager

public class MailManagerImpl
extends Object
implements MailManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	LINE_BEFORE_PASSWORD_IN_LOGS
static String	SANITISED_PASSWORD

Constructor Summary

Constructors

Constructor and Description
MailManagerImpl(PropertyManager propertyManager, InitialContext initialContext, com.atlassian.sal.api.ApplicationProperties applicationProperties, ClusterService clusterService, Clock clock, I18nHelper i18nHelper, AuthenticatedUserProvider authenticatedUserProvider)

Method Summary

Modifier and Type	Method and Description
MailConfiguration	getMailConfiguration() Returns current mail configuration
protected SMTPServer	getSmtpServer()
boolean	isConfigured()
protected String	removePasswordFromLogs(String logs)
void	saveConfiguration(MailConfiguration mailServerEntity) Sets the new mail configuration
void	sendHtmlEmail(javax.mail.internet.InternetAddress emailAddress, String subject, String body, String plainText) Sends an HTML email using the configured mail server (remote host / JNDI).
void	sendPlainTextEmail(javax.mail.internet.InternetAddress emailAddress, String subject, String body) Sends an email using the configured mail server (remote host / JNDI).
void	sendPlainTextEmail(javax.mail.internet.InternetAddress emailAddress, String subject, String body, Map<String,String> headers, Map<String,DataSource> attachments) Sends an email with zero or more attachments and headers using the configured mail server (remote host / JNDI).
SendTestMailResult	sendTestMail(SMTPServer smtpServer, javax.mail.internet.InternetAddress emailAddress) Send a test email using the supplied mail server (remote host / JNDI)
List<ValidationError>	validateConfiguration(MailConfiguration mailServerEntity) Verifies whether the specified MailConfiguration is valid

Methods inherited from class java.lang.Object

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

Field Detail

SANITISED_PASSWORD

public static final String SANITISED_PASSWORD

See Also:

Constant Field Values

LINE_BEFORE_PASSWORD_IN_LOGS

public static final String LINE_BEFORE_PASSWORD_IN_LOGS

See Also:

Constant Field Values

Constructor Detail

MailManagerImpl

public MailManagerImpl(PropertyManager propertyManager,
                       InitialContext initialContext,
                       com.atlassian.sal.api.ApplicationProperties applicationProperties,
                       ClusterService clusterService,
                       Clock clock,
                       I18nHelper i18nHelper,
                       AuthenticatedUserProvider authenticatedUserProvider)

Method Detail

sendHtmlEmail

public void sendHtmlEmail(javax.mail.internet.InternetAddress emailAddress,
                          String subject,
                          String body,
                          String plainText)
                   throws MailSendException

Description copied from interface: MailManager

Sends an HTML email using the configured mail server (remote host / JNDI).

Specified by:

sendHtmlEmail in interface MailManager

Parameters:

emailAddress - address of recipient.

subject - subject header. Will be appended with the configured mail subject prefix in the final email.

body - email body html.

plainText - plainText alternative to the html body text specified in body

Throws:

MailSendException - an error occured sending the email.

sendPlainTextEmail

public void sendPlainTextEmail(javax.mail.internet.InternetAddress emailAddress,
                               String subject,
                               String body)
                        throws MailSendException

Description copied from interface: MailManager

Sends an email using the configured mail server (remote host / JNDI).

Specified by:

sendPlainTextEmail in interface MailManager

Parameters:

emailAddress - address of recipient.

subject - subject header. Will be appended with the configured mail subject prefix in the final email.

body - email body text.

Throws:

MailSendException - an error occured sending the email.

sendPlainTextEmail

public void sendPlainTextEmail(javax.mail.internet.InternetAddress emailAddress,
                               String subject,
                               String body,
                               Map<String,String> headers,
                               Map<String,DataSource> attachments)
                        throws MailSendException

Description copied from interface: MailManager

Sends an email with zero or more attachments and headers using the configured mail server (remote host / JNDI).

Specified by:

sendPlainTextEmail in interface MailManager

Parameters:

emailAddress - address of recipient.

subject - subject header. Will be appended with the configured mail subject prefix in the final email.

body - email body text.

headers - custom headers to add.

attachments - [displayed filename]->[data] mapping for attachments.

Throws:

MailSendException - an error occured sending the email.

sendTestMail

public SendTestMailResult sendTestMail(SMTPServer smtpServer,
                                       javax.mail.internet.InternetAddress emailAddress)
                                throws MailSendException

Description copied from interface: MailManager

Send a test email using the supplied mail server (remote host / JNDI)

Specified by:

sendTestMail in interface MailManager

Parameters:

smtpServer - supplied SMTP Server, which will be used to send message.

emailAddress - address of recipient.

Returns:

result of test, which contains logs and status.

Throws:

MailSendException - an error occured sending the email.

validateConfiguration

public List<ValidationError> validateConfiguration(MailConfiguration mailServerEntity)

Description copied from interface: MailManager

Verifies whether the specified MailConfiguration is valid

Specified by:

validateConfiguration in interface MailManager

Parameters:

mailServerEntity - entity with attributes to be validated

Returns:

a list with errors found in the configuration

saveConfiguration

public void saveConfiguration(MailConfiguration mailServerEntity)

Description copied from interface: MailManager

Sets the new mail configuration

Specified by:

saveConfiguration in interface MailManager

Parameters:

mailServerEntity - new configuration

getMailConfiguration

public MailConfiguration getMailConfiguration()

Description copied from interface: MailManager

Returns current mail configuration

Specified by:

getMailConfiguration in interface MailManager

removePasswordFromLogs

protected String removePasswordFromLogs(String logs)

getSmtpServer

protected SMTPServer getSmtpServer()
                            throws MailSendException

Throws:

MailSendException

isConfigured

public boolean isConfigured()

Specified by:

isConfigured in interface MailManager

Returns:

true if the mail server is fully configured (does not check if the configuration is correct)