/phpbb-ext-mailrelay

Mailrelay extension for phpBB

Primary LanguagePHPGNU General Public License v2.0GPL-2.0

About

Mailrelay extension for phpBB.

Build Status Latest Stable Version Code Quality Translation Progress License

Automatically synchronizes user emails to Mailrelay to create, manage and send marketing campaigns.

Features

  • Synchronizes user emails and names using a cron task
  • Set the group ID where users will be added to
  • Set the maximum number of users that will be synchronized on each execution
  • Set frequency of synchronization tasks
  • Exclude bots by default
  • Exclude users that do not allow mass emails by default
  • Exclude banned users by default

Requirements

  • PHP 7.2.5 or greater
  • phpBB 3.3 or greate
  • Mailrelay API account and token

Support

Donate

If you like or found my work useful and want to show some appreciation, you can consider supporting its development by giving a donation.

Donate with PayPal Donate with Stripe
Donate with PayPal Donate with Stripe

Installation

  • Download the latest release
  • Decompress the *.zip or *.tar.gz file
  • Copy the files and directories inside {PHPBB_ROOT}/ext/alfredoramos/mailrelay/
  • Go to your Administration Control Panel > Customize > Manage extensions
  • Click on Enable and confirm

Preview

Mailrelay ACP settings

Mailrelay API

  • Login to your Mailrelay administration panel
  • Go to Settings > API keys
  • Generate a new API token if you don't have one already
  • Copy the API key
  • Optionally generate a new group in Subscribers > Groups
  • Copy the group ID

Configuration

  • Login to your phpBB Administration Control Panel
  • Go to Extensions > Mailrelay
  • Paste the API key in API token
  • Paste the group ID in Group ID
  • Set the maximum number of users to synchronize on each cron task execution in Sync packet size
  • Set the time between sync event in Sync frequency

Uninstallation

  • Go to your Administration Control Panel > Customize > Manage extensions
  • Click on Disable and confirm
  • Go back to Manage extensions > Mailrelay > Delete data and confirm

Upgrade

  • Go to your Administration Control Panel > Customize > Manage extensions
  • Click on Disable and confirm
  • Delete all the files inside {PHPBB_ROOT}/ext/alfredoramos/mailrelay/
  • Download the new version
  • Upload the new files inside {PHPBB_ROOT}/ext/alfredoramos/mailrelay/
  • Enable the extension again