com.communote.server.core.mail

Class MailSenderImpl

java.lang.Object

com.communote.server.core.mail.MailSenderImpl

All Implemented Interfaces:

MailSender

@Service(value="mailSender")
public class MailSenderImpl
extends Object
implements MailSender

Since:

3.5

Author:

Communote team - http://communote.github.io/

Constructor Summary

Constructors

Constructor and Description
MailSenderImpl(org.apache.velocity.app.VelocityEngine velocityEngine)

Method Summary

Modifier and Type	Method and Description
void	send(MailMessage message) Send the given message.
boolean	testSettings(Map<ApplicationPropertyMailing,String> settings) Test the given mail-out configuration.
boolean	testSettings(Map<ApplicationPropertyMailing,String> settings, MailMessage testMessage) Test the given mail-out configuration and send a test message.
void	updateSettings(Map<ApplicationPropertyMailing,String> settings) Update the mail-out configuration so that subsequent calls to MailSender.send(MailMessage) will use the new settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailSenderImpl

@Autowired
public MailSenderImpl(org.apache.velocity.app.VelocityEngine velocityEngine)

Method Detail

send

public void send(MailMessage message)
          throws MailingException

Description copied from interface: MailSender

Send the given message.

Specified by:

send in interface MailSender

Throws:

MailingException - in case there was an error sending the message

testSettings

public boolean testSettings(Map<ApplicationPropertyMailing,String> settings)

Description copied from interface: MailSender

Test the given mail-out configuration. Depending on the used MimeMessageSender this might include a connection test with the server.

Specified by:

testSettings in interface MailSender

Parameters:

settings - the settings to test

Returns:

true if the settings were tested successfully, false otherwise. Occurred exceptions will be logged.

testSettings

public boolean testSettings(Map<ApplicationPropertyMailing,String> settings,
                            MailMessage testMessage)

Description copied from interface: MailSender

Test the given mail-out configuration and send a test message.

Specified by:

testSettings in interface MailSender

Parameters:

settings - the settings to test

testMessage - the test message to send

Returns:

true if the settings were tested successfully and the test message was sent without error, false otherwise. Occurred exceptions will be logged.

updateSettings

public void updateSettings(Map<ApplicationPropertyMailing,String> settings)
                    throws ConfigurationUpdateException

Description copied from interface: MailSender

Update the mail-out configuration so that subsequent calls to MailSender.send(MailMessage) will use the new settings. This method won't test the settings for validity.

Specified by:

updateSettings in interface MailSender

Parameters:

settings - the new configuration

Throws:

ConfigurationUpdateException - in case the configuration could not be updated