summaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/email.md
diff options
context:
space:
mode:
authorHaelwenn (lanodan) Monnier <contact@hacktivis.me>2020-01-20 13:23:21 +0100
committerHaelwenn (lanodan) Monnier <contact@hacktivis.me>2020-01-28 16:49:38 +0100
commit4eb935be78eeaf1decb7fc109cec09ca18d82854 (patch)
tree4be2d8c3c0edce50783de984123c6a563affb018 /docs/administration/CLI_tasks/email.md
parentb12f3064730648de992f934cf5a23cadb5206b9d (diff)
downloadpleroma-4eb935be78eeaf1decb7fc109cec09ca18d82854.tar.gz
pleroma-4eb935be78eeaf1decb7fc109cec09ca18d82854.zip
Create pleroma.email mix task
Closes: https://git.pleroma.social/pleroma/pleroma/issues/1061
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
+```