com.communote.server.core.mail

Class FileSystemMimeMessageSender

java.lang.Object

com.communote.server.core.mail.FileSystemMimeMessageSender

All Implemented Interfaces:

MimeMessageSender

public class FileSystemMimeMessageSender
extends Object
implements MimeMessageSender

MimeMessageSender which stores the message on the filesystem in a sub-directory of Communote's data directory. Mainly useful for development and tests.

Since:

3.5

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	MESSAGE_STORAGE_SUB_DIR

Constructor Summary

Constructors

Constructor and Description
FileSystemMimeMessageSender(boolean messageIdBasedFilename)

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 message) 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 MimeMessageSender.send(MimeMessage).

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_STORAGE_SUB_DIR

public static final String MESSAGE_STORAGE_SUB_DIR

See Also:

Constant Field Values

Constructor Detail

FileSystemMimeMessageSender

public FileSystemMimeMessageSender(boolean messageIdBasedFilename)

Parameters:

messageIdBasedFilename - whether to create file name from message ID or the subject

Method Detail

createMimeMessage

public javax.mail.internet.MimeMessage createMimeMessage()

Specified by:

createMimeMessage in interface MimeMessageSender

Returns:

an empty mime message to be filled by the caller

send

public void send(javax.mail.internet.MimeMessage message)
          throws org.springframework.mail.MailException

Description copied from interface: MimeMessageSender

Send the mime message.

Specified by:

send in interface MimeMessageSender

Parameters:

message - the message to send

Throws:

org.springframework.mail.MailException

testSettings

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

Description copied from interface: MimeMessageSender

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

Specified by:

testSettings in interface MimeMessageSender

Parameters:

settings - the configuration to test

Returns:

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

testSettings

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

Description copied from interface: MimeMessageSender

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

Specified by:

testSettings in interface MimeMessageSender

Parameters:

settings - the configuration to test

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

Returns:

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

updateSettings

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

Description copied from interface: MimeMessageSender

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

Specified by:

updateSettings in interface MimeMessageSender

Parameters:

settings - the new settings