Skip to content

Commit

Permalink
Release v1.2.2 (#18)
Browse files Browse the repository at this point in the history
* doc(CONTRIBUTORS): added
* doc: rename Changes -> CHANGELOG
* populate [files] in package.json.
* lint: remove duplicate / stale rules from .eslintrc
- dep(lint): eslint-plugin-haraka -> @haraka/eslint-config
* prettier
  • Loading branch information
msimerson authored Apr 23, 2024
1 parent cb4fe39 commit f7679f7
Show file tree
Hide file tree
Showing 14 changed files with 802 additions and 600 deletions.
8 changes: 4 additions & 4 deletions .codeclimate.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
engines:
eslint:
enabled: true
channel: "eslint-8"
channel: 'eslint-8'
config:
config: ".eslintrc.yaml"
config: '.eslintrc.yaml'

ratings:
paths:
- "**.js"
paths:
- '**.js'
20 changes: 4 additions & 16 deletions .eslintrc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,9 @@ env:
node: true
es6: true
mocha: true
es2020: true
es2022: true

plugins:
- haraka
extends: ['@haraka']

extends:
- eslint:recommended
- plugin:haraka/recommended

root: true

globals:
OK: true
CONT: true
DENY: true
DENYSOFT: true
DENYDISCONNECT: true
DENYSOFTDISCONNECT: true
rules:
no-unused-vars: 1
6 changes: 3 additions & 3 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
- package-ecosystem: 'npm'
directory: '/'
schedule:
interval: "weekly"
interval: 'weekly'
allow:
- dependency-type: production
33 changes: 7 additions & 26 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,41 +1,22 @@
name: CI

on: [ push ]
on: [push, pull_request]

env:
CI: true

jobs:

lint:
uses: haraka/.github/.github/workflows/lint.yml@master

# coverage:
# uses: haraka/.github/.github/workflows/coverage.yml@master
# secrets: inherit

test:
needs: [ lint, get-lts ]
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ ubuntu-latest, windows-latest ]
node-version: ${{ fromJson(needs.get-lts.outputs.active) }}
fail-fast: false
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
name: Node ${{ matrix.node-version }} on ${{ matrix.os }}
with:
node-version: ${{ matrix.node-version }}
- run: npm install
- run: npm test
ubuntu:
needs: [lint]
uses: haraka/.github/.github/workflows/ubuntu.yml@master

get-lts:
runs-on: ubuntu-latest
steps:
- id: get
uses: msimerson/node-lts-versions@v1
outputs:
active: ${{ steps.get.outputs.active }}
lts: ${{ steps.get.outputs.lts }}
windows:
needs: [lint]
uses: haraka/.github/.github/workflows/windows.yml@master
6 changes: 3 additions & 3 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: "CodeQL"
name: 'CodeQL'

on:
push:
branches: [ master ]
branches: [master]
pull_request:
branches: [ master ]
branches: [master]
schedule:
- cron: '18 7 * * 4'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ env:
jobs:
publish:
uses: haraka/.github/.github/workflows/publish.yml@master
secrets: inherit
secrets: inherit
2 changes: 2 additions & 0 deletions .prettierrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
singleQuote: true
semi: false
2 changes: 1 addition & 1 deletion .release
27 changes: 15 additions & 12 deletions Changes.md → CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/).

### Unreleased

### [1.2.2] - 2024-04-22

- populate [files] in package.json.
- dep: eslint-plugin-haraka -> @haraka/eslint-config
- lint: remove duplicate / stale rules from .eslintrc

### [1.2.1] - 2023-06-12

- fix: use arrow fn in load_qmd_ini callback


### [1.2.0] - 2023-06-12

- previously, would set next_hop=lmtp w/o setting q.wants=lmtp
Expand All @@ -17,13 +25,11 @@
- chore: replace url.parse with new url.URL()
- chore: added many tests


### [1.1.1] - 2022-11-29

- ci: only publish when package.json has changes
- feat: decrease a log message severity


## 1.1.0 - 2021-01-06

- ci: use shared GHA workflows
Expand All @@ -34,40 +40,37 @@
- lint: es6 interpolated strings
- drop node 8 & 10 testing, add 14


## 1.0.6 - 2018-12-20

- set txn.notes.local_recipient


## 1.0.5 - 2018-01-26

- assure transaction still exists before trying to access txn.notes


## 1.0.4 - 2018-01-20

- tighten up LMTP routing to only when explicitely set


## 1.0.3 - 2017-09-26

- use correct name of mail hook
- update loginfo to use get and avoid undef crash


## 1.0.2 - 2017-09-01

- adds ability to route email via notes.queue.wants and queue.next_hop
- when destination is a mailbox and next_hop is a LMTP url, routes via LMTP


## 1.0.1 - 2017-08-29

- initial release


[1.0.1]: https://github.com/haraka/haraka-plugin-qmail-deliverable/releases/tag/v1.0.1
[1.0.2]: https://github.com/haraka/haraka-plugin-qmail-deliverable/releases/tag/v1.0.2
[1.1.0]: https://github.com/haraka/haraka-plugin-qmail-deliverable/releases/tag/1.1.0
[1.1.1]: https://github.com/haraka/haraka-plugin-qmail-deliverable/releases/tag/1.1.1
[1.2.0]: https://github.com/haraka/haraka-plugin-qmail-deliverable/releases/tag/1.2.0
[1.2.1]: https://github.com/haraka/haraka-plugin-qmail-deliverable/releases/tag/1.2.1
[1.2.0]: https://github.com/haraka/haraka-plugin-qmail-deliverable/releases/tag/v1.2.0
[1.2.1]: https://github.com/haraka/haraka-plugin-qmail-deliverable/releases/tag/v1.2.1
[1.2.2]: https://github.com/haraka/haraka-plugin-qmail-deliverable/releases/tag/v1.2.2
[1.3.0]: https://github.com/haraka/haraka-plugin-qmail-deliverable/releases/tag/v1.3.0
8 changes: 8 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Contributors

This handcrafted artisinal software is brought to you by:

| <img height="80" src="https://avatars.githubusercontent.com/u/261635?v=4"><br><a href="https://github.com/msimerson">msimerson</a> (<a href="https://github.com/haraka/haraka-plugin-qmail-deliverable/commits?author=msimerson">23</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/1674289?v=4"><br><a href="https://github.com/Dexus">Dexus</a> (<a href="https://github.com/haraka/haraka-plugin-qmail-deliverable/commits?author=Dexus">1</a>) | <img height="80" src="https://avatars.githubusercontent.com/u/550490?v=4"><br><a href="https://github.com/smfreegard">smfreegard</a> (<a href="https://github.com/haraka/haraka-plugin-qmail-deliverable/commits?author=smfreegard">1</a>) |
| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |

<sub>this file is maintained by [.release](https://github.com/msimerson/.release)</sub>
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,21 @@ On incoming messages (relaying=false), validate the RCPT TO address.
The host and port that qmail-deliverabled is listening on can be set by
altering the contents of `config/qmail-deliverable.ini`

* `host` (Default: localhost)
- `host` (Default: localhost)

* `port` (Default: 8998)
- `port` (Default: 8998)

* `check_mail_from`= (Default: true)
- `check_mail_from`= (Default: true)

When `check_mail_from` is enabled, the MAIL FROM address is checked for deliverability. The deliverable status can be inspected by checking `transaction.notes.local_sender`. This information can be used later to determine mail handling.

### Fine control of MX routing

MX routing for individual domains can be set by defining `queue` and `next_hop`.

* `queue`: a queue plugin (smtp_forward, qmail-queue, lmtp), or lmtp. When `queue=lmtp`, if qmail-deliverable reports that the destination address is a mailbox (ie, not email list, forward, alias, etc.), then this plugin will configure the next_hop to be `lmtp://$host/` and will set up that route (via `get_mx()`) so that outbound delivers the message to the mailbox via LMTP.

* `next_hop`: a URL. Examples: `smtp://mx.example.com` and `lmtp://int.mx.example.com:24`. This plugin uses next_hop to direct messages to local mailboxes via LMTP. If the LMTP server (dovecot, in my case) is not the same host that is running qmail-deliverabled, set next_hop accordingly.
- `queue`: a queue plugin (smtp_forward, qmail-queue, lmtp), or lmtp. When `queue=lmtp`, if qmail-deliverable reports that the destination address is a mailbox (ie, not email list, forward, alias, etc.), then this plugin will configure the next_hop to be `lmtp://$host/` and will set up that route (via `get_mx()`) so that outbound delivers the message to the mailbox via LMTP.

- `next_hop`: a URL. Examples: `smtp://mx.example.com` and `lmtp://int.mx.example.com:24`. This plugin uses next_hop to direct messages to local mailboxes via LMTP. If the LMTP server (dovecot, in my case) is not the same host that is running qmail-deliverabled, set next_hop accordingly.

## Per-domain Configuration

Expand All @@ -37,12 +36,12 @@ needs to be declared. Example:

[example.com]
host=192.168.0.1

[example2.com]
host=192.168.0.2


<!-- leave these buried at the bottom of the document -->

[ci-img]: https://github.com/haraka/haraka-plugin-qmail-deliverable/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/haraka/haraka-plugin-qmail-deliverable/actions/workflows/ci.yml
[clim-img]: https://codeclimate.com/github/haraka/haraka-plugin-qmail-deliverable/badges/gpa.svg
Expand Down
Loading

0 comments on commit f7679f7

Please sign in to comment.