aboutsummaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/email.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/administration/CLI_tasks/email.md')
-rw-r--r--docs/administration/CLI_tasks/email.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/email.md b/docs/administration/CLI_tasks/email.md
new file mode 100644
index 0000000..2bb57be
--- /dev/null
+++ b/docs/administration/CLI_tasks/email.md
@@ -0,0 +1,45 @@
+# EMail administration tasks
+
+{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+
+## Send test email (instance email by default)
+
+=== "OTP"
+
+ ```sh
+ ./bin/pleroma_ctl email test [--to <destination email address>]
+ ```
+
+=== "From Source"
+
+ ```sh
+ mix pleroma.email test [--to <destination email address>]
+ ```
+
+Example:
+
+=== "OTP"
+
+ ```sh
+ ./bin/pleroma_ctl email test --to root@example.org
+ ```
+
+=== "From Source"
+
+ ```sh
+ mix pleroma.email test --to root@example.org
+ ```
+
+## Send confirmation emails to all unconfirmed user accounts
+
+=== "OTP"
+
+ ```sh
+ ./bin/pleroma_ctl email resend_confirmation_emails
+ ```
+
+=== "From Source"
+
+ ```sh
+ mix pleroma.email resend_confirmation_emails
+ ```