PHPackages                             sandstorm/newsletter - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. sandstorm/newsletter

ActiveTypo3-flow-package

sandstorm/newsletter
====================

Package for Neos, such that it can be used to send Newsletters in a performant way.

1.1.0(7y ago)20944MITPHP

Since Oct 27Pushed 6y ago11 watchersCompare

[ Source](https://github.com/sandstorm/Newsletter)[ Packagist](https://packagist.org/packages/sandstorm/newsletter)[ RSS](/packages/sandstorm-newsletter/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (4)Dependencies (6)Versions (6)Used By (0)

Sandstorm.Newsletter
====================

[](#sandstormnewsletter)

**The project has been sponsored by [Swisscom](https://www.swisscom.ch), and initiated by [Web Essentials](http://www.web-essentials.asia/). Thanks for your support!**

This is a tool which adjusts Neos in a way such that it can be used to send Newsletters.

Is is comprised of two parts:

- a [Go Daemon](https://github.com/sandstorm/mailer-daemon) which does the actual Mail-Sending
- a [Neos package](https://github.com/sandstorm/Sandstorm.Newsletter) **this package** which provides the User Interface

This is a newsletter sending infrastructure based on Neos. The actual newsletter-sending is handled through Redis and a Go-Daemon, which can be found at .

Features
--------

[](#features)

- Performant and distributed mail sending through SMTP or Mandrill
- All Newsletter content is manageable through Neos
- Allow to replace arbitrary content in the newsletter with custom recipient-specific fields.
- Recipient-specific fields can be previewed in the `Desktop` preview mode.
- Support for multiple languages
- Allowance to seggregate the recipient list arbitrarily to tightly control whom newsletters should be sent to, using the [jq query language](https://stedolan.github.io/jq/manual/)
- Custom receiver sources possible
- Supports Unsubscribe lists in a privacy-preserving manner, not storing email addresses but their hashes
- Parallel email sending possible by starting multiple Go daemons simultaneously
- Auto-Inline CSS style sheets for maximum compatibility

### Non-Features

[](#non-features)

The following things are \*not yet implemented, but might be implemented in further projects:

- Sign Up for new Newsletters

Prerequisites
-------------

[](#prerequisites)

- Install the [mailer sending daemon](https://github.com/sandstorm/mailer-daemon/releases) which is written in Go
- Install Redis
- Install [jq](https://stedolan.github.io/jq/) and ensure it exists on the PATH.

Installation / Set Up
---------------------

[](#installation--set-up)

- Install this package through packagist:

    ```
    cd path/to/your/NeosDistribution
    composer require sandstorm/newsletter

    ```
- Ensure you have the Routes included, so that means `Configuration/Routes.yaml` should contain the following *before* the Neos routes:

    ```
    -
    name: 'Newsletter'
    uriPattern: 'neos/newsletter/'
    subRoutes:
      'NewsletterSubroutes':
        package: 'Sandstorm.Newsletter'

    ```
- Create a neos page template, using the TypoScript object `Sandstorm.Newsletter:NewsletterPage`. Also, ensure to include the `Sandstorm.Newsletter:SampleDataWidget` somewhere in your page.

    As an example, you can use the following TypoScript snippet:

    ```
    page = Sandstorm.Newsletter:NewsletterPage
    page.sampleDataWidget = Sandstorm.Newsletter:SampleDataWidget

    ```

Receiver Sources and Receiver Groups
------------------------------------

[](#receiver-sources-and-receiver-groups)

Internally, the system uses files for representing receiver lists. Each line in a file represents a *single receiver*, and is a JSON object containing arbitrary properties (where one must be at least the email address, of course).

- A *receiver source* is essentially one source for receivers. Currently, we support both line-by-line JSON and CSV files; but you might want to create your own Receiver Source lateron.
- If you use multiple languages, the *receiver source* also contains a rule how the lines are segregated into the different languages.
- The *receiver group* is an additional subset of receivers inside a *receiver source*, so you could create a "male" or "female" receiver source if you like.

Usage in Neos
-------------

[](#usage-in-neos)

- First, go to the *Newsletter Receiver Management* module and create a new receiver source; in our example choose the type *CSV Upload*\*\[\]:
- Then, upload the `Documentation/example.csv` file. It defines the fields `firstName`, `lastName`, `email`, `gender` and `language` and contains just three receivers.
- If you have a languages content dimension configured, set the correct filters; e.g:

    - German: `language == "de"`
    - French: `language == "fr"`
    - (others): `false` (as the input file does not contain these languages)
- (optionally) create a receiver group for "Male", with the filter `gender == "male"`, and vice versa for `female`.
- Now, in the Content module of Neos, create a new Document of type `Newsletter`. In the inspector, first select a *Receiver Group*. Optionally define email subjects etc; and create your content as you like.
- If your content e.g. includes `{firstName}`, this will be replaced with the actual first name of the email recipient. You can preview this by switching to the `Desktop` mode in preview central.
- Enjoy!

Getting Help
------------

[](#getting-help)

If you get stuck, feel free to contact @sebastian or @christoph.daehne in Slack at slack.neos.io.

License
-------

[](#license)

This software is licensed as MIT.

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 64.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~327 days

Total

4

Last Release

2867d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2ced0d63cfdae881c32128c7f66451a013d3e24d9eed210d6a846b6d8e95fa3b?d=identicon)[sandstorm](/maintainers/sandstorm)

---

Top Contributors

[![skurfuerst](https://avatars.githubusercontent.com/u/190777?v=4)](https://github.com/skurfuerst "skurfuerst (24 commits)")[![dfeyer](https://avatars.githubusercontent.com/u/221173?v=4)](https://github.com/dfeyer "dfeyer (12 commits)")[![CodeLingoBot](https://avatars.githubusercontent.com/u/45469328?v=4)](https://github.com/CodeLingoBot "CodeLingoBot (1 commits)")

---

Tags

neoscmsnewsletter

### Embed Badge

![Health badge](/badges/sandstorm-newsletter/health.svg)

```
[![Health](https://phpackages.com/badges/sandstorm-newsletter/health.svg)](https://phpackages.com/packages/sandstorm-newsletter)
```

###  Alternatives

[laravel/framework

The Laravel Framework.

34.6k509.9M17.0k](/packages/laravel-framework)[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M648](/packages/sylius-sylius)[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

728272.9k17](/packages/civicrm-civicrm-core)[spatie/laravel-health

Monitor the health of a Laravel application

85810.0M83](/packages/spatie-laravel-health)[shlinkio/shlink

A self-hosted and PHP-based URL shortener application with CLI and REST interfaces

4.8k4.3k](/packages/shlinkio-shlink)[drupal/core

Drupal is an open source content management platform powering millions of websites and applications.

19462.3M1.3k](/packages/drupal-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)