-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
39 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,22 +35,25 @@ docker run --rm --interactive --tty \ | |
|
||
## API | ||
|
||
### POST|GET /api/v1/bounces/hard?email=[email protected] | ||
> Record email as hard bounce - block for 8^7 minutes | ||
### POST|GET /api/v1/bounces/complaint?email=[email protected] | ||
> Record email as soft bounce - block similar to soft bounce | ||
### POST|GET /api/v1/bounces/soft?email=[email protected] | ||
> Record email as soft bounce - block exponentially in multiple of 8^n minutes | ||
Complaint is in between a soft bounce and a hard bounce. It could be because the emailing System scan attachment and detect as a virus, or an actual User complaint with their email Provider. | ||
|
||
1. First soft bounce, block for 8 minutes | ||
2. Second soft bounce within 8 minutes, block for 64 minutes | ||
3. Third soft bounce within 64 minutes, block for 512 minutes | ||
4. Forth soft bounce within 512 minutes, block for 4096 minutes ~ 3 days | ||
5. And so on... | ||
### POST|GET /api/v1/bounces/hard?email=[email protected] | ||
> Record email as hard bounce - block for 1 year | ||
### POST|GET /api/v1/bounces/complaint?email=a-valid@email.com | ||
> Record email as soft bounce - block exponentially for 8^3 minutes | ||
### POST|GET /api/v1/bounces/remove?emails=a-invalid@email.com,[email protected],[email protected] | ||
> Bulk remove emails from bounce | ||
Complaint is in between a soft bounce and a hard bounce. It could be because the emailing System scan attachment and detect as a virus, or an actual User complaint with their email Provider. | ||
### POST|GET /api/v1/bounces/soft?email=[email protected] | ||
> Record email as soft bounce - block incremental of 1 day | ||
1. First soft bounce, block for 1 day | ||
2. Second soft bounce within 1 day, block for 2 days | ||
3. Third soft bounce within 2 day, block for 3 days | ||
4. Forth soft bounce within 3 day, block for 4 days | ||
5. And so on... up to 365 days max | ||
|
||
### GET /api/v1/bounces/stat?email=[email protected] | ||
> Determine if email is sendable | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters