com.atlassian.mail.server.impl

Class SMTPMailServerImpl

java.lang.Object

com.atlassian.mail.server.AbstractMailServer

com.atlassian.mail.server.impl.SMTPMailServerImpl

All Implemented Interfaces:

MailServer, SMTPMailServer, Serializable

public class SMTPMailServerImpl
extends AbstractMailServer
implements SMTPMailServer

See Also:

Serialized Form

Field Summary

Fields inherited from class com.atlassian.mail.server.AbstractMailServer

isAuthenticating, log

Fields inherited from interface com.atlassian.mail.server.SMTPMailServer

DEFAULT_SMTP_PORT

Constructor Summary

Constructors

Constructor and Description
SMTPMailServerImpl()
SMTPMailServerImpl(Long id, String name, String description, String from, String prefix, boolean isSession, boolean removePrecedence, MailProtocol protocol, String location, String smtpPort, boolean tlsRequired, String username, String password, long timeout)
SMTPMailServerImpl(Long id, String name, String description, String from, String prefix, boolean isSession, boolean removePrecedence, MailProtocol protocol, String location, String smtpPort, boolean tlsRequired, String username, String password, long timeout, String socksHost, String socksPort)
SMTPMailServerImpl(Long id, String name, String description, String from, String prefix, boolean isSession, MailProtocol protocol, String location, String smtpPort, boolean tlsRequired, String username, String password)
SMTPMailServerImpl(Long id, String name, String description, String from, String prefix, boolean isSession, MailProtocol protocol, String location, String smtpPort, boolean tlsRequired, String username, String password, long timeout)
SMTPMailServerImpl(Long id, String name, String description, String from, String prefix, boolean isSession, MailProtocol protocol, String location, String smtpPort, boolean tlsRequired, String username, String password, long timeout, String socksHost, String socksPort)
SMTPMailServerImpl(Long id, String name, String description, String from, String prefix, boolean isSession, String location, String username, String password)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
protected javax.mail.Authenticator	getAuthenticator()
String	getDefaultFrom()
String	getJndiLocation()
protected Object	getJndiSession()
String	getPrefix()
javax.mail.Session	getSession() get the mail session
String	getType()
int	hashCode()
boolean	isRemovePrecedence()
boolean	isSessionServer()
protected void	propertyChanged() Discard the cached session when a property of the server changes.
void	quietSend(Email email) Send a message - but don't throw exceptions, just log the errors
void	send(Email email) Sends the given email.
protected void	sendMimeMessage(javax.mail.internet.MimeMessage message, javax.mail.Transport transport) Extracted method, it can be used for testing purposes.
void	sendWithMessageId(Email email, String messageId) Sends the given email using the given Message-ID header.
void	setDefaultFrom(String defaultFrom)
void	setJndiLocation(String jndiLocation)
void	setPrefix(String prefix)
void	setRemovePrecedence(boolean precedence)
void	setSessionServer(boolean sessionServer)
String	toString()

Methods inherited from class com.atlassian.mail.server.AbstractMailServer

getConnectionTimeout, getDebug, getDebugStream, getDescription, getHostname, getId, getMailProtocol, getMoreDebugInfoAboutCreatedSession, getName, getPassword, getPort, getProperties, getSessionFromServerManager, getSocksHost, getSocksPort, getTimeout, getUsername, isTlsRequired, loadSystemProperties, setConnectionTimeout, setDebug, setDebugStream, setDescription, setHostname, setId, setLogger, setMailProtocol, setName, setPassword, setPort, setProperties, setSocksHost, setSocksPort, setTimeout, setTlsRequired, setUsername

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.mail.server.SMTPMailServer

getDebug, getDebugStream, isTlsRequired, setDebug, setTlsRequired

Methods inherited from interface com.atlassian.mail.server.MailServer

getDescription, getHostname, getId, getMailProtocol, getName, getPassword, getPort, getProperties, getSocksHost, getSocksPort, getTimeout, getUsername, setDebugStream, setDescription, setHostname, setId, setLogger, setMailProtocol, setName, setPassword, setPort, setProperties, setSocksHost, setSocksPort, setTimeout, setUsername

Constructor Detail

SMTPMailServerImpl

public SMTPMailServerImpl()

SMTPMailServerImpl

public SMTPMailServerImpl(Long id,
                          String name,
                          String description,
                          String from,
                          String prefix,
                          boolean isSession,
                          String location,
                          String username,
                          String password)

SMTPMailServerImpl

public SMTPMailServerImpl(Long id,
                          String name,
                          String description,
                          String from,
                          String prefix,
                          boolean isSession,
                          MailProtocol protocol,
                          String location,
                          String smtpPort,
                          boolean tlsRequired,
                          String username,
                          String password)

SMTPMailServerImpl

public SMTPMailServerImpl(Long id,
                          String name,
                          String description,
                          String from,
                          String prefix,
                          boolean isSession,
                          MailProtocol protocol,
                          String location,
                          String smtpPort,
                          boolean tlsRequired,
                          String username,
                          String password,
                          long timeout)

SMTPMailServerImpl

public SMTPMailServerImpl(Long id,
                          String name,
                          String description,
                          String from,
                          String prefix,
                          boolean isSession,
                          MailProtocol protocol,
                          String location,
                          String smtpPort,
                          boolean tlsRequired,
                          String username,
                          String password,
                          long timeout,
                          String socksHost,
                          String socksPort)

SMTPMailServerImpl

public SMTPMailServerImpl(Long id,
                          String name,
                          String description,
                          String from,
                          String prefix,
                          boolean isSession,
                          boolean removePrecedence,
                          MailProtocol protocol,
                          String location,
                          String smtpPort,
                          boolean tlsRequired,
                          String username,
                          String password,
                          long timeout)

SMTPMailServerImpl

public SMTPMailServerImpl(Long id,
                          String name,
                          String description,
                          String from,
                          String prefix,
                          boolean isSession,
                          boolean removePrecedence,
                          MailProtocol protocol,
                          String location,
                          String smtpPort,
                          boolean tlsRequired,
                          String username,
                          String password,
                          long timeout,
                          String socksHost,
                          String socksPort)

Method Detail

getJndiLocation

public String getJndiLocation()

Specified by:

getJndiLocation in interface SMTPMailServer

setJndiLocation

public void setJndiLocation(String jndiLocation)

Specified by:

setJndiLocation in interface SMTPMailServer

getAuthenticator

protected javax.mail.Authenticator getAuthenticator()

Specified by:

getAuthenticator in class AbstractMailServer

getSession

public javax.mail.Session getSession()
                              throws NamingException,
                                     MailException

get the mail session

Specified by:

getSession in interface MailServer

Throws:

NamingException

MailException

getJndiSession

protected Object getJndiSession()
                         throws NamingException

Throws:

NamingException

send

public void send(Email email)
          throws MailException

Description copied from interface: SMTPMailServer

Sends the given email.

For backward-compatibility, this method will ignore any Message-ID header set in the email parameter, and let JavaMail set its own Message-ID, then populate the header in the email parameter.

Specified by:

send in interface SMTPMailServer

Parameters:

email - the Email to send.

Throws:

MailException - if the email could not be sent

See Also:

SMTPMailServer.sendWithMessageId(com.atlassian.mail.Email, String)

sendWithMessageId

public void sendWithMessageId(Email email,
                              String messageId)
                       throws MailException

Description copied from interface: SMTPMailServer

Sends the given email using the given Message-ID header.

Note that this is an advanced method and should only be used if you understand the requirements and restrictions as per RFC 2822; namely that the message-ID must be globally unique and can only contain certain ASCII characters.

If the given messageId parameter is null, then we let JavaMail create a Message-ID. Note that (for back-compatibility reasons) the email.getMessageId() is ignored for input, but set with the actual Message-ID used.

Specified by:

sendWithMessageId in interface SMTPMailServer

Parameters:

email - the Email to send.

messageId - the desired Message-ID header, or null to let JavaMail create one automatically. Do not include the angle-brackets - these will be added automatically.

Throws:

MailException - if the email could not be sent

See Also:

SMTPMailServer.send(com.atlassian.mail.Email)

sendMimeMessage

protected void sendMimeMessage(javax.mail.internet.MimeMessage message,
                               javax.mail.Transport transport)
                        throws javax.mail.MessagingException

Extracted method, it can be used for testing purposes.

Throws:

javax.mail.MessagingException

quietSend

public void quietSend(Email email)
               throws MailException

Send a message - but don't throw exceptions, just log the errors

Specified by:

quietSend in interface SMTPMailServer

Throws:

MailException

getType

public String getType()

Specified by:

getType in interface MailServer

getDefaultFrom

public String getDefaultFrom()

Specified by:

getDefaultFrom in interface SMTPMailServer

setDefaultFrom

public void setDefaultFrom(String defaultFrom)

Specified by:

setDefaultFrom in interface SMTPMailServer

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface SMTPMailServer

setPrefix

public void setPrefix(String prefix)

Specified by:

setPrefix in interface SMTPMailServer

isRemovePrecedence

public boolean isRemovePrecedence()

Specified by:

isRemovePrecedence in interface SMTPMailServer

setRemovePrecedence

public void setRemovePrecedence(boolean precedence)

Specified by:

setRemovePrecedence in interface SMTPMailServer

isSessionServer

public boolean isSessionServer()

Specified by:

isSessionServer in interface SMTPMailServer

setSessionServer

public void setSessionServer(boolean sessionServer)

Specified by:

setSessionServer in interface SMTPMailServer

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractMailServer

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractMailServer

toString

public String toString()

Overrides:

toString in class AbstractMailServer

propertyChanged

protected void propertyChanged()

Discard the cached session when a property of the server changes.

Overrides:

propertyChanged in class AbstractMailServer