275700 - FAQ update: "Disabling mail for testing" is incomplete

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Shane H. W. Travis]

I changed the answer to this question as part of the FAQ overhaul (bug 267873). 
Turns out that both the original answer and the replacement were partially 
correct, and neither gave the complete answer. Actual text should read 
something like this:

If you want to disable it completely, set the '$enableSendMail' value to '0' in 
BugMail.pm (2.18 and later) or processmail (up to 2.16.x).

If you want to see what would go out without actually sending it to people, 
edit the "newchangedmail" parameter as follows: replace "To:" with "X-Real-
To:", replace "Cc:" with "X-Real-CC:", and add a "To: <youremailaddress>".

NOTE: both of these changes will only affect bugmail. Email related to password 
changes, email address changes, bug imports, and flag changes will still be 
sent out. (Disabling *all* mail will happen when bug 59351 is fixed.)

Comment 1

[Shane H. W. Travis]

Attachment: Doc changes for 2.18 and tip

In addition to listed text changes, also fixes two bugs in the FAQ that I found
while looking it over (one missed space, one overly-ambitions search and
replace).

Comment 2

[Vlad Dascalu]

Comment on attachment 169890 [details] [diff] [review]
Doc changes for 2.18 and tip

+		 Rdd a <quote>To: %lt;your_email_address&gt;</quote>

Rdd --> Add

+	     To disable it completely,

Well you're saying below that it's not completely until bug xxx is resolved, so
I'd leave 'completely' out or something like that.

+	     If you want to see what would go out without actually sending it
to

For a newbie, I think it would be confusing if he would have to leave
$enableSendMail to 0 or to 1 while doing this. Maybe it's worthy to add
something in the lines of "leave the $... to 1 and also do this:" but in nice
words :-)

It seems like we're describing in docs a hack in order to get the results of a
feature, without having the said feature implemented. We instead should code
something that actually lets the admin redirect all the mail to his email for
testing. If we don't have this, the solution isn't to tell it to the users how
to hack their install in order to get what they want :-)

Anyway, those are nits. Let me know if you want to upload a new patch with them
fixed, or should I try to fix them on check in, or you want to check in this
without fixing the nits :-)

Comment 3

[Shane H. W. Travis]

I still can't check things in yet until Marcia processes my application, 
otherwise I *would* fix it myself on checkin. Making a new patch is possible, 
but if you're willing to change things on checkin here are changes to suit:

+            To disable it completely, set the
becomes:
+            To disable bugmail, set the

and
+            If you want to see what would go out without actually sending it to
+            people, edit the <quote>newchangedmail</quote> parameter as 
follows:

becomes:
+            To see what would go out without it actually being sent, leave 
+            $enableSendMail alone and edit the <quote>newchangedmail</quote>
+            parameter as follows:

If it hasn't been checked in with these changes by the time I get access to the 
original patch again, I'll upload another one.

Thanks!

Comment 4

[Shane H. W. Travis]

Attachment: Doc changes for 2.18 and tip, try #2

bug 59351 has landed, so I re-wrote that section and made it more clear which
mod affected what. Also fixed nits mentioned by Vladd.

Comment 5

[Shane H. W. Travis]

Checking in faq.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/faq.xml,v  <--  faq.xml
new revision: 1.27.2.3; previous revision: 1.27.2.2
done

Checking in faq.xml;
/cvsroot/mozilla/webtools/bugzilla/docs/xml/faq.xml,v  <--  faq.xml
new revision: 1.30; previous revision: 1.29
done