Documentation: System Emails
About System Emails
System Emails DocumentationAbout System Emails
System emails are automatically generated messages sent to users at various points in Consul Democracy processes. This section documents emails related to Participatory Budgets.
Each email is constructed from multiple text strings. While default values are provided, you can customize any string to match your organization's communication style.
1. Budget Investment Created Email
Sent when a user successfully submits a new investment proposal.
| String Key | Default Value | Variables | Purpose & Usage |
|---|---|---|---|
| Email Metadata | |||
| mailers.budget_investment_created.subject | Thank you for creating an investment! | — | Email subject line shown in the recipient's inbox. |
| Email Content | |||
| mailers.budget_investment_created.title | Thank you for creating an investment! | — | Main heading displayed inside the email body. |
| mailers.budget_investment_created.intro | Hi %{author}, | %{author} | Introductory greeting. The variable will be replaced with the investment creator's username. |
| mailers.budget_investment_created.text | Thank you for creating your investment %{investment} for Participatory Budgets %{budget}. | %{investment} %{budget} | Main body content. You can customize this to explain next steps or add specific instructions. |
| mailers.budget_investment_created.follow | We will inform you about how the process progresses, which you can also follow on %{link}. | %{link} | Directs users to follow the budget process. Creates a clickable hyperlink to the budget page. |
| mailers.budget_investment_created.follow_link | Participatory Budgets | — | The clickable text that appears as the hyperlink in the "follow" section. |
| mailers.budget_investment_created.share | Share your project | — | Button text that links to social sharing options for the investment. |
| Closing | |||
| mailers.budget_investment_created.sincerely | Sincerely, | — | Closing signature before the organization name or sender details. |
2. Budget Investment Unfeasible Email
Note: This email has a different structure and different variables from the "created" email.
Sent when an investment project is marked as unfeasible (will not proceed to the next phase).
| String Key | Default Value | Variables | Purpose & Usage |
|---|---|---|---|
| Email Metadata | |||
| mailers.budget_investment_unfeasible.subject | Your investment project '%{code}' has been marked as unfeasible | %{code} | Includes project code in subject line for easy reference. |
| Email Content | |||
| mailers.budget_investment_unfeasible.title | Your investment project has been marked as unfeasible | — | Main heading (uses softer language than the subject line). |
| mailers.budget_investment_unfeasible.hi | Dear %{author}, | %{author} | More formal greeting using "Dear" instead of "Hi". |
| mailers.budget_investment_unfeasible.intro | Following a review of your application, we are sorry to inform you that your application %{investment} for budget %{budget} will not be proceeding to the next phase this time because it does not meet the criteria for the fund | %{investment} %{budget} | Main rejection explanation. Note: No HTML tags in default value. |
| mailers.budget_investment_unfeasible.new | Please do consider submitting a new application to future opportunities | — | Encouragement to apply again in the future. |
| mailers.budget_investment_unfeasible.new_href | new investment project | — | Link text for new application (typically becomes a clickable link in the email). |
| mailers.budget_investment_unfeasible.sorry | Sorry for any disappointment this causes and we again thank you for your invaluable participation. | — | Apology and appreciation statement to soften the rejection. |
| Closing | |||
| mailers.budget_investment_unfeasible.sincerely | Sincerely | — | Closing signature (no comma, different from "created" email). |
3. Budget Investment Selected Email
Note: This email has yet another different structure and variable set.
Sent when an investment project has been selected to proceed to the next phase.
| String Key | Default Value | Variables | Purpose & Usage |
|---|---|---|---|
| Email Metadata | |||
| mailers.budget_investment_selected.subject | Your investment project '%{code}' has been selected | %{code} | Includes project code for easy identification (similar to unfeasible email). |
| Email Content | |||
| mailers.budget_investment_selected.title | Your investment project has been selected | — | Main heading announcing the selection. |
| mailers.budget_investment_selected.hi | Dear user, | — | Uses generic "Dear user" instead of personalized %{author}. |
| mailers.budget_investment_selected.share | Start to get votes, share your investment project on social networks. Share is essential to make it a reality. | — | Instructions encouraging the user to share their project to gather votes. |
| mailers.budget_investment_selected.share_button | Share your investment project | — | Button text for sharing the project on social media. |
| mailers.budget_investment_selected.thanks | Thank you again for participating. | — | Thank you message acknowledging participation. |
| Closing | |||
| mailers.budget_investment_selected.sincerely | Sincerely | — | Closing signature (no comma, consistent with unfeasible email). |
- Variables must be included exactly as shown (e.g., %{author}, %{investment}).
- HTML tags are supported in most text fields for formatting, but note that unfeasible and selected emails use plain text by default.
- Special link variables like %{link} will automatically create clickable hyperlinks.
- To create custom links in plain text fields, use: <a href="URL_HERE">Link Text</a>
- Consistency check: Consider aligning "sincerely" format across all email types if desired.
- Personalization: You might want to add %{author} to the selected email greeting for better personalization.
- Each email type has its own view template and mailer method.
- The %{new_href} in unfeasible email likely needs to be turned into a clickable link in the view code.
- Consider whether the selected email should use %{author} instead of "Dear user," for better personalization.
- All emails support customization through the custom_information_texts system.
- Use the %{investment} and %{budget} variables to create dynamic links.