Package com.axelor.workflow.spi

Interface WorkflowEmailProvider

All Known Implementing Classes:

ReflectiveWorkflowEmailProvider

public interface WorkflowEmailProvider

SPI for template-based workflow email. AppModule binds a default adapter over the optional Axelor Message add-on; applications may bind their own. Bound rather than @ImplementedBy so this package depends on nothing else in the engine.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WorkflowEmailProvider.SendException	An expected template generation or queue-submission failure that a workflow may catch.
static final record	WorkflowEmailProvider.SendRequest
static final record	WorkflowEmailProvider.TemplateOption

Method Summary

Modifier and Type	Method	Description
List<WorkflowEmailProvider.TemplateOption>	listTemplates(String model, String jsonModel, String query)	Templates available to the current user for the workflow model.
void	send(WorkflowEmailProvider.SendRequest request)	Resolves the template, renders it for the record and queues it with its configured sender.

Method Details

listTemplates

List<WorkflowEmailProvider.TemplateOption> listTemplates(String model,
 String jsonModel,
 String query)

Templates available to the current user for the workflow model.

send

void send(WorkflowEmailProvider.SendRequest request)

Resolves the template, renders it for the record and queues it with its configured sender. Expected failures are thrown as WorkflowEmailProvider.SendException, saying what is known of the ActivityEffect, so an on="error" boundary may handle them.