Making a custom add-on

This page guides you into developing your own add-on to safely modify AcyMailing features.

AcyMailing has a lot of features, but it isn't integrated with every other extension. You may want to create your own custom add-on to:

  • insert dynamic texts in your emails (the current month, an event name, etc…)

  • insert user information in your emails (a custom field, a personal information, etc…)

  • automatically insert content built in other extensions (products, events, articles, etc…)

  • execute a script when a specific action is performed in AcyMailing (when a new user subscribes, when a user is imported, etc…)

Creating my custom add-on

First create the main folder for your add-on. It must be in lowercase with only letters: administrator/components/com_acym/dynamics/exampleaddon/

Inside this folder, create the file plugin.php like this one:

<?php

use AcyMailing\Libraries\acymPlugin;

class plgAcymExampleaddon extends acymPlugin
{
}

The class name MUST always be "plgAcym" followed by the folder name of your add-on, with a capital letter at the beginning.

Adding features to your custom add-on

Once your custom add-on's base files are created, you can add methods in the plugin.php file to customise AcyMailing features.

Last updated