org.pentaho.platform.api.email

Interface IEmailService

public interface IEmailService

The Email Service used in the Pentaho Platform

Method Summary

Methods

Modifier and Type	Method and Description
IEmailConfiguration	getEmailConfig() Retrieves the current email configuration
boolean	isValid()
String	sendEmailTest(IEmailConfiguration emailConfig) Generates a test email via the specficied email configuration
void	setEmailConfig(IEmailConfiguration emailConfiguration) Saves the email configuration

Method Detail

setEmailConfig

void setEmailConfig(IEmailConfiguration emailConfiguration)

Saves the email configuration

Parameters:

emailConfiguration - the email configuration to save as the current email configuration

getEmailConfig

IEmailConfiguration getEmailConfig()

Retrieves the current email configuration

sendEmailTest

String sendEmailTest(IEmailConfiguration emailConfig)

Generates a test email via the specficied email configuration

Parameters:

emailConfig - the email configuration to use for sending the testing email

isValid

boolean isValid()