com.ibm.di.fc
Class SendEMailFC
java.lang.Object
com.ibm.di.fc.Function
com.ibm.di.fc.SendEMailFC
- All Implemented Interfaces:
- FunctionInterface, VersionInfoInterface
public class SendEMailFC
- extends Function
The SendEMail Function Component uses the JavaMail API to send e-mails. By
connecting to an Simple Mail Transfer Protocol (SMTP) server, the SendEMail
Function Component can send e-mails to multiple recipients and can optionally
attach multiple files to e-mails. You can also attach multiple files with
different Multipurpose Internet Mail Extensions (MIME) types.
Method Summary |
String |
getVersion()
Version information. |
void |
initialize(Object obj)
Called once to initialize the Function Component. |
Object |
perform(Object obj)
This method accepts an object of type Entry, extracts the information for
the e-mail (from, recipients , subjects , attachments), creates a new
message objects with attributes listed in the incoming object and sends
this message |
Methods inherited from class com.ibm.di.fc.Function |
debug, getConfiguration, getContext, getDebug, getLog, getParam, getRSInterface, getUI, initialize, logmsg, querySchema, setConfiguration, setContext, setDebug, setLog, setParam, setRSInterface, terminate, updateSchema, verifyInitialized |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SendEMailFC
public SendEMailFC()
initialize
public void initialize(Object obj)
throws Exception
- Called once to initialize the Function Component.
- Specified by:
initialize
in interface FunctionInterface
- Overrides:
initialize
in class Function
- Parameters:
obj
- -
ignored
- Throws:
Exception
- if an error occurs.
perform
public Object perform(Object obj)
throws Exception
- This method accepts an object of type Entry, extracts the information for
the e-mail (from, recipients , subjects , attachments), creates a new
message objects with attributes listed in the incoming object and sends
this message
- Parameters:
obj
- An Entry containing the values of the parameters
- Returns:
- Returns the calling object
- Throws:
Exception
- if the parameter is not an instance of the Entry
class, if the FC has not been initialized or if the method
fails
getVersion
public String getVersion()
- Version information.
- Returns:
- version information.