mirror of
https://we.phorge.it/source/phorge.git
synced 2024-12-30 09:20:58 +01:00
Update mail documentation to point at the CLI tools
Summary: Tell users to use the CLI, not the web UI. Test Plan: Read the docs. Reviewers: btrahan Reviewed By: btrahan CC: aran Differential Revision: https://secure.phabricator.com/D6424
This commit is contained in:
parent
544a84ebb9
commit
7edc84aa20
2 changed files with 23 additions and 18 deletions
|
@ -99,17 +99,23 @@ signatures are sufficient to authenticate the sender under your configuration,
|
|||
or you are willing to require all users to sign their email), file a feature
|
||||
request.
|
||||
|
||||
= Testing =
|
||||
= Testing and Debugging Inbound Email =
|
||||
|
||||
You can view a log of received mail by going to MetaMTA -> Received in the
|
||||
Phabricator web interface. This can help you determine if mail is being
|
||||
delivered to Phabricator or not.
|
||||
You can use the `bin/mail` utility to test and review inbound mail. This can
|
||||
help you determine if mail is being delivered to Phabricator or not:
|
||||
|
||||
You can also use the "Test Receiver" button, but note that this just simulates
|
||||
receiving mail and doesn't send any information over the network. It is
|
||||
phabricator/ $ ./bin/mail list-inbound # List inbound messages.
|
||||
phabricator/ $ ./bin-mail show-inbound # Show details about a message.
|
||||
|
||||
You can also test receiving mail, but note that this just simulates receiving
|
||||
the mail and doesn't send any information over the network. It is
|
||||
primarily aimed at developing email handlers: it will still work properly
|
||||
if your inbound email configuration is incorrect or even disabled.
|
||||
|
||||
phabricator/ $ ./bin/mail receive-test # Receive test message.
|
||||
|
||||
Run `bin/mail help <command>` for detailed help on using these commands.
|
||||
|
||||
= SendGrid =
|
||||
|
||||
To use SendGrid, you need a SendGrid account with access to the "Parse API" for
|
||||
|
@ -187,7 +193,7 @@ Now, you can actually configure sendmail to deliver to Phabricator. In
|
|||
|
||||
Finally, edit ##/etc/mail/virtusertable## and add an entry like this:
|
||||
|
||||
@yourdomain.com phabricator@localhost
|
||||
@yourdomain.com phabricator@localhost
|
||||
|
||||
That will forward all mail to @yourdomain.com to the Phabricator processing
|
||||
script. Run ##sudo /etc/mail/make## or similar and then restart sendmail with
|
||||
|
|
|
@ -79,10 +79,10 @@ do any of this, consider using Amazon SES.
|
|||
= Adapter: SMTP =
|
||||
|
||||
For most situations of using SMTP to send email, you could actually use
|
||||
'sendmail' or 'postfix' to do it. But some SMTP server requires authentication
|
||||
and the 'sendmail' mailer doesn't work. If you want to try with postfix, for install
|
||||
instructions, consult the documentation for postfix as MTA and you could configure
|
||||
to use SMTP then.
|
||||
'sendmail' or 'postfix' to do it. But some SMTP server requires authentication
|
||||
and the 'sendmail' mailer doesn't work. If you want to try with postfix, for
|
||||
install instructions, consult the documentation for postfix as MTA and you
|
||||
could configure to use SMTP then.
|
||||
|
||||
To configure Phabricator to use SMTP, set these configuration keys:
|
||||
|
||||
|
@ -165,15 +165,14 @@ For more information on using daemons, see @{article:Managing Daemons with phd}.
|
|||
|
||||
= Testing and Debugging Outbound Email =
|
||||
|
||||
Phabricator has a mail log and test console at ##/mail/##, or click the
|
||||
**MetaMTA** link from the homepage. This console shows all the mail Phabricator
|
||||
has attempted to deliver, plus debugging and error information.
|
||||
You can use the `bin/mail` utility to test, debug, and examine outbound mail. In
|
||||
particular:
|
||||
|
||||
You can use the "Send New Message" button to send mail using the current
|
||||
configuration. This can help test that your setup is correct.
|
||||
phabricator/ $ ./bin/mail list-outbound # List outbound mail.
|
||||
phabricator/ $ ./bin/mail show-outbound # Show details about messages.
|
||||
phabricator/ $ ./bin/mail send-test # Send test messages.
|
||||
|
||||
NOTE: when you send mail, "to" and "cc" must be valid users of the system, not
|
||||
arbitrary email addresses.
|
||||
Run `bin/mail help <command>` for more help on using these commands.
|
||||
|
||||
You can monitor daemons using the Daemon Console (##/daemon/##, or click
|
||||
**Daemon Console** from the homepage).
|
||||
|
|
Loading…
Reference in a new issue