summaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/email.md
diff options
context:
space:
mode:
authorlain <lain@soykaf.club>2020-01-28 17:52:42 +0100
committerlain <lain@soykaf.club>2020-01-28 17:52:42 +0100
commitcedee2793d96b0384a3041ea0a6cd1f2b1c3dd1e (patch)
treedfc1a2b2bb27d845bbde24b023287122f5d39ed7 /docs/administration/CLI_tasks/email.md
parentae78059ff433739b83aaa3ccff9245ace153146d (diff)
parente8f22451da18aeba9bcf9f9f6acf93690ccb3cba (diff)
downloadpleroma-cedee2793d96b0384a3041ea0a6cd1f2b1c3dd1e.tar.gz
pleroma-cedee2793d96b0384a3041ea0a6cd1f2b1c3dd1e.zip
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into features/remote-follow-userpage-redirect
Diffstat (limited to 'docs/administration/CLI_tasks/email.md')
-rw-r--r--docs/administration/CLI_tasks/email.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/email.md b/docs/administration/CLI_tasks/email.md
new file mode 100644
index 000000000..7b7a8457a
--- /dev/null
+++ b/docs/administration/CLI_tasks/email.md
@@ -0,0 +1,24 @@
+# Managing emails
+
+{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+
+## Send test email (instance email by default)
+
+```sh tab="OTP"
+ ./bin/pleroma_ctl email test [--to <destination email address>]
+```
+
+```sh tab="From Source"
+mix pleroma.email test [--to <destination email address>]
+```
+
+
+Example:
+
+```sh tab="OTP"
+./bin/pleroma_ctl email test --to root@example.org
+```
+
+```sh tab="From Source"
+mix pleroma.email test --to root@example.org
+```