Package com.atlassian.crowd.manager.mail

Class MailManagerImpl

java.lang.Object

com.atlassian.crowd.manager.mail.MailManagerImpl

All Implemented Interfaces:

MailConfigurationService, MailManager

public class MailManagerImpl
extends Object
implements MailManager

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor

Description

MailManagerImpl(InternalPropertyManager propertyManager, com.atlassian.sal.api.ApplicationProperties applicationProperties, ClusterService clusterService, Clock clock, I18nHelper i18nHelper, MailSendManager sendManager, AuthenticatedUserProvider authenticatedUserProvider, EmailAddressValidator emailValidator, com.atlassian.event.api.EventPublisher eventPublisher, ClientConfigStorageServiceSupplier clientConfigStorageServiceSupplier)

Method Summary

Modifier and Type	Method	Description
MailConfiguration	getMailConfiguration()
boolean	isConfigured()
protected String	removePasswordFromLogs(String logs)
void	saveConfiguration(MailConfiguration mailConfiguration)	Saves mail configuration
void	sendEmail(EmailMessage messageToSend)	Sends a single email using the configured mail server
Set<? extends EmailMessage>	sendEmails(Collection<? extends EmailMessage> messagesToSend)	Sends multiple emails using the configured mail server.
SendTestMailResult	sendTestMail(SMTPServer smtpServer, jakarta.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 Details

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 Details

MailManagerImpl

public MailManagerImpl(InternalPropertyManager propertyManager,
 com.atlassian.sal.api.ApplicationProperties applicationProperties,
 ClusterService clusterService,
 Clock clock,
 I18nHelper i18nHelper,
 MailSendManager sendManager,
 AuthenticatedUserProvider authenticatedUserProvider,
 EmailAddressValidator emailValidator,
 com.atlassian.event.api.EventPublisher eventPublisher,
 ClientConfigStorageServiceSupplier clientConfigStorageServiceSupplier)

Method Details

sendTestMail

public SendTestMailResult sendTestMail(SMTPServer smtpServer,
 jakarta.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 occurred sending the email.

sendEmails

public Set<? extends EmailMessage> sendEmails(Collection<? extends EmailMessage> messagesToSend)
                                       throws MailSendException

Description copied from interface: MailManager

Sends multiple emails using the configured mail server.

Specified by:

sendEmails in interface MailManager

Returns:

a collection of messages that failed to be sent

Throws:

MailSendException - an error occurred that prevented sending any email (connection error, configuration error, etc.).

sendEmail

public void sendEmail(EmailMessage messageToSend)
               throws MailSendException

Description copied from interface: MailManager

Sends a single email using the configured mail server

Specified by:

sendEmail in interface MailManager

Parameters:

messageToSend - single email using the configured mail server

Throws:

MailSendException - an error occurred 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 mailConfiguration)

Description copied from interface: MailConfigurationService

Saves mail configuration

Specified by:

saveConfiguration in interface MailConfigurationService

Parameters:

mailConfiguration - entity with mail configuration.

getMailConfiguration

public MailConfiguration getMailConfiguration()

Specified by:

getMailConfiguration in interface MailConfigurationService

Returns:

Mail configuration

removePasswordFromLogs

protected String removePasswordFromLogs(String logs)

isConfigured

public boolean isConfigured()

Specified by:

isConfigured in interface MailConfigurationService

Returns:

true if the mail server is fully configured, regardless of the configuration's validity