Class EmailService
- java.lang.Object
-
- org.pentaho.platform.plugin.services.email.EmailService
-
- All Implemented Interfaces:
org.pentaho.platform.api.email.IEmailService
public class EmailService extends Object implements org.pentaho.platform.api.email.IEmailService
Manages the email connection information- Author:
- David M. Kincade
-
-
Constructor Summary
Constructors Constructor Description EmailService()
Constructs an instance of this class using the default settings location as defined by PentahoSystemEmailService(File emailConfigFile)
Constructs an instance of this class using the specified file location as the source of the email configuration
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EmailConfiguration
getEmailConfig()
TODO documentboolean
isValid()
String
sendEmailTest(org.pentaho.platform.api.email.IEmailConfiguration emailConfig)
Tests the provided email configuration by sending a test email.void
setEmailConfig(org.pentaho.platform.api.email.IEmailConfiguration emailConfiguration)
protected void
setEmailConfigFile(File emailConfigFile)
Validates and sets the email configuration file to the specified value.
-
-
-
Constructor Detail
-
EmailService
public EmailService() throws IllegalArgumentException
Constructs an instance of this class using the default settings location as defined by PentahoSystem- Throws:
IllegalArgumentException
- Indicates that the default location for the email configuration file is invalid
-
EmailService
public EmailService(File emailConfigFile) throws IllegalArgumentException
Constructs an instance of this class using the specified file location as the source of the email configuration- Parameters:
emailConfigFile
- the file reference to the email configuration- Throws:
IllegalArgumentException
- indicates the argument is either null or references a location which is invalid (the parent folder of the specified file doesn't exist)
-
-
Method Detail
-
setEmailConfig
public void setEmailConfig(org.pentaho.platform.api.email.IEmailConfiguration emailConfiguration)
- Specified by:
setEmailConfig
in interfaceorg.pentaho.platform.api.email.IEmailService
-
getEmailConfig
public EmailConfiguration getEmailConfig()
TODO document- Specified by:
getEmailConfig
in interfaceorg.pentaho.platform.api.email.IEmailService
- Returns:
-
sendEmailTest
public String sendEmailTest(org.pentaho.platform.api.email.IEmailConfiguration emailConfig)
Tests the provided email configuration by sending a test email. This will just indicate that the server configuration is correct and a test email was successfully sent. It does not test the destination address.- Specified by:
sendEmailTest
in interfaceorg.pentaho.platform.api.email.IEmailService
- Parameters:
emailConfig
- the email configuration to test- Throws:
Exception
- indicates an error running the test (as in an invalid configuration)
-
setEmailConfigFile
protected void setEmailConfigFile(File emailConfigFile) throws IllegalArgumentException
Validates and sets the email configuration file to the specified value.- Parameters:
emailConfigFile
- the email configuration file to use- Throws:
IllegalArgumentException
- indicates that the provided value is invalid (the value is null or the parent folder does not exist)
-
isValid
public boolean isValid()
- Specified by:
isValid
in interfaceorg.pentaho.platform.api.email.IEmailService
-
-