Newsletter Plugin for Grav CMS

Newsletter Plugin provides a subscription functionality in order to subscribe to a newsletter.

Installation

Development

Use modman package manager to install the plugin.

From the Grav CMS project directory perform the commands

modman init
modman clone [email protected]:mcspronko/grav-plugin-newsletter.git

As a result, the Newsletter plugin should appear under user/plugins/newsletter directory.

Subscribers

There are two ways on how you can add new subscriber to the system.

Admin Panel

Navigate to the Admin -> Newsletter -> Audience page and click the "Add Subscriber" button. Fill in all required fields and hit the "Save" button.

Manually

In order to add a new subscriber, create a new Markdown file under <project_root>/user/data/newsletter/subscribers directory.

---
name: Max Pronko
email: [email protected]
is_subscribed: 1
created: 2019-07-10 11:10:03
---

From Admin -> Newsletter page you will see new subscriber record.

Campaigns

In order to create new campaign, navigate to the Admin -> Newsletter -> Campaigns page and click the "Create Campaign" button.

Example of a Form Configuration

form:
    name: newsletter
    action: /subscribe.json
    fields:
        -
            name: email
            size: field-size
            outerclasses: field-position
            placeholder: 'Your Email Here'
            type: email
            validate:
                required: true
    buttons:
        -
            type: submit
            classes: 'button submit'
            value: Subscribe
    process:
        -
            subscribe:
                fileprefix: subscriber-
                dateformat: Ymd-His-u
                extension: txt
                body: '{% include ''forms/data.txt.twig'' %}'
        -
            message: 'Thank you for your subscription!'