Package org.nuxeo.ecm.platform.ec.notification.email

Class EmailHelper

java.lang.Object

org.nuxeo.ecm.platform.ec.notification.email.EmailHelper

public class EmailHelper
extends Object

Helper class to build some MailMessages from Maps and send them through the MailService.

 Hashtable mail = new Hashtable();
 mail.put("from", "[email protected]");
 mail.put("to", "[email protected]");
 mail.put("subject", "a subject");
 mail.put("template", "a template name");
 <p>
 EmailHelper.sendMailMessage(mail);
 

Constructor Summary

Constructors

Constructor	Description
EmailHelper()

Method Summary

Modifier and Type	Method	Description
protected String	computeSubject(Map<String,Object> mail, DocumentRenderingContext context)
String	evaluateMvelExpresssion(String expr, Map<String,Serializable> ctx)	Evaluates a MVEL expression within some context infos accessible on the "NotificationContext" object.
protected Map<String,Object>	initMvelBindings(Map<String,Serializable> infos)
static jakarta.mail.Session	newSession(Properties props)	Deprecated. since 11.1, use MailSessionBuilder
protected String	renderTemplate(String template, DocumentRenderingContext context)
void	sendmail(Map<String,Object> mail)	Deprecated. since 2023.4 because doesn't fit in a generic service.
protected void	sendmail0(Map<String,Object> mail)
void	sendMailMessage(Map<String,Object> mail)	Sends MailMessages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EmailHelper

public EmailHelper()

Method Details

sendMailMessage

public void sendMailMessage(Map<String,Object> mail)

Sends MailMessages.

Since:

2023.4

sendmail

@Deprecated(since="2023.4")
public void sendmail(Map<String,Object> mail)
              throws jakarta.mail.MessagingException

Deprecated.

since 2023.4 because doesn't fit in a generic service. Use sendMailMessage(java.util.Map<java.lang.String, java.lang.Object>) instead.

Sends mails from a Map.

Parameters:

mail - A map of the settings

Throws:

jakarta.mail.MessagingException

sendmail0

protected void sendmail0(Map<String,Object> mail)
                  throws IOException,
freemarker.template.TemplateException,
RenderingException

Throws:

IOException

freemarker.template.TemplateException

RenderingException

computeSubject

protected String computeSubject(Map<String,Object> mail,
 DocumentRenderingContext context)
                         throws IOException,
freemarker.template.TemplateException,
RenderingException

Throws:

IOException

freemarker.template.TemplateException

RenderingException

renderTemplate

protected String renderTemplate(String template,
 DocumentRenderingContext context)
                         throws RenderingException

Throws:

RenderingException

newSession

@Deprecated(since="11.1")
public static jakarta.mail.Session newSession(Properties props)

Deprecated.

since 11.1, use MailSessionBuilder

Instantiates a new session that authenticates given the protocol's properties. Initializes also the default transport protocol handler according to the properties.

Since:

5.6

initMvelBindings

protected Map<String,Object> initMvelBindings(Map<String,Serializable> infos)

evaluateMvelExpresssion

public String evaluateMvelExpresssion(String expr,
 Map<String,Serializable> ctx)

Evaluates a MVEL expression within some context infos accessible on the "NotificationContext" object. Returns null if the result is not evaluated to a String

Since:

5.6