File: dmarcts-report-parser.8

package info (click to toggle)
dmarcts-report-parser 1.0%2Bgit20220721.51ba1de-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 268 kB
  • sloc: perl: 2,542; makefile: 8
file content (56 lines) | stat: -rw-r--r-- 1,653 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
.TH DMARCTS-REPORT-PARSER "8" "February 2020" "dmarcts-report-parser" "DMARC Report Parser"
.SH NAME
dmarcts-report-parser \- DMARC Report Parser
.SH SYNOPSIS
\fBdmarcts\-report\-parser\fR \fI[OPTIONS]\fR \fI[PATH]\fR
.SH DESCRIPTION

This script can be used to parse .xml files in DMARC reports sent by
email providers and store the parsed information in an SQL database.
.PP
The .xml files are expected to be attachments of emails which the
script can obtain from local folders, mbox files or IMAP account folders.
.PP
This script needs a configuration file called
\fIdmarcts\-report\-parser.conf\fR in the /etc/ (or in the current working
directory), which defines a database server with credentials and (if
used) an IMAP server with credentials.
.IP
.SH OPTIONS
Additionally, one of the following command line options must be provided:
.PP
.TP 8
\fB\-i\fR
Read reports from messages on IMAP server as defined in the
config file.
.TP 8
\fB\-m\fR
Read reports from mbox file(s) provided in PATH.
.TP 8
\fB\-e\fR
Read reports from MIME email file(s) provided in PATH.
.TP 8
\fB\-x\fR
Read reports from xml file(s) provided in PATH.
.PP
The following optional options are allowed:
.TP 8
\fB\-d\fR
Print debug info.
.TP 8
\fB\-r\fR
Replace existing reports rather than skipping them.
.TP 8
\fB\-\-delete\fR
Delete processed message files (the XML is stored in the
database for later reference).
.TP 8
\fB\-\-info\fR
Print out number of XML files or emails processed.
.PP
.SH "SEE ALSO"
dmarcts-report-viewer
.SH AUTHOR
This man page has been written by Mike Gabriel
<mike.gabriel@das-netzwerkteam.de> for the Debian project and it may be
used by others.