diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/administration/CLI_tasks/user.md | 33 | ||||
| -rw-r--r-- | docs/configuration/cheatsheet.md | 9 | ||||
| -rw-r--r-- | docs/development/API/differences_in_mastoapi_responses.md | 1 |
3 files changed, 43 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/user.md b/docs/administration/CLI_tasks/user.md index 24fdaeab4..61774f469 100644 --- a/docs/administration/CLI_tasks/user.md +++ b/docs/administration/CLI_tasks/user.md @@ -300,3 +300,36 @@ ```sh mix pleroma.user unconfirm_all ``` + +## Update email notifications settings for user + +=== "OTP" + + ```sh + ./bin/pleroma_ctl user email_notifications <nickname> [option ...] + ``` + +=== "From Source" + + ```sh + mix pleroma.user email_notifications <nickname> [option ...] + ``` + +### Options + +- `--digest`/`--no-digest` - whether the user should receive digest emails +- `--notifications` - what types of email notifications user should receive (can be aliased with `-n`). To disable all types pass `off` value. + +Example: + +=== "OTP" + + ```sh + ./bin/pleroma_ctl user email_notifications lain --digest -n mention + ``` + +=== "From Source" + + ```sh + mix pleroma.user email_notifications lain --digest -n mention + ``` diff --git a/docs/configuration/cheatsheet.md b/docs/configuration/cheatsheet.md index 069421722..262978b7d 100644 --- a/docs/configuration/cheatsheet.md +++ b/docs/configuration/cheatsheet.md @@ -715,6 +715,7 @@ Pleroma has these periodic job workers: * `Pleroma.Workers.Cron.DigestEmailsWorker` - digest emails for users with new mentions and follows * `Pleroma.Workers.Cron.NewUsersDigestWorker` - digest emails for admins with new registrations +* `Pleroma.Workers.Cron.EmailMentionsWorker` - email with missed mentions notifications in special timeframe ```elixir config :pleroma, Oban, @@ -726,6 +727,7 @@ config :pleroma, Oban, federator_outgoing: 50 ], crontab: [ + {"*/15 * * * *", Pleroma.Workers.Cron.EmailMentionsWorker}, {"0 0 * * 0", Pleroma.Workers.Cron.DigestEmailsWorker}, {"0 0 * * *", Pleroma.Workers.Cron.NewUsersDigestWorker} ] @@ -1154,3 +1156,10 @@ Each job has these settings: * `:max_running` - max concurrently runnings jobs * `:max_waiting` - max waiting jobs + +## Mention emails (Pleroma.Workers.Cron.EmailMentionsWorker) + +The worker sends email notifications not read in a certain timeframe. + +* `:enabled` - enables email notifications for missed mentions & chat mentions +* `:timeframe` - the period after which the sending of emails begins for missed mentions (in minutes) diff --git a/docs/development/API/differences_in_mastoapi_responses.md b/docs/development/API/differences_in_mastoapi_responses.md index 2ff56d3ca..72949c9d7 100644 --- a/docs/development/API/differences_in_mastoapi_responses.md +++ b/docs/development/API/differences_in_mastoapi_responses.md @@ -107,6 +107,7 @@ Has these additional fields under the `pleroma` object: - `notification_settings`: object, can be absent. See `/api/v1/pleroma/notification_settings` for the parameters/keys returned. - `accepts_chat_messages`: boolean, but can be null if we don't have that information about a user - `favicon`: nullable URL string, Favicon image of the user's instance +- `email_notifications`: map with settings for `digest` emails (boolean) and `notifications` setting (list with notification types). ### Source |