Skip to content

Commit

Permalink
Fix(email_configuration): Fix conflicting debug mode sections
Browse files Browse the repository at this point in the history
`mail_smtpdebug` was being described in two places, one of which was incomplete (it didn't note the requirement to also change `loglevel` to `0`... leading to confusion).

* Removes the inaccurate spot and moves the accurate one into its place so there are no longer two debug logging sections.

Signed-off-by: Josh <[email protected]>
  • Loading branch information
joshtrichards authored Jan 19, 2024
1 parent 8cb3a5d commit c54e92f
Showing 1 changed file with 15 additions and 22 deletions.
37 changes: 15 additions & 22 deletions admin_manual/configuration_server/email_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -259,12 +259,24 @@ of the Admin settings page.
Troubleshooting
---------------

If you are unable to send email, try turning on debugging. Do this by enabling
the ``mail_smtpdebug`` parameter in ``config/config.php``.
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 and temporarily setting your NC loglevel to DEBUG:

::

"mail_smtpdebug" => true,
"loglevel" => 0,

Be cautious setting your ``loglevel`` to DEBUG (``0``) since it'll apply to everything occurring on your NC instance, not just email.
And don't forget to set it back to a more reasonable level when you're done troubleshooting:

::

"mail_smtpdebug" => true;
"mail_smtpdebug" => false,
"loglevel" => 2,

.. note:: Immediately after pressing the **Send email** button, as described
before, several **SMTP -> get_lines(): ...** messages appear on the screen.
Expand Down Expand Up @@ -396,25 +408,6 @@ All emails keep getting rejected even though only one email address is invalid.

Partial sending, i. e. sending to all but the faulty email address is not possible.

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 and temporarily setting your NC loglevel to DEBUG:

::

"mail_smtpdebug" => true,
"loglevel" => 0,

Be cautious setting your ``loglevel`` to DEBUG (``0``) since it'll apply to everything occurring on your NC instance, not just email.
And don't forget to set it back to a more reasonable level when you're done troubleshooting:

::

"mail_smtpdebug" => false,
"loglevel" => 2,

.. note:: Immediately after pressing the **Send email** button, as described
before, several **SMTP -> get_lines(): ...** messages appear on the screen.
This is expected behavior and can be ignored.

0 comments on commit c54e92f

Please sign in to comment.