Fictioneer plugin for email notifications about new content.
Find a file
2024-06-07 19:13:39 +02:00
classes Add table action to remove all sent notifications 2024-06-07 17:51:41 +02:00
css Move update notice styles to theme 2024-06-03 19:56:38 +02:00
js Reload modal on Follow toggle 2024-06-03 01:36:54 +02:00
repo/assets Update readme 2024-06-07 17:17:47 +02:00
src Move update notice styles to theme 2024-06-03 19:56:38 +02:00
.gitattributes Initial commit 2024-03-10 00:44:53 +01:00
.gitignore Allow config.codekit3 in repo 2024-06-04 16:00:33 +02:00
actions.php Toggle story subscription by Follow 2024-05-31 01:12:35 +02:00
admin.php Add table action to remove all sent notifications 2024-06-07 17:51:41 +02:00
ajax.php Update text 2024-06-06 19:10:55 +02:00
config.codekit3 Add modal preview 2024-06-06 19:20:34 +02:00
fictioneer-email-notifications.php Fix typo 2024-06-07 19:04:47 +02:00
LICENSE Initial commit 2024-03-10 00:44:53 +01:00
modal.php Update modal texts 2024-05-28 18:17:13 +02:00
README.md Update README.md 2024-06-07 19:13:39 +02:00
stubs.php Update stubs.php 2024-05-31 12:21:36 +02:00
utility.php Improve queue error message 2024-06-07 17:17:36 +02:00

Fictioneer Email Notifications

Plugin: 1.0 License: GPL v3 WordPress 6.1+ PHP: 7.4+

This WordPress plugin is built exclusively for the Fictioneer theme, version 5.19.0 or higher. It enables guests and users to subscribe to selected content updates via email. You can choose to receive notifications for all new content, specific post types, or individual stories and taxonomies. Multiple notifications per subscriber are aggregated into a single email. The plugin is compatible with all cache plugins.

Currently, the plugin is integrated with the MailerSend email service provider. MailerSend offers a generous free plan of 3,000 emails per month and bulk emails. This should last you a long time before you need a paid plan, at which point you should have the support to afford it.

Modal Preview

Installation

Same as the Fictioneer theme, the plugin is not available in the official WordPress library and needs to be installed and updated manually.

  1. Download the zip file from the latest release.
  2. In your WordPress dashboard, go to Plugins > Add New Plugin.
  3. Click on Upload Plugin at the top.
  4. Select the downloaded zip file and click Install Now.
  5. Activate the plugin once the installation is complete.

After installing the plugin, follow these steps to set up MailerSend:

  1. Register with MailerSend.
  2. Add your domain for API access. This step may seem intimidating if you are not experienced with such things, but MailerSend provides a comprehensive guide with examples for different hosts. If you are on a managed host, you should be able to ask the support for help as well.
  3. Once your domain is set up, add your API key in your WordPress dashboard under Notifications > Settings.

MailerSend also offers a WordPress plugin for your day-to-day transactional emails, such as email confirmations. Please note that it is not required for this notification plugin and does not assist with its functionality. But if you already have a MailerSend account, you may as well use it.

Frontend

The plugin integrates seamlessly into the Fictioneer theme. Youll find a new option in the [Subscribe] popup menu, the user menu, and the mobile menu to open the subscription modal. The user profile is extended with a new section to link your subscription, which can use a different email address, and enable Follows to automatically subscribe to a story.

Additionally, you can use the [fictioneer_email_subscription] shortcode to render an email input field that serves as a toggle for the modal. The optional placeholder="" parameter allows you to customize the text. Beyond this, there is nothing else to do on the frontend.

User Menu Entry Subscribe Button Profile Section Shortcode

Admin

The plugin menus are added low in the admin sidebar under Notifications with a letter icon.

Notifications

This page provides a list table of all notifications, both unsent and sent (if not cleared). Blog posts, stories, and chapters are automatically enqueued when published for the first time. You also have the option to add them manually using their ID, which can be found in the URL of the post edit screen. Duplicates and ineligible posts are either skipped or marked accordingly if already present in the table. The status column indicates the current state of each notification, while other columns provide additional information.

Each eligible post features a meta box in the sidebar with related information, such as the dates when it has been enqueued and sent. You can send notifications multiple times if desired. Two convenient checkbox flags allow you to re-enqueue a post once when updated or exclude it entirely. This is currently limited to administrators.

List Table Meta Box

Send Emails

This is where you can send notifications to subscribers. The plugin does not send notifications automatically, as it prioritizes control over convenience. Sending notifications requires just the push of a button, which is considered manageable.

The queue is processed via Fetch API requests, providing you with real-time information about the status. Since the plugin pushes emails in bulk to the MailerSend service, you can use the ID link to monitor the progress on their end.

To reduce the number of emails sent, multiple notifications are aggregated into a single email. This ensures that subscribers receive a concise summary of updates rather than individual ones, minimizing email clutter and reducing the risk of being classified as spam.

Note that the MailerSend API has a rate limit of 10 requests per minute and 1,000 requests per day, at least for the free tier. The queue script ensures that you do not exceed this rate limit. If something goes wrong, you can retry again later — successful batches are not sent again. Incomplete queues are stored for 24 hours.

Start New Queue Processed Queue Retry Queue

Subscribers

This page provides a list table of all subscribers along with their selected scopes. Aside from administrative actions, the most useful feature is the option to display an email preview for the current queue. This allows you to see how your emails will look to the recipient.

You can manually add or remove subscribers, confirm or unconfirm them, and resend them their edit code (which should be included in any email anyway). Unconfirmed subscribers will be deleted after 24-36 hours, as soon as the cron job runs.

Start New Queue

Templates

Settings

Log

Frequently Asked Question