com.atlassian.bamboo.admin.configuration

Class MailConfigurationServiceImpl

java.lang.Object

com.atlassian.bamboo.admin.configuration.MailConfigurationServiceImpl

All Implemented Interfaces:

MailConfigurationService

public class MailConfigurationServiceImpl
extends Object
implements MailConfigurationService

Constructor Summary

Constructors

Constructor and Description
MailConfigurationServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	deleteMailServer() Delete the current mail server configuration
com.atlassian.mail.server.SMTPMailServer	getMailServer() Retrieve the current mail server configuration
com.atlassian.mail.server.SMTPMailServer	updateMailServer(String name, String fromAddress, String subjectPrefix, Boolean precedenceBulkHeaderExcluded, String emailSetting, String smtpServer, String smtpPort, String smtpUsername, String smtpPassword, Boolean tlsEnabled, String jndiLocation) Update the current mail server configuration

Methods inherited from class java.lang.Object

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

Constructor Detail

MailConfigurationServiceImpl

public MailConfigurationServiceImpl()

Method Detail

getMailServer

@NotNull
public com.atlassian.mail.server.SMTPMailServer getMailServer()
                                                                throws UnauthorisedException,
                                                                       NotFoundException

Description copied from interface: MailConfigurationService

Retrieve the current mail server configuration

Specified by:

getMailServer in interface MailConfigurationService

Returns:

current mail server configuration, null if it is not set

Throws:

UnauthorisedException - if user does not have appropriate permissions (System Administrator)

NotFoundException - if no mail server configuration is set

updateMailServer

@NotNull
public com.atlassian.mail.server.SMTPMailServer updateMailServer(@Nullable
                                                                          String name,
                                                                          @Nullable
                                                                          String fromAddress,
                                                                          @Nullable
                                                                          String subjectPrefix,
                                                                          @Nullable
                                                                          Boolean precedenceBulkHeaderExcluded,
                                                                          @Nullable
                                                                          String emailSetting,
                                                                          @Nullable
                                                                          String smtpServer,
                                                                          @Nullable
                                                                          String smtpPort,
                                                                          @Nullable
                                                                          String smtpUsername,
                                                                          @Nullable
                                                                          String smtpPassword,
                                                                          @Nullable
                                                                          Boolean tlsEnabled,
                                                                          @Nullable
                                                                          String jndiLocation)
                                                                   throws WebValidationException,
                                                                          UnauthorisedException

Description copied from interface: MailConfigurationService

Update the current mail server configuration

Specified by:

updateMailServer in interface MailConfigurationService

fromAddress - must be a valid email address

emailSetting - must be either JNDI or SMTP

Throws:

WebValidationException - if the supplied parameters are invalid

UnauthorisedException - if user does not have appropriate permissions (System Administrator)

deleteMailServer

public void deleteMailServer()
                      throws NotFoundException,
                             com.atlassian.mail.MailException

Description copied from interface: MailConfigurationService

Delete the current mail server configuration

Specified by:

deleteMailServer in interface MailConfigurationService

Throws:

NotFoundException - if a mail server is not currently set

com.atlassian.mail.MailException - if there is an error attempting to delete the current mail configuration