Skip to content

Improve Readme #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rklec wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Improve Readme #18

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c67fc6f
Use eml for syntax highlighting
rklec Sep 24, 2024
99e8c9f
Link to Nuget package in Readme
rklec Sep 24, 2024
2a24c50
Add badge for published Nuget version
rklec Sep 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# MailBounceDetector

[![Build status](https://github.com/rgl/mailbouncedetector/workflows/Build/badge.svg)](https://github.com/rgl/mailbouncedetector/actions?query=workflow%3ABuild)
[![NuGet Version](https://img.shields.io/nuget/v/MailBounceDetector)](https://www.nuget.org/packages/MailBounceDetector)

this library detects whether a message is a [bounce message](https://en.wikipedia.org/wiki/Bounce_message).

this detects [standard](#standard-bounce-messages) and [qmail](#qmail-bounce-messages) bounce messages.

see the [unit tests](MailBounceDetector.Tests/BounceDetectorTests.cs) for an example on how that information is exposed by the library.

It is published o Nuget.org as [`MailBounceDetector`](https://www.nuget.org/packages/MailBounceDetector).

## Standard bounce messages

a bounce message is one that has (or is) a `multipart/report; report-type=delivery-status` MIME part. its comprised of two or three sub-parts:
Expand All @@ -18,7 +21,7 @@ a bounce message is one that has (or is) a `multipart/report; report-type=delive

the most important part is the `message/delivery-status` part; it looks something like:

```plain
```eml
Content-Type: message/delivery-status

Reporting-MTA: dns; PTPEDGE02.test.local
Expand All @@ -45,7 +48,7 @@ the recipient's email address for typos or 550-5.1.1 unnecessary spaces.

a bounce message is one that is a `text/plain` (which can also be inside a `multipart/alternative`) MIME part, e.g.:

```plain
```eml
Date: 17 Mar 1996 03:54:40 -0000
From: MAILER-DAEMON@silverton.berkeley.edu
To: djb@silverton.berkeley.edu
Expand Down