org.pentaho.platform.web.http.api.resources

Class EmailResource

java.lang.Object

org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

org.pentaho.platform.web.http.api.resources.EmailResource

public class EmailResource
extends AbstractJaxRSResource

Field Summary

Fields inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

TEXT_HTML

Constructor Summary

Constructors

Constructor and Description
EmailResource() Constructs an instance of this class using the default email service
EmailResource(org.pentaho.platform.api.email.IEmailService emailService) Constructs an instance of this class using the default email service

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteEmailConfig(EmailConfiguration emailConfiguration)
org.pentaho.platform.api.email.IEmailConfiguration	getEmailConfig()
javax.ws.rs.core.Response	isValid()
javax.ws.rs.core.Response	sendEmailTest(EmailConfiguration emailConfiguration)
javax.ws.rs.core.Response	setEmailConfig(EmailConfiguration emailConfiguration)

Methods inherited from class org.pentaho.platform.web.http.api.resources.AbstractJaxRSResource

setHttpHeaders

Methods inherited from class java.lang.Object

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

Constructor Detail

EmailResource

public EmailResource()
              throws IllegalArgumentException

Constructs an instance of this class using the default email service

Throws:

IllegalArgumentException - Indicates that the default location for the email configuration file is invalid

EmailResource

public EmailResource(org.pentaho.platform.api.email.IEmailService emailService)
              throws IllegalArgumentException

Constructs an instance of this class using the default email service

Throws:

IllegalArgumentException - Indicates that the default location for the email configuration file is invalid

Method Detail

deleteEmailConfig

public javax.ws.rs.core.Response deleteEmailConfig(EmailConfiguration emailConfiguration)

setEmailConfig

public javax.ws.rs.core.Response setEmailConfig(EmailConfiguration emailConfiguration)

getEmailConfig

public org.pentaho.platform.api.email.IEmailConfiguration getEmailConfig()

sendEmailTest

public javax.ws.rs.core.Response sendEmailTest(EmailConfiguration emailConfiguration)
                                        throws Exception

Throws:

Exception

isValid

public javax.ws.rs.core.Response isValid()