mirror of
https://we.phorge.it/source/phorge.git
synced 2025-03-09 19:04:48 +01:00
Briefly document mail stamps and remove obsolete header documentation
Summary: Fixes T10189. Ref T13053. We haven't sent these headers in a very long time. Briefly mention the new stamps header instead, although I expect to integrate stamp documentation into the UI in a more cohesive way in the future. Test Plan: Read documentation. Maniphest Tasks: T13053, T10189 Differential Revision: https://secure.phabricator.com/D19030
This commit is contained in:
parent
bae9f459ab
commit
6186f0aa91
2 changed files with 20 additions and 53 deletions
|
@ -829,7 +829,7 @@ final class PhabricatorMetaMTAMail
|
||||||
|
|
||||||
$stamps = $this->getMailStamps();
|
$stamps = $this->getMailStamps();
|
||||||
if ($stamps) {
|
if ($stamps) {
|
||||||
$headers[] = array('X-Phabricator-Stamps', implode(', ', $stamps));
|
$headers[] = array('X-Phabricator-Stamps', implode(' ', $stamps));
|
||||||
}
|
}
|
||||||
|
|
||||||
$raw_body = idx($params, 'body', '');
|
$raw_body = idx($params, 'body', '');
|
||||||
|
|
|
@ -3,7 +3,8 @@
|
||||||
|
|
||||||
How to effectively manage Phabricator email notifications.
|
How to effectively manage Phabricator email notifications.
|
||||||
|
|
||||||
= Overview =
|
Overview
|
||||||
|
========
|
||||||
|
|
||||||
Phabricator uses email as a major notification channel, but the amount of email
|
Phabricator uses email as a major notification channel, but the amount of email
|
||||||
it sends can seem overwhelming if you're working on an active team. This
|
it sends can seem overwhelming if you're working on an active team. This
|
||||||
|
@ -13,69 +14,35 @@ By far the best approach to managing mail is to **write mail rules** to
|
||||||
categorize mail. Essentially all modern mail clients allow you to quickly
|
categorize mail. Essentially all modern mail clients allow you to quickly
|
||||||
write sophisticated rules to route, categorize, or delete email.
|
write sophisticated rules to route, categorize, or delete email.
|
||||||
|
|
||||||
= Reducing Email =
|
Reducing Email
|
||||||
|
==============
|
||||||
|
|
||||||
You can reduce the amount of email you receive by turning off some types of
|
You can reduce the amount of email you receive by turning off some types of
|
||||||
email in {nav Settings > Email Preferences}. For example, you can turn off email
|
email in {nav Settings > Email Preferences}. For example, you can turn off email
|
||||||
produced by your own actions (like when you comment on a revision), and some
|
produced by your own actions (like when you comment on a revision), and some
|
||||||
types of less-important notifications about events.
|
types of less-important notifications about events.
|
||||||
|
|
||||||
= Mail Rules =
|
Mail Rules
|
||||||
|
==========
|
||||||
|
|
||||||
The best approach to managing mail is to write mail rules. Simply writing rules
|
The best approach to managing mail is to write mail rules. Simply writing rules
|
||||||
to move mail from Differential, Maniphest and Herald to separate folders will
|
to move mail from Differential, Maniphest and Herald to separate folders will
|
||||||
vastly simplify mail management.
|
vastly simplify mail management.
|
||||||
|
|
||||||
Phabricator also sets a large number of headers (see below) which can allow you
|
Phabricator also adds mail headers (see below) which can allow you to write
|
||||||
to write more sophisticated mail rules.
|
more sophisticated mail rules.
|
||||||
|
|
||||||
= Mail Headers =
|
Mail Headers
|
||||||
|
============
|
||||||
|
|
||||||
Phabricator sends a variety of mail headers that can be useful in crafting rules
|
Phabricator sends various information in mail headers that can be useful in
|
||||||
to route and manage mail.
|
crafting rules to route and manage mail. To see a full list of headers, use
|
||||||
|
the "View Raw Message" feature in your mail client.
|
||||||
|
|
||||||
Headers in plural contain lists. A list containing two items, `1` and
|
The most useful header for routing is generally `X-Phabricator-Stamps`. This
|
||||||
`15` will generally be formatted like this:
|
is a list of attributes which describe the object the mail is about and the
|
||||||
|
actions which the mail informs you about.
|
||||||
|
|
||||||
X-Header: <1>, <15>
|
If you use a client which can not perform header matching (like Gmail), you can
|
||||||
|
change the {nav Settings > Email Format > Send Stamps} setting to include the
|
||||||
The intent is to allow you to write a rule which matches against "<1>". If you
|
stamps in the mail body and then match them with body rules.
|
||||||
just match against "1", you'll incorrectly match "15", but matching "<1>" will
|
|
||||||
correctly match only "<1>".
|
|
||||||
|
|
||||||
Some other headers use a single value but can be presented multiple times.
|
|
||||||
It is to support e-mail clients which are not able to create rules using regular
|
|
||||||
expressions or wildcards (namely Outlook).
|
|
||||||
|
|
||||||
The headers Phabricator adds to mail are:
|
|
||||||
|
|
||||||
- `X-Phabricator-Sent-This-Message`: this is attached to all mail
|
|
||||||
Phabricator sends. You can use it to differentiate between email from
|
|
||||||
Phabricator and replies/forwards of Phabricator mail from human beings.
|
|
||||||
- `X-Phabricator-To`: this is attached to all mail Phabricator sends.
|
|
||||||
It shows the PHIDs of the original "To" line, before any mutation
|
|
||||||
by the mailer configuration.
|
|
||||||
- `X-Phabricator-Cc`: this is attached to all mail Phabricator sends.
|
|
||||||
It shows the PHIDs of the original "Cc" line, before any mutation by the
|
|
||||||
mailer configuration.
|
|
||||||
- `X-Differential-Author`: this is attached to Differential mail and shows
|
|
||||||
the revision's author. You can use it to filter mail about your revisions
|
|
||||||
(or other users' revisions).
|
|
||||||
- `X-Differential-Reviewer`: this is attached to Differential mail and
|
|
||||||
shows the reviewers. You can use it to filter mail about revisions you
|
|
||||||
are reviewing, versus revisions you are explicitly CC'd on or CC'd as
|
|
||||||
a result of Herald rules.
|
|
||||||
- `X-Differential-Reviewers`: list version of the previous.
|
|
||||||
- `X-Differential-CC`: this is attached to Differential mail and shows
|
|
||||||
the CCs on the revision.
|
|
||||||
- `X-Differential-CCs`: list version of the previous.
|
|
||||||
- `X-Differential-Explicit-CC`: this is attached to Differential mail and
|
|
||||||
shows the explicit CCs on the revision (those that were added by humans,
|
|
||||||
not by Herald).
|
|
||||||
- `X-Differential-Explicit-CCs`: list version of the previous.
|
|
||||||
- `X-Phabricator-Mail-Tags`: this is attached to some mail and has
|
|
||||||
a list of descriptors about the mail. (This is fairly new and subject
|
|
||||||
to some change.)
|
|
||||||
- `X-Herald-Rules`: this is attached to some mail and shows Herald rule
|
|
||||||
IDs which have triggered for the object. You can use this to sort or
|
|
||||||
categorize mail that has triggered specific rules.
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue