mirror of
https://github.com/kingomarnajjar/flex-template-web.git
synced 2026-07-31 02:26:50 +10:00
156 lines
4.6 KiB
Markdown
156 lines
4.6 KiB
Markdown
# Mail templates
|
|
|
|
This directory contains the default templates for all mails sent by default as
|
|
result of activity in the marketplace.
|
|
|
|
Before making customizations, copy the templates to another directory (e.g.
|
|
`mail-templates`). Note that, at present, changes made to the template files in
|
|
this repository will not take effect automatically. Marketplace owner needs to
|
|
notify the Sharetribe team.
|
|
|
|
## Template parts
|
|
|
|
A template consists of three files:
|
|
|
|
* `TEMPLATE_NAME-subject.txt` - holds the mail Subject line template
|
|
* `TEMPLATE_NAME-text.txt` - holds the template for the plain text version of the mail
|
|
* `TEMPLATE_NAME-html.html` - contains the template for the HTML version of the mail
|
|
|
|
All the parts are mandatory. All emails that are sent from the marketplace
|
|
contain both the plain text and HTML variants and the recipient's mail client is
|
|
free to choose which one to visualize and how.
|
|
|
|
## Template syntax
|
|
|
|
Templates use [Handlebars](http://handlebarsjs.com/) syntax.
|
|
|
|
Example html:
|
|
|
|
```html
|
|
<html>
|
|
<body>
|
|
<p>Hello {{recipient.first-name}},</p>
|
|
|
|
<p>Your <em>{{marketplace.name}}</em> account's email address was changed.</p>
|
|
|
|
<p>If you didn't make this change, please contact us.</p>
|
|
|
|
<p>Best regards,<br />The {{marketplace.name}} team</p>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
Example text version:
|
|
|
|
```
|
|
Hello {{recipient.first-name}},
|
|
|
|
Your {{marketplace.name}} account's email address was changed.
|
|
|
|
If you didn't make this change, please contact us.
|
|
|
|
Best regards,
|
|
The {{marketplace.name}} team
|
|
```
|
|
|
|
Variables within `{{ }}` are expanded and escaped, so that they are safe to
|
|
place inside HTML content. As seen above, some variables have nested values,
|
|
which can be accessed with dot `.` operator.
|
|
|
|
The template syntax supports conditionals, loops, helpers and other constructs.
|
|
For details see the [Handlebars documentation](http://handlebarsjs.com/).
|
|
|
|
## List of templates
|
|
|
|
### Built-in event mails
|
|
|
|
#### email-changed
|
|
|
|
Sent to a user when their registered email address has been successfully
|
|
changed.
|
|
|
|
#### new-message
|
|
|
|
Sent to a user when the other party in a transaction has sent them a new
|
|
message.
|
|
|
|
#### password-changed
|
|
|
|
Sent to a user when their account's password was successfully changed.
|
|
|
|
#### reset-password
|
|
|
|
Sent to a user when a request for resetting their password is received. The mail
|
|
contains a link with password reset token and instructs the user to complete the
|
|
password reset.
|
|
|
|
#### verify-changed-email-address
|
|
|
|
Sent to a user when they have requested to change their registered email
|
|
address. The mail contains an email verification link and instructs the user how
|
|
to verify their email address.
|
|
|
|
#### verify-email-address
|
|
|
|
Sent to a user after they sign up for an account in the marketplace and
|
|
instructs them to verify their email address.
|
|
|
|
#### user-joined
|
|
|
|
Sent to a new marketplace user after they verify their email address.
|
|
|
|
### Transaction engine mails
|
|
|
|
The templates in the list below correspond to mails defined in the default
|
|
transaction process. Customized transaction processes can have different set of
|
|
mail templates.
|
|
|
|
`customer` and `provider` below mean the corresponding parties in a transaction.
|
|
|
|
#### booking-request-accepted
|
|
|
|
Sent to the customer when the provider accepts a booking and the customer's
|
|
payment is captured.
|
|
|
|
#### booking-request-auto-declined
|
|
|
|
Sent to the customer when the provider does not accept the booking within the
|
|
allowed time and the transaction is automatically declined.
|
|
|
|
#### booking-request-declined
|
|
|
|
Sent to the customer when the provider manually declines a transaction.
|
|
|
|
#### money-paid
|
|
|
|
Sent to the provider when a booking's end date has passed and payment is sent to
|
|
the provider's bank account.
|
|
|
|
#### new-booking-request
|
|
|
|
Sent when a customer makes a new booking and preauthorizes payment.
|
|
|
|
#### review-by-customer-wanted
|
|
|
|
Sent to the customer when the booking end-date has passed and reviews for the
|
|
transaction can be posted. This mail should prompt the recipient to write a
|
|
review.
|
|
|
|
#### review-by-other-party-published
|
|
|
|
Sent to one of the parties in a transaction when the other party has posted a
|
|
review and the review has been published (i.e. contents of the review are
|
|
public).
|
|
|
|
#### review-by-other-party-unpublished
|
|
|
|
Sent to one of the parties in a transation when the other party has posted a
|
|
review but the review is not yet published, because the first party hasn't yet
|
|
posted their review or the review time has not expired. This mail should prompt
|
|
the recipient to write their own review.
|
|
|
|
#### review-by-provider-wanted
|
|
|
|
Sent to the customer when the booking end-date has passed and reviews for the
|
|
transaction can be posted. This mail should prompt the recipient to write a
|
|
review.
|