com.communote.server.core.mail

Interface MailSender

All Known Implementing Classes:

MailSenderImpl

public interface MailSender

Component for sending mails. The mail sender converts MailMessages into MimeMessages and uses a MimeMessageSender to transport them.

Since:

3.5

Author:

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

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 send(MailMessage) will use the new settings.

Method Detail

send

void send(MailMessage message)
   throws MailingException

Send the given message.

Parameters:

message -

Throws:

MailingException - in case there was an error sending the message

testSettings

boolean testSettings(Map<ApplicationPropertyMailing,String> settings)

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

Parameters:

settings - the settings to test

Returns:

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

testSettings

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

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

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

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

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

Parameters:

settings - the new configuration

Throws:

ConfigurationUpdateException - in case the configuration could not be updated