com.communote.server.core.mail

Interface MimeMessageSender

All Known Implementing Classes:

CatchAllSmtpMimeMessageSender, FileSystemMimeMessageSender, SmtpMimeMessageSender

public interface MimeMessageSender

Send a mime message.

Since:

3.5

Author:

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

Method Summary

Modifier and Type	Method and Description
javax.mail.internet.MimeMessage	createMimeMessage()
void	send(javax.mail.internet.MimeMessage message) Send the mime message.
boolean	testSettings(Map<ApplicationPropertyMailing,String> settings) Test the new configuration for sending mime messages.
boolean	testSettings(Map<ApplicationPropertyMailing,String> settings, javax.mail.internet.MimeMessage testMessage) Test the new configuration for sending mime messages and send a test message.
void	updateSettings(Map<ApplicationPropertyMailing,String> settings) Update the configuration of this mime message sender so that it will be used in subsequent invocations of send(MimeMessage).

Method Detail

createMimeMessage

javax.mail.internet.MimeMessage createMimeMessage()

Returns:

an empty mime message to be filled by the caller

send

void send(javax.mail.internet.MimeMessage message)
   throws MailingException

Send the mime message.

Parameters:

message - the message to send

Throws:

MailingException - in case sending failed

testSettings

boolean testSettings(Map<ApplicationPropertyMailing,String> settings)

Test the new configuration for sending mime messages. Implementations can for example do a connection test. Exceptions should be caught and logged.

Parameters:

settings - the configuration to test

Returns:

true if the configuration is valid for this mime message sender implementation, false otherwise.

testSettings

boolean testSettings(Map<ApplicationPropertyMailing,String> settings,
                     javax.mail.internet.MimeMessage testMessage)

Test the new configuration for sending mime messages and send a test message. Exceptions should be caught and logged.

Parameters:

settings - the configuration to test

testMessage - a test message to send. Can be null. In this case the method should behave like testSettings(Map).

Returns:

true if the configuration is valid for this mime message sender implementation, false otherwise.

updateSettings

void updateSettings(Map<ApplicationPropertyMailing,String> settings)

Update the configuration of this mime message sender so that it will be used in subsequent invocations of send(MimeMessage). Implementations don't need to validate the settings.

Parameters:

settings - the new settings