Email Rules
Your own decision about an event: who receives it and in what words. Any rule for an event replaces its default, so an inactive rule is how an event is switched off. Any screen’s <module>.<screen>.created, .updated or .status_changed can have a rule.
Where to find it
Address in the console: /platform/mail-rules
List · 5 columns · 6 fields on its form · 3 of them required
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Event | Code | event_code |
| When | Text | event_label |
| Rule | Text | name |
| Subject | Text | subject |
| Active | Yes or no | is_active |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Event required | Text | Looked up from existing records | Pick one from the catalogue, or type any screen’s event, e.g. crm.leads.created. |
| Rule name required | Text | ||
| Who receives it required | Long text | One to a line: an email address (ap@example.com) · actor — whoever did it · supplier — the supplier on the record · role: buyer — everybody in a role · field: requested_by — a person or address on the record · person: assignee — somebody the event names · user: <user id> | |
| Subject | Text | Empty for the default. {{ref}}, {{status}}, {{company}} and any field of the record fill in. | |
| Message | Long text | Empty for the default. {{link}} is a link to the record. | |
| Active | Yes or no |
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.