mirrors/nextcloud-documentation
3
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2025-10-26 11:18:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Proofread the email configuration documentation

Browse Source 
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
This commit is contained in:
Morris Jobke 2018-11-30 16:44:34 +01:00 committed by Backportbot
parent bb3c737ec6
commit cc50b8e372
1 changed files with 10 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
admin_manual/configuration_server/email_configuration.rst
View File

@ -13,7 +13,7 @@ or it may be a remote server.
.. figure:: ../images/smtp-config-wizard.png
With the new wizard, connecting Nextcloud to your mail server is fast and easy.
With the wizard, connecting Nextcloud to your mail server is fast and easy.
The wizard fills in the values in ``config/config.php``, so you may use either
or both as you prefer.
@ -67,10 +67,7 @@ of your mail server options in one place, in your mail server configuration then
Using email templates
---------------------
We removed the template editor in Nextcloud 12 because we changed how emails
are generated. While the customization capabilities offered by the template editor
were easy to use, they often resulted in broken emails. To fix this, we designed a
much easier mechanism that automatically generates emails which follow the theme
We designed a mechanism that generates emails which follow the theming
settings and look the same in all the different email clients out there.
.. note:: If, for some reason, you need text-only emails, consider simply configuring
@ -82,9 +79,9 @@ settings and look the same in all the different email clients out there.
Modifying the look of emails beyond the theming app capabilities
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can now overwrite templates by writing a class that implements the template interface
(or extends it to not need to copy over everything). Easiest way is then put this class into
an app and load it (so you do not need to patch it on every update).
You can overwrite templates by writing a class that implements the template interface
(or extends it to not need to copy over everything). Easiest way is to then put this class into
an app and load it so you do not need to patch it on every update.
This is the interface of the class that needs to be implemented: https://github.com/nextcloud/server/blob/master/lib/public/Mail/IEMailTemplate.php
@ -92,9 +89,9 @@ That is the implementation that could be extended and used to see how it works:
An example from `a GitHub issue <https://portal.nextcloud.com/article/customized-email-templates-29.html>`_:
1. Look at the source code of extended class `OC\Mail\EMailTemplate::class <https://github.com/nextcloud/server/blob/master/lib/private/Mail/EMailTemplate.php>`_
1. Look at the source code of extended class `OC\\Mail\\EMailTemplate::class <https://github.com/nextcloud/server/blob/master/lib/private/Mail/EMailTemplate.php>`_
2. Then override what you need in your own `OC\Mail\EMailTemplate::class` extension
2. Then override what you need in your own `OC\\Mail\\EMailTemplate::class` extension
**Example:**
@ -138,8 +135,6 @@ port 25/tcp will be used unless you change that by modifying the
::
<?php
"mail_smtpmode" => "smtp",
"mail_smtphost" => "smtp.server.dom:425",
@ -147,8 +142,6 @@ or
::
<?php
"mail_smtpmode" => "smtp",
"mail_smtphost" => "smtp.server.dom",
"mail_smtpport" => 425,
@ -158,8 +151,6 @@ necessary that you increase the SMTP timeout to e.g. 30s:
::
<?php
"mail_smtptimeout" => 30,
If the SMTP server accepts insecure connections, the default setting can be
@ -167,8 +158,6 @@ used:
::
<?php
"mail_smtpsecure" => '',
If the SMTP server only accepts secure connections you can choose between
@ -182,8 +171,6 @@ which uses the port 465/tcp:
::
<?php
"mail_smtphost" => "smtp.server.dom:465",
"mail_smtpsecure" => 'ssl',
@ -194,8 +181,6 @@ uses the default port 25/tcp:
::
<?php
"mail_smtphost" => "smtp.server.dom",
"mail_smtpsecure" => 'tls',
@ -204,8 +189,6 @@ authentication, if not, the default values can be taken as is.
::
<?php
"mail_smtpauth" => false,
"mail_smtpname" => "",
"mail_smtppassword" => "",
@ -216,8 +199,6 @@ and password and can optionally choose between the authentication types
::
<?php
"mail_smtpauth" => true,
"mail_smtpauthtype" => "LOGIN",
"mail_smtpname" => "username",
@ -233,8 +214,6 @@ Nextcloud should be able to send email out of the box.
::
<?php
"mail_smtpmode" => "sendmail",
"mail_smtphost" => "127.0.0.1",
"mail_smtpport" => 25,
@ -255,8 +234,6 @@ be able to send email out of the box.
::
<?php
"mail_smtpmode" => "qmail",
"mail_smtphost" => "127.0.0.1",
"mail_smtpport" => 25,
@ -279,12 +256,10 @@ Troubleshooting
---------------
If you are unable to send email, try turning on debugging. Do this by enabling
the ``mail_smtpdebug parameter`` in ``config/config.php``.
the ``mail_smtpdebug`` parameter in ``config/config.php``.
::
<?php
"mail_smtpdebug" => true;
.. note:: Immediately after pressing the **Send email** button, as described
@ -294,14 +269,12 @@ the ``mail_smtpdebug parameter`` in ``config/config.php``.
**Question**: Why is my web domain different from my mail domain?
**Answer**: The default domain name used for the sender address is the hostname
where your Nextcloud installation is served. If you have a different mail domain
where your Nextcloud installation is served. If you have a different mail domain
name you can override this behavior by setting the following configuration
parameter:
::
<?php
"mail_domain" => "example.com",
This setting results in every email sent by Nextcloud (for example, the password
@ -397,12 +370,10 @@ Enabling debug mode
-------------------
If you are unable to send email, it might be useful to activate further debug
messages by enabling the mail_smtpdebug parameter:
messages by enabling the ``mail_smtpdebug`` parameter:
::
<?php
"mail_smtpdebug" => true,
.. note:: Immediately after pressing the **Send email** button, as described