Skip to content
This repository has been archived by the owner on Aug 5, 2022. It is now read-only.

A Haraka plugin for validating recipient addresses against an HTTP endpoint.

License

Notifications You must be signed in to change notification settings

mailprotector/haraka-plugin-rcpt-http

Repository files navigation

haraka-plugin-rcpt-http

A Haraka plugin for validating recipient addresses against an HTTP endpoint.

Install

Install with npm

npm install @mailprotector/haraka-plugin-rcpt-http --save

Setup

Enable Plugin

Add to plugin file in the haraka config folder

@mailprotector/haraka-plugin-rcpt-http

Config

Config options are set in rcpt_http.json:

Parameter Description Type Default Value
USERNAME HTTP server username string none
PASSWORD HTTP server password string none
RCPT_CHECK_URL The URL endpoint of the HTTP server string none

Details

The http API call uses a POST to RCPT_URL with basic auth if a USERNAME and PASSWORD are provided in config. Without the User/Pass will do an unauthenticated POST to RCPT_URL.

The following POST body will be sent to RCPT_URL

{
  email: params[0].original,
  ip: connection.remote.ip
}

alt text About Mailprotector

About

A Haraka plugin for validating recipient addresses against an HTTP endpoint.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •