Package 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.
-
-
Constructor Summary
Constructors Constructor Description SendEMailFC()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getVersion()
Version information.void
initialize(java.lang.Object obj)
Called once to initialize the Function Component.java.lang.Object
perform(java.lang.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
-
-
-
-
Method Detail
-
initialize
public void initialize(java.lang.Object obj) throws java.lang.Exception
Called once to initialize the Function Component.- Specified by:
initialize
in interfaceFunctionInterface
- Overrides:
initialize
in classFunction
- Parameters:
obj
- - ignored- Throws:
java.lang.Exception
- if an error occurs.
-
perform
public java.lang.Object perform(java.lang.Object obj) throws java.lang.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:
java.lang.Exception
- if the parameter is not an instance of theEntry
class, if the FC has not been initialized or if the method fails
-
getVersion
public java.lang.String getVersion()
Version information.- Returns:
- version information.
-
-