Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
rss-to-email
Advanced tools
Readme
Generate HTML emails and mjml templates from one or more RSS feeds.
Note: This project is pre-version 1.0.0, so breaking changes may occur. Use at your own risk or lock down to a specific version using NPM.
_ _ _
_ __ ___ ___ | |_ ___ ___ _ __ ___ __ _(_) |
| '__/ __/ __|_____| __/ _ \ _____ / _ \ '_ ` _ \ / _` | | |
| | \__ \__ \_____| || (_) |_____| __/ | | | | | (_| | | |
|_| |___/___/ \__\___/ \___|_| |_| |_|\__,_|_|_|
The recommended way to use this package is as an npm package. To install and save it to your project's dependencies, run:
npm install rss-to-email --save
After installing, call the RssToEmail
factory with a config object. Use the resulting rssToEmail
object to get emails in mjml
or html
formats:
const RssToEmail = require('rss-to-email');
const config = {
// See #Configuration section of the docs below
};
const rssToEmail = RssToEmail(config);
rssToEmail.getEmail('html').then((email) => {
console.log(email); // The HTML version of your email
});
rssToEmail.getEmail('mjml').then((email) => {
console.log(email); // The MJML version of your email
});
You can install this package globally and run it as a command line tool as well. First install it:
npm install -g rss-to-email
Then run the tool:
rss-to-email <config-file-path> <output-folder-path>
The path should be relative to your current directory. For example, if your config file is at ./config.json
and you want to output the resulting files to a directory ./output
, you would run:
rss-to-email ./config.json ./output
For an example config file, see config.example.json
.
accentColor
: A hex or html-safe color code.filename
: The base name of the output files to generate (do not include extensions).header
: Configuration for the header section of the email:
banner
: (optional) An image url for the banner at the top of the email.link
: A link for the header image or text.title
: Shown if the banner is not set or as an alt
tag on the image.intro
: The first line of the email. Can use HTML or plain text.feeds
: An array of RSS feeds you'd like to include. Only url
is required:
url
: The url to the RSS feed.title
: (optional) A custom feed title. Will use the RSS feed's embedded one by default.description
: (optional) A short custom feed description. Will use the RSS feed's embedded one by default.limit
: (optional) Truncate items greater than a given limit.publishedSince
: (optional) Filter out posts published before this date.parserOptions
: (optional) Custom RSS parser options outlined in the Node rss-parser documentation.outro
: The last line of the email. Can use HTML or plain text.templateUrl
: (optional) A handlebars/mjml template. For more details, see Templates section.In order to compose custom emails, you can build your own MJML templates with Handlebars. If you don't specify a template URL, the library defaults to this file.
Many of the config file's variables are exposed in the templates including:
header
intro
outro
The feeds
variable contains an array of all of the feeds with an array of all of the items in each. For example, the following is a basic template that will loop through all the RSS feeds and items, displaying the title and content of each:
{{#each feeds}}
<!-- Feed -->
<mj-section>
<mj-column>
<mj-text>{{this.title}}</mj-text>
<mj-text>{{this.description}}</mj-text>
</mj-column>
</mj-section>
{{#each items}}
<!-- Item -->
<mj-section>
<mj-column>
<mj-text>
<a href="{{this.link}}">{{this.title}}</a>
</mj-text>
<mj-text>{{{this.content}}}</mj-text>
</mj-column>
</mj-section>
{{/each}}
{{/each}}
You can also use any helper in the handlebars-helpers library:
{{#is intro "A certain intro"}}
<p>A certain intro was used.</p>
{{/is}}
All patches, fixes, and ideas welcome! Please read contributing.md for furthers details.
Copyright 2021, Hughes Domains, LLC.
FAQs
Generate HTML email from your RSS feeds
The npm package rss-to-email receives a total of 4 weekly downloads. As such, rss-to-email popularity was classified as not popular.
We found that rss-to-email demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.