Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/filipnet/postfix-bounce-report

Creates an HTML report of blocked e-mail messages from Postfix
https://github.com/filipnet/postfix-bounce-report

bash blacklist ddns-blacklist email html html-report linux mailserver perl postfix postscreen recipients reject submission

Last synced: 18 days ago
JSON representation

Creates an HTML report of blocked e-mail messages from Postfix

Awesome Lists containing this project

README 

        
# postfix-bounce-report

The script generates an HTML report based on rejected messages. Another script continuously writes "recipient addresses" into a list. If an incoming message is rejected and is present in the list of "recipients", the subject of email is changing.



- [postfix-bounce-report](#postfix-bounce-report)

    - [FEATURES](#features)

    - [EXAMPLE](#example)

    - [HOW TO INSTALL](#how-to-install)

        - [PREREQUISITES PERL INTERPRETER AND XML EXTENSION](#prerequisites-perl-interpreter-and-xml-extension)

        - [CLONE REPOSITORY](#clone-repository)

    - [HOW TO USE](#how-to-use)

        - [CONFIGURATION](#configuration)

        - [CREATE SCHEDULED TASKS](#create-scheduled-tasks)

    - [ADDITIONAL INFORMATION](#additional-information)

    - [LICENSE](#license)



## FEATURES

- build_submission_recipients.sh	: Analyzes the postfix maillog for outgoing e-mails and continuously creates a list of recipients

- postfix-bounce-report.sh		: Analyzes the postfix logfile for bounced emails by DDNS blacklist, optionaly validate/cross check FROM-value against submission list. Script also generates HTML report and send via sendmail

- The subject is regular "[INFO] Postfix Bounce Report", a threshold value can be parameterized where the subject is changed to [WARNING]. For a match with the submission recipients list a [CRITIAL] is created

- Since a spoofed e-mail address would lead to a CRITICAL, the definition of toplevel domains has been implemented in version 1.1.2. Spoofed addresses are thus recognized and marked accordingly in the HTML report.



## EXAMPLE

Postfix Bounce Report HTML Example



## HOW TO INSTALL



### PREREQUISITES PERL INTERPRETER AND XML EXTENSION



Install XML library to read the XML files

- Once System is fully updated, you can install libxml2-utils package through command:

 - RedHat-based: ```dnf install perl libxml2-utils```

 - Debian-based: ```apt install perl libxml2-utils```



Check Perl Version

- Since the package is installed now, you can check the Perl version through ```perl -v``` command.



### CLONE REPOSITORY

Change to the root-directory of your linux-system: ```cd ~```



Clone the repository to this directory: ```git clone https://github.com/filipnet/postfix-bounce-report.git```

Afterwards you will find a new folder called "postfix-bounce-report" inside your root-directory

To make the scripts universally applicable, some settings like email addresses are stored in a separate ```config.xml``` and must be adjusted here, the existing ```config.xml.sample``` renamed and adjusted before.

Please note that the scripts must be made executable before the first use. ```chmod +x ~/*.sh```



## HOW TO USE



### CONFIGURATION

Rename the file ```config.xml.sample``` to ```config.xml``` and adapt it to your system environment.

```

cd ~/postfix-bounce-report

cp config.xml.sample config.xml

vim/nano config.xml

```



### CREATE SCHEDULED TASKS



Create a new file in  ```/etc/cron.d/``` directory:



``` touch /etc/cron.d/postfix-bounce-report ```



The content should be:



```

# https://github.com/filipnet/postfix-bounce-report

# Hourly script that collects the recipients for the report

@hourly root /root/postfix-bounce-report/postfix-build-submission-recipients.sh > /dev/null

# Daily script that sens out the report as an e-mail

@daily root /root/postfix-bounce-report/postfix-bounce-report.sh > /dev/null

```



Description

- The script ```postfix-build-submission-recipients.sh``` scans the mail log every hour for sent e-mails, extracts the recipient's address and adds it to the list ```/etc/postfix/submission_recipients``` if not already present.

- The script ```postfix-bounce-report.sh``` is executed once a day, returns as content an HTML table with cross-check to the submission list, sends it via e-mail.



## ADDITIONAL INFORMATION

Please note that the script ```postfix-bounce-report.sh``` always generates the day before. Note if there are no conflict with your log-rotation jobs.



## LICENSE

postfix-bounce-report and all individual scripts are under the BSD 3-Clause license unless explicitly noted otherwise. Please refer to the LICENSE