Wikiadmin: Created page with "{{(!)|The contents of this document are available from Openbravo '''3.0MP22'''}} == Introduction == Openbravo provides a mechanism that allows to p..."

2021-07-11T00:54:37Z

Created page with "{{(!)|The contents of this document are available from Openbravo '''3.0MP22'''}} == Introduction == Openbravo provides a mechanism that allows to p..."

New page

{{(!)|The contents of this document are available from Openbravo '''[[Release_Notes/3.0MP22|3.0MP22]]'''}}

== Introduction ==

Openbravo provides a mechanism that allows to programmatically generate events to send emails. Event triggering and email implementation is decoupled, being possible to launch generic events, that are listened by other modules that implement the email contents.

This how to explains both, how to trigger the events and how to listen to them to generate the event.

Email server is [[Client#Email_Configuration|configured]] at client level.

== Triggering email events ==

An event is identified simply by a <code>String</code>.

Events are triggered programmatically from any piece of code, such as [[How_to_create_a_Standard_Process_Definition|Processes]] or [[How_to_implement_a_business_event_handler|Business Event Handlers]].

To trigger an event you need to:

Inject in your class a <code>EmailEventManager</code>

<source lang="java">
...
@Inject
private EmailEventManager emailManager;
...
</source>

Use this manager to create the events:

<source lang="java">
try {
boolean sent = emailManager.sendEmail("EVT_NAME", "user1@test.abc; user2@test.abc", data);
if (sent) {
// email was sent
} else {
// email was not sent
}
} catch (EmailEventException e) {
// something went wrong...
}
</source>

First parameter is the ''event name'' that identifies the event. Second one is the list of recipients, semicolon (;) separated if more than one. And finally, any <code>Object</code> with the data that will be used to generate the event. Note even this data is something generic (<code>Object</code>), the actual type the listener will expect can vary depending on the event.

== Listening to email events ==

Email events are listened by classes implementing <code>EmailEventContentGenerator</code>.

To listen to an event, you need to create a class of <code>EmailEventContentGenerator</code>:

<source lang="java">
public class MyEmailGenerator implements EmailEventContentGenerator {
@Override
public boolean isValidEvent(String event, Object data) {
return "EVT_NAME".equals(event);
}

@Override
public String getSubject(Object data, String event) {
return "New email for you";
}

@SuppressWarnings("unchecked")
@Override
public String getBody(Object data, String event) {
User usr = (User) data;
return "Hello " + usr.getFirstName;
}

@Override
public String getContentType() {
return "text/plain; charset=utf-8";
}

...
}
</source>

Let's explain the main methods to implement (there are some other ones explained in the javadoc):

;<code>isValidEvent</code>
:Determines whether our class listens to the event. Internally, the emailManager iterates over all <code>EmailEventContentGenerator</code> classes executing this method, email is tried to be sent in case it returns <code>true</code>. Following our example, the name of the event we sent before was "EVT_NAME", so we return <code>true</code> for this event and <code>false</code> for any other one. Note that a single class could listen to several events.

;<code>getSubject</code>
:Returns an <code>String</code> with the subject of the email. It also receives the data, so this subject can be different based on it.

;<code>getBody</code>
:Returns an <code>String</code> with the body of the email. It also receives the data, so this subject can be different based on it. In this example, we expect data to be a User, so we can cast it to generate the body based on its attributes.

More advanced bodies can be composed using freemarker templates, in this way it is possible to other module to override the template without needing to do any Java coding. In [[How_to_create_a_Navigation_Bar_Component#Creating_a_template | this how to]], it is explained how templates can be created.

[[Category: HowTo]]

How to send emails on events - Revision history

Wikiadmin: Created page with "{{(!)|The contents of this document are available from Openbravo '''3.0MP22'''}} == Introduction == Openbravo provides a mechanism that allows to p..."