Email renderers
An email renderer plugin is a plugin that can be associated to an email template, allowing you to customize the rendering of the template.
If you don't know what a plugin is, you can find complete documentation in the specific section.
If you're looking to make a connection with your email router, you should look at the Email router plugin type.

Endpoints to implement

Email renderers need to implement only one endpoint.
post
myworker
/v1/email_contents
Send email contents to the renderer
See Plugin Instances to learn why you should use the email_renderer_id parameter to retrieve the instance properties.
About click_urls: when constructing the final URL, it's essential that you properly URL encode the click URLs. For example, if you have List("http://url1/?redirect=", "http://url2/?redirect=") and a destination URL equal to http://dest/, the result must be equal to http://url1/?redirect=http%3A%2F%2Furl2%2F%3Fredirect%3Dhttp%253A%252F%252Fdest%252F which is http://url1/?redirect=url_encode(http://url2/?redirect=url_encode(http://dest/))

PluginEmailMeta

Field
Type
Description
from_name
String
to_email
String
to_name
String
reply_to
String
subject_line
String
The subject line, overriding the email campaign subject if defined.

PluginEmailContent

Field
Type
Description
html
String (optional)
The html content of the email.
text
String (optional)
The text content of the email.

PluginEmailData

This object is customizable.

Available outbound services

The code of the email renderer can call the following API endpoints to retrieve its instance context.
get
https://api.mediarithmics.com
/v1/creatives/:id/renderer_properties
Retrieve the instance properties

Creating an email router plugin

See the plugins documentation to see how plugins are created and deployed.
An email renderer plugin has the EMAIL_TEMPLATE_RENDERER plugin type. Its group id should be {domain.organisation.email-renderer} (for example com.mediarithmics.email-renderer).
Its artifact id should be the name of the email renderer plugin, i.e. example-email-renderer.
Use our Plugin SDK to create your email renderer plugin in Node.js: the required routes are already defined and you only have to override specific functions.
You can find a sample email renderer plugin in the examples folder of the plugin SDK.
We can provide you with a Hello World project using our SDK. Please contact your support to obtain access to it.
The project structure and files work as with every other plugin.

Interfaces to implement

Your should extend EmailRendererPlugin class and implement the onEmailContents function from the plugin SDK.
The onEmailContents function is called just before the email is sent. It is responsible for providing the email content to the router.
Don't forget to catch your errors. You should log / respond with the appropriate message to facilitate debugging.
import {core} from '@mediarithmics/plugins-nodejs-sdk';
import {EmailRenderRequest} from '@mediarithmics/plugins-nodejs-sdk/src/mediarithmics/api/plugin/emailtemplaterenderer/EmailRendererRequestInterface';
import {EmailRendererPluginResponse} from '@mediarithmics/plugins-nodejs-sdk/src/mediarithmics/api/plugin/emailtemplaterenderer/EmailRendererPluginResponse';
import {EmailRendererBaseInstanceContext} from '@mediarithmics/plugins-nodejs-sdk/lib/mediarithmics';
export interface ExampleEmailRendererConfigurationFileProperties {
apiToken: string;
}
export class ExampleEmailRenderer extends core.EmailRendererPlugin {
constructor(enableThrottling = false) {
super(enableThrottling);
}
protected async onEmailContents(
request: EmailRenderRequest,
instanceContext: EmailRendererBaseInstanceContext
): Promise<EmailRendererPluginResponse> {
// do stuff
return {
meta: {}, // use this to set email addresses, subject, ...
content: {}, // use this to set content
data: {} // with this you can provide additional data to the email router
};
}
}

Debugging

Plugin logs and metrics

You can monitor email router plugins as you do with all plugins.

Creating a new email template associated to the renderer

post
https://api.mediarithmics.com
/v1/email_templates
Create an email template
Copy link
On this page
Endpoints to implement
post
Send email contents to the renderer
PluginEmailMeta
PluginEmailContent
PluginEmailData
Available outbound services
get
Retrieve the instance properties
Creating an email router plugin
Interfaces to implement
Debugging
Plugin logs and metrics
Creating a new email template associated to the renderer
post
Create an email template