# rss-mailer

> RssMailer

Latest version **0.0.3** (published 2022-05-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install rss-mailer
pnpm add rss-mailer
yarn add rss-mailer
bun add rss-mailer
```

Provides the command `rssmailer`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2022-05-17 |
| First published | 2022-04-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 36.2 KB |
| Known vulnerabilities | 0 (+35 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 37 |
| Author | waynegong |
| Maintainers | waynegong |

## Links

- npm: https://www.npmjs.com/package/rss-mailer
- Repository: https://github.com/WayneGongCN/rss-mailer
- Issues: https://github.com/WayneGongCN/rss-mailer/issues
- npm.io page: https://npm.io/package/rss-mailer

## Dependencies (12)

- [ejs](https://npm.io/package/ejs.md) ^3.1.6
- [axios](https://npm.io/package/axios.md) ^0.26.1
- [log4js](https://npm.io/package/log4js.md) ^6.4.5
- [commander](https://npm.io/package/commander.md) ^9.2.0
- [@types/ejs](https://npm.io/package/@types/ejs.md) ^3.1.0
- [iconv-lite](https://npm.io/package/iconv-lite.md) ^0.6.3
- [nodemailer](https://npm.io/package/nodemailer.md) ^6.7.3
- [rss-parser](https://npm.io/package/rss-parser.md) ^3.12.0
- [typescript](https://npm.io/package/typescript.md) ^4.6.3
- [@types/node](https://npm.io/package/@types/node.md) ^17.0.24
- [@types/xml2js](https://npm.io/package/@types/xml2js.md) ^0.4.11
- [@types/nodemailer](https://npm.io/package/@types/nodemailer.md) ^6.4.4

## Recent versions

- 0.0.3 (latest) — 2022-05-17
- 0.0.2 — 2022-04-17
- 0.0.2-0 — 2022-04-17
- 0.0.3-0 — 2022-04-17
- 0.0.1 — 2022-04-17
- 0.0.0 — 2022-04-17

## README

# rss-mailer

![npm](https://img.shields.io/npm/v/rss-mailer)

The Easy Way to Send RSS Feeds to Email

Avoid information explosion and AI Recommendation Algorithms

Improve the efficiency of information acquisition

## Usage

```shell
# install
$ npm install -g rss-mailer

# run
$ rssmailer -c path/to/config
```

## Configure File

The configure file supports `.json` and `.js` formats.

Example: 
```js
module.exports = {
  // RSS url list
  feeds: [
    // Easy to use via url
    "https://waynegong.cn/atom.xml",
    
    // Full usage configuration
    {
      url: "https://www.ruanyifeng.com/blog/atom.xml",  // Url is required
      charset: "utf8",  // Support 'utf8' 'gbk', default 'utf8'
      timeout: 30000, // Timeout for requesting RSS feeds, default 30000 ms
    },
  ],

  sender: [
    
    {
      type: "email",  // Send to email
      
      // SMTP configure
      host: "mail.waynegong.cn",
      port: 465,
      secure: true,
      auth: {
        user: "rssmailer@waynegong.cn",
        pass: "******",
      },
      
      // Email configure
      subject: "RSSMailer Dailly",
      from: "RSSMailer <RSSMailer@waynegong.cn>",
      to: "me@waynegong.cn",
    },
    
    {
      type: "file", // Write to file
      path: "output.html",  // File path is required
    },
  ],

  filter: [
    {
      type: "fresh",  // Filter based on freshness policy
      fresh: 86400000, // Within the last 24 hours (24 * 60 * 60 * 1000)ms
    }
  ],
};
```

---
_Source: https://npm.io/package/rss-mailer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._