Document how OwnerEmail is used5.0/document-owneremail-use

Add detail on how OwnerEmail is used so that someone configuring RT will
have a better idea of how to set that option.

1 files changed, 37 insertions, 3 deletions

diff --git a/etc/RT_Config.pm.in b/etc/RT_Config.pm.in
index b0b0c5cc65..962d806104 100644
--- a/etc/RT_Config.pm.in
+++ b/etc/RT_Config.pm.in
@@ -388,9 +388,43 @@ setting enabled.
 =item C<$OwnerEmail>
 
 C<$OwnerEmail> is the address of a human who manages RT. RT will send
-errors generated by the mail gateway to this address. Because RT
-sends errors to this address, it should I<not> be an address that's
-managed by your RT instance, to avoid mail loops.
+several classes of errors to this address. To avoid mail loops,
+this option should I<not> be set to an address that's managed by your
+RT instance.
+
+The default is to send email to C<root> on the server where RT is
+running. If your system is not set up to forward root email to a
+real email address, you should set this to RT's admin. If you don't
+want to send any email, you can set this to C<undef>. This will
+prevent the local root account from gathering email that no one is
+looking at.
+
+Examples of errors sent to this address are:
+
+=over 4
+
+=item Insufficient Permissions
+
+When someone tries to create or update a ticket using email and
+lacks the necessary rights.
+
+=item Email Decryption and Encryption Errors
+
+When there is a failure in decoding or decrypting incoming
+email, or encrypting outgoing email. These will alert you
+to a configuration issue with one or more addresses.
+
+=item Mail Loops
+
+If C<$LoopsToRTOwner> is set, then whenever RT detects a mail loop.
+
+=item Dashboard Mailer Responses
+
+If L</$DashboardAddress> isn't set then C<$OwnerEMail> will be used
+as the From address for dashboard emails. Responses to these
+emails will then go to C<$OwnerEmail>.
+
+=back
 
 =cut