|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MailService
Remote interface to the MailService stateless session bean. This bean provides basic mail-sending capabilities for sending text email messages.
The smtp server can be specified in the bean's deployment descriptor,
or in the application's
MailServiceBean
.
Method Summary | |
---|---|
void |
addToBatch(MailMessage message,
String batch)
Add a MailMessage to a batch so that it can be sent later. |
void |
deleteBatch(String batch)
Delete a batch and all of its messages |
ArrayList |
getBatchNames()
Return all batch names in the system |
int |
getBatchSize(String batch)
Return the size of a batch. |
ServletResults |
getJSPResults(String url,
Map params)
Similar to getTextFromJSP; but will retrieve contents of the jsp page as a byte array to cut down on string encoding hassles. |
ArrayList |
getMessagesInBatch(String batchName,
boolean getText)
Retrieve all messages in a batch. |
String |
getTextFromJSP(String url,
Map params)
Generate text from a JSP page for use in an email message. |
boolean |
isValidAddress(String address)
Is the specified email address valid for this mail service. |
void |
sendBatch(String batch,
boolean delete)
Send all the messages in a batch, optionally deleting the batch when finished. |
void |
sendMail(MailMessage message)
Send an email message immediately. |
void |
sendMail(String to,
String from,
String subject,
String text)
The simplest way to send a mail message; supply the basic information and the message will be sent immediately. |
Methods inherited from interface javax.ejb.EJBObject |
---|
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove |
Method Detail |
---|
boolean isValidAddress(String address) throws RemoteException
address
- the email address.
RemoteException
void sendMail(String to, String from, String subject, String text) throws RemoteException, IllegalArgumentException, MailServiceException
to
- The address to mail tofrom
- The "from" addresssubject
- The message's subject. Can be null.text
- The message's text. Can be null.
IllegalArgumentException
- If the "to" address is null or invalid
RemoteException
MailServiceException
void sendMail(MailMessage message) throws RemoteException, IllegalArgumentException, MailServiceException
message
- A MailMessage to send.
IllegalArgumentException
- if the MailMessage is not valid
RemoteException
MailServiceException
void addToBatch(MailMessage message, String batch) throws RemoteException, IllegalArgumentException, MailServiceException
message
- A MailMessage to batchbatch
- the name of the batch to add it to
IllegalArgumentException
- if the MailMessage is not valid
RemoteException
MailServiceException
void sendBatch(String batch, boolean delete) throws RemoteException, MailServiceException
batch
- the name of the batch to senddelete
- if true, will delete the batch after sending it
RemoteException
MailServiceException
void deleteBatch(String batch) throws RemoteException, MailServiceException
batch
- the name of the batch to delete
RemoteException
MailServiceException
ArrayList getMessagesInBatch(String batchName, boolean getText) throws RemoteException, MailServiceException
batch
- the name of the batch to examinegetText
- flag to retrieve message text
RemoteException
MailServiceException
int getBatchSize(String batch) throws RemoteException, MailServiceException
batch
- the name of the batch to examine
RemoteException
MailServiceException
ArrayList getBatchNames() throws RemoteException, MailServiceException
RemoteException
MailServiceException
String getTextFromJSP(String url, Map params) throws RemoteException, IOException
url
- the URL of the jsp page.params
- a map of parameters to pass to the JSP
RemoteException
IOException
ServletResults getJSPResults(String url, Map params) throws RemoteException, IOException
RemoteException
IOException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |