mirror of
https://github.com/wassname/talk.git
synced 2026-07-10 05:39:38 +08:00
immber
4d41d999fb
* added storyURL and storyID * added story scraping section * fixed typo on sso * rebaseing on latest release/4 branch * updated version on slack docs * added Contributing a Translation section to developing * fixing typos * updated v5 config page, reorder list, add toc * added cli sect, fixed contact menu link * updated talk to coral on contact page * added a new v5 auth section * added session length to auth docs * added an admin settings page to v5 * added v5 css section * added a v5 notifications section * updated faq and troubleshooting, moved out of v4 menu * added migrating to v5 and moved migrating section out of v4 * added plugins note to migration pg * fix: linting and extra HTML * change sidebar migrating v5 to v5.0+ Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * downtime being likely is too optimistic, it will be required Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * rewords plugins note on migrating to v5 Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * tag code block as html Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * added link to contributing * rephrased openid connect description * fixed link to contributing * correcting descriptions of email auth behavior Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * Adding link to css classnames Co-Authored-By: Wyatt Johnson <wyattjoh@gmail.com> * renamed new auth to Social and Email Authentication * pulled extra line breaks Co-authored-by: Wyatt Johnson <accounts+github@wyattjoh.ca>
66 lines
2.9 KiB
Markdown
66 lines
2.9 KiB
Markdown
---
|
|
title: Emails & Notifications
|
|
permalink: /v5/notifications/
|
|
---
|
|
|
|
There are several email notifications included with Coral by default that will be sent to users based on user activity.
|
|
|
|
_NOTE: Notifications are only supported for users that have a valid email address! If you are using authenticate via Facebook, Google, or OpenIDConnect, user emails are not automatically required._
|
|
|
|
### Configuring SMTP
|
|
|
|
You must setup SMTP to send email notifications.
|
|
See our documentation on [Email SMTP Settings](/talk/v5/administration/#email-smtp-settings) for reference.
|
|
|
|
When running in production we recommend using a 3rd party mail service provider like SendGrid or MailGun.
|
|
|
|
|
|
### Notification Types
|
|
|
|
In addition to the comment activity notifications, Coral also provides users with several transactional notifications about their user profile.
|
|
|
|
Comment activity notifications are set to OFF for individual users by default, and commenters must opt-in to enable activity notifications. Commenters cannot enable notifications until they have verified their email, and are not able to opt-out of transactional notifications such as when a user has been Banned or Suspended.
|
|
|
|
|
|
#### Type: User Profile Notifications
|
|
|
|
* When a new Staff, Moderator, or Admin user is invited, sends invitation
|
|
* When any user registers, sends confirmation and email verification link
|
|
* When user requests password reset, sends reset link
|
|
* When user changes username, sends change confirmation
|
|
* When user changes their email address, sends change confirmation and email verification link
|
|
* When a user is banned or suspended, sends notice
|
|
* When comment history is ready for download (only one link can be generated every 7 days, and the link is valid for 24 hours), sends download link
|
|
* When user requests account deletion, cancels account deletion, or account deletion has been completed, sends confirmation
|
|
|
|
_NOTE: Users can not opt-out of User Profile Notifications_
|
|
|
|
|
|
#### Type: Comment Activity Notifications
|
|
|
|
Commenter users can subscribe to the following comment activity notificaitons:
|
|
|
|
* When one of my comments receives a reply
|
|
* When a Staff, Moderator, or Admin user replies to one of my comments
|
|
* When a Moderator Features one of my comments
|
|
* When one of my pending comments has been APPROVED or REJECTED
|
|
|
|
|
|
Commenters have 3 options for activity notification frequency:
|
|
* Immediately
|
|
* Hourly
|
|
* Daily
|
|
|
|
Immediately will send one email notification per occurance, versus sending an hourly or daily summary with all occurances listed.
|
|
|
|
### Email Templates
|
|
|
|
Email templates are text based and support translations. Many of the transactional emails can be modified by Moderators at the time of sending to provide additional context to users.
|
|
|
|
Coral does not currently support customizing email templates beyond the default templates.
|
|
|
|
To view the current email text strings for US English visit: https://github.com/coralproject/talk/blob/master/src/core/server/locales/en-US/email.ftl
|
|
|
|
|
|
|