Skip to content

Commit 79a6266

Browse files
committed
email.md: fix typo
1 parent 49a074e commit 79a6266

1 file changed

Lines changed: 65 additions & 65 deletions

File tree

docs/guides/email.md

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,43 @@
1-
# Email settings
1+
# Email settings
22

3-
pretix offers you many options for contacting your customers and attendees via email—both on the organizer level and on the event level.
4-
You can use either the system-provided email server or your organization's own.
5-
pretix comes with many pre-configured email messages that you can customize to your needs.
6-
This article tells you how to set up your desired email server solution within pretix and how to customize email content.
3+
pretix offers you many options for contacting your customers and attendees via email—both on the organizer level and on the event level.
4+
You can use either the system-provided email server or your organization's own.
5+
pretix comes with many pre-configured email messages that you can customize to your needs.
6+
This article tells you how to set up your desired email server solution within pretix and how to customize email content.
77

88
## Prerequisites
99

10-
Your account needs to be activated before you can use pretix to send out emails.
11-
See the tutorial's section on [account activation](../tutorial/organizer-account.md#activation) for further information.
10+
Your account needs to be activated before you can use pretix to send out emails.
11+
See the tutorial's section on [account activation](../tutorial/organizer-account.md#activation) for further information.
1212

13-
## How to
13+
## How to
1414

15-
### General email settings
15+
### General email settings
1616

17-
By default, the general email settings are handled on the organizer level.
18-
Navigate to :navpath:Your organizer → :fa3-wrench: Settings → E-Mail:.
19-
Click the :btn-icon:fa3-edit: Edit: button next to "Sending method" and choose one of the three options:
17+
By default, the general email settings are handled on the organizer level.
18+
Navigate to :navpath:Your organizer → :fa3-wrench: Settings → E-Mail:.
19+
Click the :btn-icon:fa3-edit: Edit: button next to "Sending method" and choose one of the three options:
2020

21-
1. **Use system default:** system-provided email server.
22-
Emails will be sent from `support@pretix.eu`.
23-
Emails for customer account registration, email change, and password reset will have your organizer account's name in the name field.
24-
All other emails with have the event name in the name field.
25-
Your organizer's contact address will be used as the reply-to address.
26-
If you want to change the reply-to address, navigate to :navpath: Your organizer → :fa3-wrench: Settings → General:, change "Contact address" and click the :btn:Save: button.
27-
2. **Use system email server with a custom sender address:** system-provided email server.
28-
Emails will be sent from a custom email address.
21+
1. **Use system default:** system-provided email server.
22+
Emails will be sent from `support@pretix.eu`.
23+
Emails for customer account registration, email change, and password reset will have your organizer account's name in the name field.
24+
All other emails will have the event name in the name field.
25+
Your organizer's contact address will be used as the reply-to address.
26+
If you want to change the reply-to address, navigate to :navpath: Your organizer → :fa3-wrench: Settings → General:, change "Contact address" and click the :btn:Save: button.
27+
2. **Use system email server with a custom sender address:** system-provided email server.
28+
Emails will be sent from a custom email address.
2929
This requires adding the pretix application server to your mail server's SPF record (see [Using system email server with a custom sender address](email.md#using-system-email-server-with-a-custom-sender-address) below).
30-
3. **Use a custom SMTP server:** Use your organization's own SMTP server and fully customize mailing.
30+
3. **Use a custom SMTP server:** Use your organization's own SMTP server and fully customize mailing.
3131

32-
If you want to change the general email settings for an individual event, you can unlock them for that event.
33-
Unlocking the settings is irreversible.
34-
Once they are unlocked, changing email settings for your organizer does not change the settings for this particular event anymore.
35-
Navigate to :navpath:Your event → :fa3-wrench: Settings → E-Mail: and click the :btn-icon:fa3-unlock: Unlock: buttons as required.
32+
If you want to change the general email settings for an individual event, you can unlock them for that event.
33+
Unlocking the settings is irreversible.
34+
Once they are unlocked, changing email settings for your organizer does not change the settings for this particular event anymore.
35+
Navigate to :navpath:Your event → :fa3-wrench: Settings → E-Mail: and click the :btn-icon:fa3-unlock: Unlock: buttons as required.
3636

3737
### Using system email server with a custom sender address
3838

3939
If you use an email address with your own domain as the sender address and do not use a custom SMTP server, you have to add the pretix application server to your SPF record.
40-
This is necessary to prevent your emails being misidentified as spam.
40+
This is necessary to prevent your emails being misidentified as spam.
4141

4242
You can add an SPF record in the administrative console of the provider with whom you registered your domain.
4343
The exact process varies from provider to provider.
@@ -57,30 +57,30 @@ If you want to authenticate your emails with DKIM, set up a `CNAME` record for t
5757

5858
`pretix._domainkey.mydomain.com. CNAME dkim.pretix.eu.`
5959

60-
Contact our support team to enable DKIM for your domain on our mail servers.
60+
Contact our support team to enable DKIM for your domain on our mail servers.
6161

62-
If you are sending out a large volume of emails, email providers such as Google Mail also require you to have a DMARC policy.
63-
Specifying the DMARC policy as `p=none` is enough.
62+
If you are sending out a large volume of emails, email providers such as Google Mail also require you to have a DMARC policy.
63+
Specifying the DMARC policy as `p=none` is enough.
6464

65-
### Customizing email content
65+
### Customizing email content
6666

67-
If you want to customize the content of emails for customer account registration, email change, and password reset, navigate to :navpath:Your organizer → :fa3-wrench: Settings → E-Mail: and switch to the :btn:E-mail content: tab.
68-
All other types of email content are customized on the event level.
67+
If you want to customize the content of emails for customer account registration, email change, and password reset, navigate to :navpath:Your organizer → :fa3-wrench: Settings → E-Mail: and switch to the :btn:E-mail content: tab.
68+
All other types of email content are customized on the event level.
6969

70-
If you want to customize the content of emails for orders, purchased products, and payments, navigate to :navpath:Your event → :fa3-wrench: Settings → E-Mail: and open the :btn:E-mail content: tab.
71-
Emails related to the customer account are handled on the organizer level.
70+
If you want to customize the content of emails for orders, purchased products, and payments, navigate to :navpath:Your event → :fa3-wrench: Settings → E-Mail: and open the :btn:E-mail content: tab.
71+
Emails related to the customer account are handled on the organizer level.
7272

73-
What follows is a list of all available placeholders, their function and an example.
74-
Not all placeholders are available for every type of email.
75-
The available placeholders are listed underneath the fields for the email's subject line and body in the backend.
73+
What follows is a list of all available placeholders, their function and an example.
74+
Not all placeholders are available for every type of email.
75+
The available placeholders are listed underneath the fields for the email's subject line and body in the backend.
7676

77-
| Placeholder | Function | Example |
77+
| Placeholder | Function | Example |
7878
|------------------------------------|------------------------------------------------------------------------------------------------------------------|-------------|
7979
| `{attendee_name}` | name of the attendee represented by the ticket | John Doe |
8080
| `{code}` | order code **or** voucher code to redeem for the waiting list | F8VVL **or** 68CYU2H6ZTP3WLK5 |
8181
| `{comment}` | reason for the rejection or cancellation of an order | An individual text with a reason can be inserted here. |
8282
| `{currency}` | three-letter code for the event's currency | EUR |
83-
| `{event}` | name of the event | Tutorial Conference |
83+
| `{event}` | name of the event | Tutorial Conference |
8484
| `{event_admission_time}` | admission time of the event | 6:00 AM |
8585
| `{event_location}` | location of the event | Berthold-Mogel-Straße 1 |
8686
| `{event_slug}` | short form of the event | tutcon27 |
@@ -92,9 +92,9 @@ The available placeholders are listed underneath the fields for the email's subj
9292
| `{name_family_name}` | family name of recipient | Doe |
9393
| `{name_for_salutation}` | preferred address, title and name | Dr. John Doe |
9494
| `{name_given_name}` | given name of recipient | John |
95-
| `{order_modification_deadline_date_and_time}` | time and date of the deadline for making modifications to the order | June 4, 2027, 6:00 AM
95+
| `{order_modification_deadline_date_and_time}` | time and date of the deadline for making modifications to the order | June 4, 2027, 6:00 AM
9696
| `{orders}` | list of orders including links to their status pages, specific to the “resend link (requested by user)” email | • TUTCON27-F8VVL - https://pretix.eu/tut/tutcon27/order/F8VVL/6zzjnumtsx136ddy/open/abcdefghi/ <br> • TUTCON27-HIDHK - https://pretix.eu/tut/tutcon27/order/HIDHK/98kusd8ofsj8dnkd/open/jklmnopqr/ <br> • TUTCON27-OPKSB - https://pretix.eu/tut/tutcon27/order/OPKSB/09pjdksflosk3njd/open/stuvwxy2z/ |
97-
| `{organizer}` | name of the organizer | Tutorial Ltd. |
97+
| `{organizer}` | name of the organizer | Tutorial Ltd. |
9898
| `{payment_info}` | information about the payment method (e.g. banking details) | The amount has been charged to your card. |
9999
| `{product}` | the product that has become available on the waiting list | Discount ticket |
100100
| `{refund_amount}` | in event cancellation emails, the amount of money that will be refunded, including the currency | €42.23 |
@@ -106,36 +106,36 @@ The available placeholders are listed underneath the fields for the email's subj
106106
| `{url_cancel}` | URL pointing to the order's cancellation page | https://pretix.eu/tut/tutcon27/order/F8VVL/6zzjnumtsx136ddy/cancel |
107107
| `{url_info_change}` | URL pointing to the order's ticket information page | https://pretix.eu/tut/tutcon27/order/F8VVL/6zzjnumtsx136ddy/modify |
108108
| `{url_products_change}` | URL pointing to the order's products page of the order | https://pretix.eu/tut/tutcon27/order/F8VVL/6zzjnumtsx136ddy/change |
109-
| `{url_remove}` | URL that allows the customer to remove themselves from the waiting list | https://pretix.eu/tut/tutcon27/waitinglist/remove?voucher=68CYU2H6ZTP3WLK5 |
109+
| `{url_remove}` | URL that allows the customer to remove themselves from the waiting list | https://pretix.eu/tut/tutcon27/waitinglist/remove?voucher=68CYU2H6ZTP3WLK5 |
110110

111-
Clicking the :btn-icon:fa3-tv: Preview: tab gives you a preview of the content with placeholders replaced by examples.
112-
If you have used a placeholder that is not available for that particular mail, then an error notification is displayed saying "Invalid placeholder: {placeholder}".
111+
Clicking the :btn-icon:fa3-tv: Preview: tab gives you a preview of the content with placeholders replaced by examples.
112+
If you have used a placeholder that is not available for that particular mail, then an error notification is displayed saying "Invalid placeholder: {placeholder}".
113113

114-
The "Free order" email is sent if a customer places an order exclusively containing free products.
115-
The "Placed order" email is sent if a customer places an order with a total higher than zero.
116-
The "Paid order" email is sent after the payment for an order has been registered.
117-
Depending on the payment method, this can be right after the "Placed order" email.
114+
The "Free order" email is sent if a customer places an order exclusively containing free products.
115+
The "Placed order" email is sent if a customer places an order with a total higher than zero.
116+
The "Paid order" email is sent after the payment for an order has been registered.
117+
Depending on the payment method, this can be right after the "Placed order" email.
118118

119-
### Manually sending out emails
119+
### Manually sending out emails
120120

121121
The settings for emails described above are all tied to certain actions in the pretix backend.
122-
However, you can also send out emails at a time of your choosing.
122+
However, you can also send out emails at a time of your choosing.
123123

124-
If you want to send out an email right away, navigate to :navpath:Your event → :fa3-envelope: Send out emails → Send email:.
125-
If your email is related to waiting lists, select :btn:Waiting list:.
126-
If your email is relevant for exhibitors, select :btn:Exhibitors:.
127-
This option is only displayed if the "Exhibitors" plugin is enabled.
128-
In all other cases, select :btn:Orders or attendees:.
124+
If you want to send out an email right away, navigate to :navpath:Your event → :fa3-envelope: Send out emails → Send email:.
125+
If your email is related to waiting lists, select :btn:Waiting list:.
126+
If your email is relevant for exhibitors, select :btn:Exhibitors:.
127+
This option is only displayed if the "Exhibitors" plugin is enabled.
128+
In all other cases, select :btn:Orders or attendees:.
129129

130-
You can further restrict who receives the email by product, order status, time that the order was placed, and check-in status.
131-
The subject line and message can be customized with text and placeholders.
132-
Tickets, calendar files or other files can be attached.
133-
Once you are happy with the email's contents, click :btn:Preview email:.
134-
The ":fa3-send: Send" button displays the number of matching recipients.
135-
You can double-check your settings on the preview page and then click the :btn-icon:fa3-send: Send (# matching orders): button.
130+
You can further restrict who receives the email by product, order status, time that the order was placed, and check-in status.
131+
The subject line and message can be customized with text and placeholders.
132+
Tickets, calendar files or other files can be attached.
133+
Once you are happy with the email's contents, click :btn:Preview email:.
134+
The ":fa3-send: Send" button displays the number of matching recipients.
135+
You can double-check your settings on the preview page and then click the :btn-icon:fa3-send: Send (# matching orders): button.
136136

137137
If you want to schedule emails to be sent out at a later date, navigate to :navpath:Your event → :fa3-envelope: Send out emails → Scheduled emails:
138-
This page displays a list of all scheduled email rules.
139-
You can add a new one by clicking the :btn:Create a new rule: button.
140-
Specify your email contents, recipients, and the date and time at which the email shall be sent.
141-
The date and time can be absolute or relative to the event start or end.
138+
This page displays a list of all scheduled email rules.
139+
You can add a new one by clicking the :btn:Create a new rule: button.
140+
Specify your email contents, recipients, and the date and time at which the email shall be sent.
141+
The date and time can be absolute or relative to the event start or end.

0 commit comments

Comments
 (0)