org.codemonkey.simplejavamail.TransportStrategy Maven / Gradle / Ivy
Show all versions of simple-java-mail Show documentation
package org.codemonkey.simplejavamail;
import java.util.Properties;
import javax.mail.Session;
/**
* Defines the various types of transport protocols and implements respective properties so that a {@link Session} may be configured using a
* TransportStrategy implementation.
*
* @author Benny Bottema
*/
public enum TransportStrategy {
/**
* Simplest possible form: only vanilla ".smtp." property names and no extra properties. Additionally the transport protocol is
* explicitly set to smtp.
*/
SMTP_PLAIN {
/**
* Here protocol is set to smtp.
*
* @see TransportStrategy#SMTP_PLAIN
*/
@Override
public Properties generateProperties() {
final Properties props = super.generateProperties();
props.put("mail.transport.protocol", "smtp");
return props;
};
/**
* @return "mail.smtp.host"
*/
@Override
String propertyNameHost() {
return "mail.smtp.host";
};
/**
* @return "mail.smtp.port"
*/
@Override
String propertyNamePort() {
return "mail.smtp.port";
};
/**
* @return "mail.smtp.username"
*/
@Override
String propertyNameUsername() {
return "mail.smtp.username";
};
/**
* @return "mail.smtps.auth"
*/
@Override
String propertyNameAuthenticate() {
return "mail.smtp.auth";
};
},
/**
* SMTPS / SSL transport strategy, that returns the ".smtps." variation of the SMTP_PLAIN version. Additionally the transport protocol
* is explicitly set to smtps. Finally, he property "mail.smtps.quitwait" is set to false, to get rid of a strange SSL exception:
*
*
* javax.mail.MessagingException: Exception reading response;
* nested exception is:
* javax.net.ssl.SSLException: Unsupported record version Unknown-50.49
* (..)
*
*
* The mail is sent but the exception is unwanted. The property quitwait means If set to false, the QUIT command is sent
* and the connection is immediately closed. If set to true (the default), causes the transport to wait for the response to the QUIT
* command
* - source
*/
SMTP_SSL {
/**
* Here protocol is set to smtps and the quitwait property is set as well.
*
* @see TransportStrategy#SMTP_SSL
*/
@Override
public Properties generateProperties() {
final Properties props = super.generateProperties();
props.put("mail.transport.protocol", "smtps");
props.put("mail.smtps.quitwait", "false");
return props;
};
/**
* @return "mail.smtps.host"
*/
@Override
String propertyNameHost() {
return "mail.smtps.host";
};
/**
* @return "mail.smtps.port"
*/
@Override
String propertyNamePort() {
return "mail.smtps.port";
};
/**
* @return "mail.smtps.username"
*/
@Override
String propertyNameUsername() {
return "mail.smtps.username";
};
/**
* @return "mail.smtps.auth"
*/
@Override
String propertyNameAuthenticate() {
return "mail.smtps.auth";
};
},
/**
* NOTE: this code is in untested beta state
*
* Uses standard ".smtp." property names (like {@link TransportStrategy#SMTP_PLAIN}). Additionally the transport protocol is explicitly
* set to smtp. Finally, the property "mail.smtp.starttls.enable" is being set to true.
*/
SMTP_TLS {
@Override
public Properties generateProperties() {
final Properties props = super.generateProperties();
props.put("mail.transport.protocol", "smtp");
props.put("mail.smtp.starttls.enable", "true");
return props;
}
/**
* @return "mail.smtp.host"
*/
@Override
String propertyNameHost() {
return "mail.smtp.host";
};
/**
* @return "mail.smtp.port"
*/
@Override
String propertyNamePort() {
return "mail.smtp.port";
};
/**
* @return "mail.smtp.username"
*/
@Override
String propertyNameUsername() {
return "mail.smtp.username";
};
/**
* @return "mail.smtps.auth"
*/
@Override
String propertyNameAuthenticate() {
return "mail.smtp.auth";
};
};
/**
* Base implementation that simply returns an empty list of properties. Should be overridden by the various strategies where
* appropriate.
*
* @return An empty Properties instance.
*/
public Properties generateProperties() {
return new Properties();
}
abstract String propertyNameHost();
abstract String propertyNamePort();
abstract String propertyNameUsername();
abstract String propertyNameAuthenticate();
};