From 7edc84aa20fab9e3da77aa425fbb674a5da576b5 Mon Sep 17 00:00:00 2001 From: epriestley Date: Wed, 10 Jul 2013 18:52:42 -0700 Subject: [PATCH] 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 --- .../configuring_inbound_email.diviner | 20 +++++++++++------- .../configuring_outbound_email.diviner | 21 +++++++++---------- 2 files changed, 23 insertions(+), 18 deletions(-) diff --git a/src/docs/configuration/configuring_inbound_email.diviner b/src/docs/configuration/configuring_inbound_email.diviner index 9caed4f899..a81bf03c96 100644 --- a/src/docs/configuration/configuring_inbound_email.diviner +++ b/src/docs/configuration/configuring_inbound_email.diviner @@ -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 ` 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 diff --git a/src/docs/configuration/configuring_outbound_email.diviner b/src/docs/configuration/configuring_outbound_email.diviner index c93b54b011..56a08eb006 100644 --- a/src/docs/configuration/configuring_outbound_email.diviner +++ b/src/docs/configuration/configuring_outbound_email.diviner @@ -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 ` for more help on using these commands. You can monitor daemons using the Daemon Console (##/daemon/##, or click **Daemon Console** from the homepage).