revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2025-01-04 20:01:00 +01:00
Code Issues Releases Wiki Activity

Update mail documentation to point at the CLI tools

Browse source 
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:
epriestley 2013-07-10 18:52:42 -07:00
parent 544a84ebb9
commit 7edc84aa20
2 changed files with 23 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
src/docs/configuration/configuring_inbound_email.diviner
View file

@ -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 or you are willing to require all users to sign their email), file a feature
request. request.
= Testing = = Testing and Debugging Inbound Email =
You can view a log of received mail by going to MetaMTA -> Received in the You can use the `bin/mail` utility to test and review inbound mail. This can
Phabricator web interface. This can help you determine if mail is being help you determine if mail is being delivered to Phabricator or not:
delivered to Phabricator or not.
You can also use the "Test Receiver" button, but note that this just simulates phabricator/ $ ./bin/mail list-inbound # List inbound messages.
receiving mail and doesn't send any information over the network. It is 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 primarily aimed at developing email handlers: it will still work properly
if your inbound email configuration is incorrect or even disabled. 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 = = SendGrid =
To use SendGrid, you need a SendGrid account with access to the "Parse API" for 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: 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 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 script. Run ##sudo /etc/mail/make## or similar and then restart sendmail with

19
src/docs/configuration/configuring_outbound_email.diviner
View file

@ -80,9 +80,9 @@ do any of this, consider using Amazon SES.
For most situations of using SMTP to send email, you could actually use 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 '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 and the 'sendmail' mailer doesn't work. If you want to try with postfix, for
instructions, consult the documentation for postfix as MTA and you could configure install instructions, consult the documentation for postfix as MTA and you
to use SMTP then. could configure to use SMTP then.
To configure Phabricator to use SMTP, set these configuration keys: 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 = = Testing and Debugging Outbound Email =
Phabricator has a mail log and test console at ##/mail/##, or click the You can use the `bin/mail` utility to test, debug, and examine outbound mail. In
**MetaMTA** link from the homepage. This console shows all the mail Phabricator particular:
has attempted to deliver, plus debugging and error information.
You can use the "Send New Message" button to send mail using the current phabricator/ $ ./bin/mail list-outbound # List outbound mail.
configuration. This can help test that your setup is correct. 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 Run `bin/mail help <command>` for more help on using these commands.
arbitrary email addresses.
You can monitor daemons using the Daemon Console (##/daemon/##, or click You can monitor daemons using the Daemon Console (##/daemon/##, or click
**Daemon Console** from the homepage). **Daemon Console** from the homepage).