public class MailServiceImpl extends Object implements MailService
MailService implementation build on top of javax.mail package.
You may define the behaviour of the service via InitParams, which can
be set in configuration file of the ExoContainer.
Note: To be able to send mails you must provide active SMTP server and mention it in service configuration.
Created by The eXo Platform SAS Author : Phung Hai Nam phunghainam@gmail.com Dec 23, 2005
| Constructor and Description |
|---|
MailServiceImpl(InitParams params,
ExoContainerContext ctx) |
| Modifier and Type | Method and Description |
|---|---|
protected String[] |
getArrs(String toArray) |
javax.mail.Session |
getMailSession()
Provides
Session instance, which is to be used throughout MailService methods |
String |
getOutgoingMailServer()
Provides outgoing server information, which is basically its hostname or ip address.
|
void |
sendMessage(Message message)
Sends mail message based on
Message instance |
void |
sendMessage(javax.mail.internet.MimeMessage message)
Sends mail message based on
MimeMessage instance |
void |
sendMessage(String from,
String to,
String subject,
String body)
Sends mail message based on passed
String parameters. |
Future<Boolean> |
sendMessageInFuture(Message message)
Asynchronous variant of
MailService.sendMessage(Message). |
Future<Boolean> |
sendMessageInFuture(javax.mail.internet.MimeMessage message)
Asynchronous variant of
MailService.sendMessage(MimeMessage). |
Future<Boolean> |
sendMessageInFuture(String from,
String to,
String subject,
String body)
Asynchronous variant of
MailService.sendMessage(String, String, String, String). |
public MailServiceImpl(InitParams params, ExoContainerContext ctx) throws Exception
Exceptionpublic javax.mail.Session getMailSession()
Session instance, which is to be used throughout MailService methodsgetMailSession in interface MailServiceSessionpublic String getOutgoingMailServer()
MailService should send message
to the server first and than server will resend messages to the receivers.getOutgoingMailServer in interface MailServicepublic void sendMessage(String from, String to, String subject, String body) throws Exception
String parameters.sendMessage in interface MailServicefrom - - String identificator of mail sender. For example 'test.sender@test.test'to - - String identificator of mail receiver. For example 'test.receiver@test.test'subject - - String subject of mail messagebody - - String contents of mail messageException - is thrown if something's gone wrong during mail send procedurepublic void sendMessage(Message message) throws Exception
Message instancesendMessage in interface MailServicemessage - - Message provides mail message related data (e.g. subject, content etc.)Exception - is thrown if something's gone wrong during mail send procedurepublic void sendMessage(javax.mail.internet.MimeMessage message)
throws Exception
MimeMessage instancesendMessage in interface MailServicemessage - - MimeMessage provides mail message related data (e.g. subject, content etc.)Exception - is thrown if something's gone wrong during mail send procedurepublic Future<Boolean> sendMessageInFuture(String from, String to, String subject, String body)
MailService.sendMessage(String, String, String, String).
Returns Future object, which allows to track mail sending result. Calling Future.get()
for this object returns Boolean.TRUE if mail is sent successfully,
throws ExecutionException if some exception occured during mail sending.
Calling Throwable.getCause() for the thrown exception object provides the exception,
which indeed occured during sending mail.sendMessageInFuture in interface MailServicefrom - - String identificator of mail sender. For example 'test.sender@test.test'to - - String identificator of mail receiver. For example 'test.receiver@test.test'subject - - String subject of mail messagebody - - String contents of mail messageFuture object to watch the result of asynchronous calculationpublic Future<Boolean> sendMessageInFuture(Message message)
MailService.sendMessage(Message).
Returns Future object, which allows to track mail sending result. Calling Future.get()
for this object returns Boolean.TRUE if mail is sent successfully,
throws ExecutionException if some exception occured during mail sending.
Calling Throwable.getCause() for the thrown exception object provides the exception,
which indeed occured during sending mail.sendMessageInFuture in interface MailServicemessage - - Message provides mail message related data (e.g. subject, content etc.)Future object to watch the result of asynchronous calculationpublic Future<Boolean> sendMessageInFuture(javax.mail.internet.MimeMessage message)
MailService.sendMessage(MimeMessage).
Returns Future object, which allows to track mail sending result. Calling Future.get()
for this object returns Boolean.TRUE if mail is sent successfully,
throws ExecutionException if some exception occured during mail sending.
Calling Throwable.getCause() for the thrown exception object provides the exception,
which indeed occured during sending mail.sendMessageInFuture in interface MailServicemessage - - MimeMessage provides mail message related data (e.g. subject, content etc.)Future object to watch the result of asynchronous calculationCopyright © 2021 eXo Platform SAS. All Rights Reserved.