com.atlassian.mail.server

Interface SMTPMailServer

All Superinterfaces:

MailServer

All Known Implementing Classes:

SMTPMailServerImpl

public interface SMTPMailServer
extends MailServer

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SMTP_PORT Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	getDebug() Whether logging is enabled.
PrintStream	getDebugStream() Where debug logs currently go to.
String	getDefaultFrom()
String	getJndiLocation()
String	getPrefix()
boolean	isRemovePrecedence()
boolean	isSessionServer()
boolean	isTlsRequired()
void	quietSend(Email email) Deprecated. Use send(com.atlassian.mail.Email) instead and deal with the Exception for yourself. Since v2.5.
void	send(Email email) Sends the given email.
void	sendWithMessageId(Email email, String messageId) Sends the given email using the given Message-ID header.
void	setDebug(boolean debug) Enable or disable SMTP-level logging.
void	setDefaultFrom(String from)
void	setJndiLocation(String jndiLocation)
void	setPrefix(String prefix)
void	setRemovePrecedence(boolean precedence)
void	setSessionServer(boolean sessionServer)
void	setTlsRequired(boolean tlsRequired)

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

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

Field Detail

DEFAULT_SMTP_PORT

@Deprecated
static final String DEFAULT_SMTP_PORT

Deprecated.

See Also:

Constant Field Values

Method Detail

getDefaultFrom

String getDefaultFrom()

setDefaultFrom

void setDefaultFrom(String from)

getPrefix

String getPrefix()

setPrefix

void setPrefix(String prefix)

isSessionServer

boolean isSessionServer()

setSessionServer

void setSessionServer(boolean sessionServer)

getJndiLocation

String getJndiLocation()

setJndiLocation

void setJndiLocation(String jndiLocation)

isRemovePrecedence

boolean isRemovePrecedence()

setRemovePrecedence

void setRemovePrecedence(boolean precedence)

send

void send(Email email)
   throws MailException

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.

Parameters:

email - the Email to send.

Throws:

MailException - if the email could not be sent

See Also:

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

sendWithMessageId

void sendWithMessageId(Email email,
                       String messageId)
                throws MailException

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.

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:

send(com.atlassian.mail.Email)

quietSend

void quietSend(Email email)
        throws MailException

Deprecated. Use send(com.atlassian.mail.Email) instead and deal with the Exception for yourself. Since v2.5.

World's stupidest method - it catches all Exceptions and then declares anyway that it throws MailException.

Parameters:

email -

Throws:

MailException

setDebug

void setDebug(boolean debug)

Enable or disable SMTP-level logging.

Specified by:

setDebug in interface MailServer

Parameters:

debug - Turn debugging on or off

getDebug

boolean getDebug()

Whether logging is enabled.

Specified by:

getDebug in interface MailServer

getDebugStream

PrintStream getDebugStream()

Where debug logs currently go to.

Returns:

print stream where debug info is logged to

isTlsRequired

boolean isTlsRequired()

setTlsRequired

void setTlsRequired(boolean tlsRequired)