Package org.pentaho.platform.api.email
Interface IEmailService
-
public interface IEmailServiceThe Email Service used in the Pentaho Platform
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IEmailConfigurationgetEmailConfig()Retrieves the current email configurationbooleanisValid()StringsendEmailTest(IEmailConfiguration emailConfig)Generates a test email via the specficied email configurationvoidsetEmailConfig(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()
-
-