Package Exports
- @mailprotector/haraka-plugin-rcpt-http
- @mailprotector/haraka-plugin-rcpt-http/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@mailprotector/haraka-plugin-rcpt-http) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
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 --saveSetup
Enable Plugin
Add to plugin file in the haraka config folder
@mailprotector/haraka-plugin-rcpt-httpConfig
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
}