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

Class MailConfigurationResource

java.lang.Object

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

@Path("/config/mailServer")
@Produces("application/json")
@Consumes("application/json")
public class MailConfigurationResource
extends Object

REST resource for accessing / updating the mail server configuration.

Since:

5.10

Constructor Summary

Constructors

Constructor	Description
MailConfigurationResource(MailConfigurationService mailConfigurationService, MailConfigurationConversionFunction function)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	deleteMailConfiguration()
RestMailConfiguration	getMailConfiguration(@NotNull ExpansionParam expansion, @NotNull javax.ws.rs.core.UriInfo uriInfo)
RestMailConfiguration	updateMailConfiguration(RestMailConfiguration restMailConfiguration, @NotNull ExpansionParam expansion, @NotNull javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

MailConfigurationResource

@Inject
public MailConfigurationResource(MailConfigurationService mailConfigurationService,
 MailConfigurationConversionFunction function)

Method Details

getMailConfiguration

@GET
public RestMailConfiguration getMailConfiguration(@NotNull @BeanParam
 @NotNull ExpansionParam expansion,
 @NotNull @Context
 @NotNull javax.ws.rs.core.UriInfo uriInfo)
                                           throws UnauthorisedException,
NotFoundException

Throws:

UnauthorisedException

NotFoundException

updateMailConfiguration

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

Throws:

WebValidationException

UnauthorisedException

deleteMailConfiguration

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

Throws:

UnauthorisedException

NotFoundException

com.atlassian.mail.MailException