com.atlassian.bamboo.plugins.rest.admin.mail

Class MailConfigurationResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.admin.mail.MailConfigurationResource

public class MailConfigurationResource
extends Object

REST resource for accessing / updating the bamboo mail server configuration

Since:

5.10

Constructor Summary

Constructors

Constructor and Description
MailConfigurationResource(MailConfigurationService mailConfigurationService, MailConfigurationConversionFunction function)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteMailConfiguration() Rest endpoint to delete current mail configuration
javax.ws.rs.core.Response	getMailConfiguration(Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) The REST endpoint to retrieve the current mail server configuration
javax.ws.rs.core.Response	updateMailConfiguration(RestMailConfiguration restMailConfiguration, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo) The Rest endpoint to update the mail server configuration

Methods inherited from class java.lang.Object

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

Constructor Detail

MailConfigurationResource

public MailConfigurationResource(MailConfigurationService mailConfigurationService,
                                 MailConfigurationConversionFunction function)

Method Detail

getMailConfiguration

public javax.ws.rs.core.Response getMailConfiguration(@NotNull @Context
                                                      Expansion expansion,
                                                      @NotNull @Context
                                                      javax.ws.rs.core.UriInfo uriInfo)
                                               throws UnauthorisedException,
                                                      NotFoundException

The REST endpoint to retrieve the current mail server configuration

Returns:

Response

Throws:

UnauthorisedException

NotFoundException

updateMailConfiguration

public javax.ws.rs.core.Response updateMailConfiguration(RestMailConfiguration restMailConfiguration,
                                                         @NotNull @Context
                                                         Expansion expansion,
                                                         @NotNull @Context
                                                         javax.ws.rs.core.UriInfo uriInfo)
                                                  throws WebValidationException,
                                                         UnauthorisedException

The Rest endpoint to update the mail server configuration

Parameters:

restMailConfiguration -

expansion -

uriInfo -

Returns:

Response

Throws:

WebValidationException

UnauthorisedException

deleteMailConfiguration

public javax.ws.rs.core.Response deleteMailConfiguration()
                                                  throws UnauthorisedException,
                                                         NotFoundException,
                                                         com.atlassian.mail.MailException

Rest endpoint to delete current mail configuration

Returns:

Response

Throws:

NotFoundException

com.atlassian.mail.MailException

UnauthorisedException