pmg-administration.adoc: descrive delivery status

[pmg-docs.git] / pmg-administration.adoc

diff --git a/pmg-administration.adoc b/pmg-administration.adoc
index 741f004b61fda597aed4a208888c181022cb97bb..ed4ea1e7d450be6ece35dab055d99c8ec3ab68f4 100644 (file)
--- a/pmg-administration.adoc
+++ b/pmg-administration.adoc
@@ -87,7 +87,63 @@ TODO
 Tracking Center
 ---------------
 
-TODO
+image::images/screenshot/pmg-gui-tracking-center.png[]
+
+Email processing is a complex task and involves several service
+daemons. Each daemon logs information to the syslog service. The
+problem is that a servers analyzes many emails in parallel, so it is
+usually very hard to find all logs corresponding to a specific mail.
+
+Introduced in {pmg} 2.1, the tracking center simplifies the search for
+emails dramatically. We use highly optimized C-code to search the
+available syslog data. This is very fast and powerful, and works for
+sites processing several million emails per day.
+
+The result is a list of received mails, including the following data:
+
+[cols="s,5d"]
+|====
+|Time | Timestamp of first found syslog entry.
+|From | Envelope 'From' address (the sender).
+|To   | The email receiver address.
+|Status | Delivery status.
+|Syslog | The corresponding syslog entries are shown if you double click such
+entry, or if you press the '+' button on the left.
+|====
+
+Please notice that you can specify filters, most important you can set
+a 'Start' and 'End' time. By default the start time is set to one hour
+ago. If you still get to much result entries, you can try to restrict
+the search to specific sender or receiver addresses, or search for a
+specific text in the logs ('Filter' entry).
+
+NOTE: Search is faster if you use a short time interval.
+
+The 'Status' field summarize what happens with an email. {pmg} is a
+mail proxy, meaning that the proxy receives mails from outside,
+process it and finally sends the result to the receiver.
+
+The first phase is receiving the mail. The proxy may reject the mail
+early, or instead accepts the mail and feeds it into the filter. The filter
+rules can block or accept the mail.
+
+In the second phase, accepted mails need to be delivered to the
+receiver, and this action may also fail or succeed. The status
+combines the result from the first and second phase:
+
+[options="header",cols="2s,1d,5d"]
+|====
+|Status |Phase |Description
+|rejected             |1 | Email rejected (e.g. sender IP is listed on a IP blacklist)
+|greylisted           |1 | Email temporarily rejected by greylisting
+|queued/deferred      |1 | Internal Email was queued, still trying to deliver
+|queued/bounced       |1 | Internal Email was queued but not accepted by the target email server (e. g. user unknown)
+|quarantine           |1 | Email was moved to quanantine
+|blocked              |1 | Email was blocked by filter rules
+|accepted/deferred    |2 | Email accepted, still trying to deliver
+|accepted/bounced     |2 | Email accepted but not accepted by the target email server (e. g. user unknown)
+|accepted/delivered   |2 | Email accepted and deliverd
+|====
 
 
 Postfix Queue Administration