com.communote.server.core.mail

Class SmtpMimeMessageSender

java.lang.Object

com.communote.server.core.mail.SmtpMimeMessageSender

All Implemented Interfaces:

MimeMessageSender

Direct Known Subclasses:

CatchAllSmtpMimeMessageSender

public class SmtpMimeMessageSender
extends Object
implements MimeMessageSender

MimeMessageSender which uses SMTP to send the message.

Since:

3.5

Author:

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

Constructor Summary

Constructors

Constructor and Description
SmtpMimeMessageSender(Map<ApplicationPropertyMailing,String> settings)

Method Summary

Modifier and Type	Method and Description
javax.mail.internet.MimeMessage	createMimeMessage()
protected org.springframework.mail.javamail.JavaMailSenderImpl	createSender(Map<ApplicationPropertyMailing,String> settings)
void	send(javax.mail.internet.MimeMessage message) Send the mime message.
protected void	testConnection(org.springframework.mail.javamail.JavaMailSenderImpl sender)
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 MimeMessageSender.send(MimeMessage).

Methods inherited from class java.lang.Object

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

Constructor Detail

SmtpMimeMessageSender

public SmtpMimeMessageSender(Map<ApplicationPropertyMailing,String> settings)

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

createSender

protected org.springframework.mail.javamail.JavaMailSenderImpl createSender(Map<ApplicationPropertyMailing,String> settings)

send

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

Description copied from interface: MimeMessageSender

Send the mime message.

Specified by:

send in interface MimeMessageSender

Parameters:

message - the message to send

Throws:

MailingException - in case sending failed

testConnection

protected void testConnection(org.springframework.mail.javamail.JavaMailSenderImpl sender)
                       throws javax.mail.MessagingException

Throws:

javax.mail.MessagingException

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 testMessage)

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

testMessage - 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