@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Clarify "metamta.default-address" instructions and lock the option
Summary: This option no longer needs to be configured if you configure inbound mail (and that's the easiest setup approach in a lot of cases), so stop telling users they have to set it up.
Test Plan: Read documentation and configuration help.
Reviewers: amckinley
Reviewed By: amckinley
Differential Revision: https://secure.phabricator.com/D20104
+44
-10
+22
-1
src/applications/config/option/PhabricatorMetaMTAConfigOptions.php
+22
-1
src/applications/config/option/PhabricatorMetaMTAConfigOptions.php
···
187
187
PhabricatorEnv::getDoclink('Configuring Outbound Email'),
188
188
pht('Configuring Outbound Email')));
189
189
190
+
$default_description = $this->deformat(pht(<<<EODOC
191
+
Default address used as a "From" or "To" email address when an address is
192
+
required but no meaningful address is available.
193
+
194
+
If you configure inbound mail, you generally do not need to set this:
195
+
Phabricator will automatically generate and use a suitable mailbox on the
196
+
inbound mail domain.
197
+
198
+
Otherwise, this option should be configured to point at a valid mailbox which
199
+
discards all mail sent to it. If you point it at an invalid mailbox, mail sent
200
+
by Phabricator and some mail sent by users will bounce. If you point it at a
201
+
real user mailbox, that user will get a lot of mail they don't want.
202
+
203
+
For further guidance, see **[[ %s | %s ]]** in the documentation.
204
+
EODOC
205
+
,
206
+
PhabricatorEnv::getDoclink('Configuring Outbound Email'),
207
+
pht('Configuring Outbound Email')));
208
+
190
209
return array(
191
210
$this->newOption('cluster.mailers', 'cluster.mailers', array())
192
211
->setHidden(true)
193
212
->setDescription($mailers_description),
194
213
$this->newOption('metamta.default-address', 'string', null)
195
-
->setDescription(pht('Default "From" address.')),
214
+
->setLocked(true)
215
+
->setSummary(pht('Default address used when generating mail.'))
216
+
->setDescription($default_description),
196
217
$this->newOption(
197
218
'metamta.one-mail-per-recipient',
198
219
'bool',
+22
-9
src/docs/user/configuration/configuring_outbound_email.diviner
+22
-9
src/docs/user/configuration/configuring_outbound_email.diviner
···
47
47
@{article:Managing Daemons with phd}.
48
48
49
49
50
-
Basics
51
-
======
50
+
Outbound "From" and "To" Addresses
51
+
==================================
52
52
53
-
Before configuring outbound mail, you should first set up
54
-
`metamta.default-address` in Configuration. This determines where mail is sent
55
-
"From" by default.
53
+
When Phabricator sends outbound mail, it must select some "From" address to
54
+
send mail from, since mailers require this.
55
+
56
+
When mail only has "CC" recipients, Phabricator generates a dummy "To" address,
57
+
since some mailers require this and some users write mail rules that depend
58
+
on whether they appear in the "To" or "CC" line.
59
+
60
+
In both cases, the address should ideally correspond to a valid, deliverable
61
+
mailbox that accepts the mail and then simply discards it. If the address is
62
+
not valid, some outbound mail will bounce, and users will receive bounces when
63
+
they "Reply All" even if the other recipients for the message are valid. In
64
+
contrast, if the address is a real user address, that user will receive a lot
65
+
of mail they probably don't want.
56
66
57
-
If your domain is `example.org`, set this to something
58
-
like `noreply@example.org`.
67
+
If you plan to configure //inbound// mail later, you usually don't need to do
68
+
anything. Phabricator will automatically create a `noreply@` mailbox which
69
+
works the right way (accepts and discards all mail it receives) and
70
+
automatically use it when generating addresses.
59
71
60
-
Ideally, this should be a valid, deliverable address that doesn't bounce if
61
-
users accidentally send mail to it.
72
+
If you don't plan to configure inbound mail, you may need to configure an
73
+
address for Phabricator to use. You can do this by setting
74
+
`metamta.default-address`.
62
75
63
76
64
77
Configuring Mailers