com.atlassian.mail.server

Interface MailServerManager

All Known Implementing Classes:

AbstractMailServerManager, XMLMailServerManager

public interface MailServerManager

This class allows MailServers to be created, updated and deleted. It also allows MailServers to be retrieved by id and name.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	SERVER_TYPES

Method Summary

Modifier and Type	Method and Description
Long	create(MailServer mailServer)
void	delete(Long mailServerId)
PopMailServer	getDefaultPopMailServer()
SMTPMailServer	getDefaultSMTPMailServer()
MailServer	getMailServer(Long id)
MailServer	getMailServer(String name)
List<PopMailServer>	getPopMailServers() Gets a list of all the configured POP mail servers.
List<String>	getServerNames()
javax.mail.Session	getSession(Properties props, javax.mail.Authenticator auth)
List<SMTPMailServer>	getSmtpMailServers() Gets a list of all the configured SMTP mail servers.
void	init(Map params)
boolean	isDefaultSMTPMailServerDefined() Whether a "default" SMTP Mail Server has been defined.
void	setMailServerConfigurationHandler(MailServerConfigurationHandler mailServerConfigurationHandler) Implementations of this interface are supposed to call registered here MailServerConfigurationHandler immediately after they construct MailServer objects.
void	update(MailServer mailServer)

Field Detail

SERVER_TYPES

static final String[] SERVER_TYPES

Method Detail

getMailServer

@Nullable
MailServer getMailServer(Long id)
                            throws MailException

Throws:

MailException

getMailServer

@Nullable
MailServer getMailServer(String name)
                            throws MailException

Throws:

MailException

create

Long create(MailServer mailServer)
     throws MailException

Throws:

MailException

update

void update(MailServer mailServer)
     throws MailException

Throws:

MailException

delete

void delete(Long mailServerId)
     throws MailException

Throws:

MailException

getServerNames

List<String> getServerNames()
                     throws MailException

Throws:

MailException

getSmtpMailServers

List<SMTPMailServer> getSmtpMailServers()

Gets a list of all the configured SMTP mail servers.

Returns:

A list of all the configured SMTP mail servers.

getPopMailServers

List<PopMailServer> getPopMailServers()

Gets a list of all the configured POP mail servers.

Returns:

A list of all the configured POP mail servers.

getDefaultSMTPMailServer

@Nullable
SMTPMailServer getDefaultSMTPMailServer()

isDefaultSMTPMailServerDefined

boolean isDefaultSMTPMailServerDefined()

Whether a "default" SMTP Mail Server has been defined.

Returns:

true if a "default" SMTP Mail Server has been defined; otherwise, false.

getDefaultPopMailServer

@Nullable
PopMailServer getDefaultPopMailServer()

getSession

javax.mail.Session getSession(Properties props,
                              @Nullable
                              javax.mail.Authenticator auth)
                       throws MailException

Throws:

MailException

init

void init(Map params)

setMailServerConfigurationHandler

void setMailServerConfigurationHandler(@Nullable
                                       MailServerConfigurationHandler mailServerConfigurationHandler)

Implementations of this interface are supposed to call registered here MailServerConfigurationHandler immediately after they construct MailServer objects. You can use it to further customise MailServer objects managed by this manager - e.g. initialize MailServer fields basing on application specific needs. This method is used to make up for lack of dependency injection while constructing MailServerManager implementation by ConfigLoader.ConfigLoader(String)

Parameters:

mailServerConfigurationHandler - callback called upon creation of MailServer objects