PHPackages                             garagist/mautic - 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. garagist/mautic

ActiveNeos-plugin

garagist/mautic
===============

Neos adapter for the Mautic API

0.2.10(1y ago)01.2k[5 issues](https://github.com/Garagist/Garagist.Mautic/issues)[2 PRs](https://github.com/Garagist/Garagist.Mautic/pulls)GPL-3.0-or-laterPHPCI passing

Since Feb 17Pushed 11mo ago2 watchersCompare

[ Source](https://github.com/Garagist/Garagist.Mautic)[ Packagist](https://packagist.org/packages/garagist/mautic)[ RSS](/packages/garagist-mautic/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (18)Used By (0)

Garagist.Mautic
===============

[](#garagistmautic)

[![Latest stable version](https://camo.githubusercontent.com/e44b6b905b716d17dc21a15e4848006372300718e25c2345738f261418ea0931/68747470733a2f2f706f7365722e707567782e6f72672f67617261676973742f6d61757469632f762f737461626c65)](https://packagist.org/packages/garagist/mautic) [![GitHub stars](https://camo.githubusercontent.com/52aa6680376b9a1b1238ded247d98d59154cc9737da2f15bb10b8fee3ff2b096/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f73746172732f47617261676973742f47617261676973742e4d6175746963)](https://github.com/Garagist/Garagist.Mautic/stargazers) [![GitHub watchers](https://camo.githubusercontent.com/7f7aa44100f4017871c5d89d524326f2fde3f3864b434210e3cbcdf8eb639b5f/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f77617463686572732f47617261676973742f47617261676973742e4d61757469632e737667)](https://github.com/Garagist/Garagist.Mautic/subscription)[![GitHub license](https://camo.githubusercontent.com/09a22c562581050c7372d03f936afa461ef06a13b81efb0661241245ad7b5a50/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f47617261676973742f47617261676973742e4d6175746963)](LICENSE) [![GitHub issues](https://camo.githubusercontent.com/b47713c261dd6b8f41d5df4d41569f77762920ca74bca36b118b40e2d3187989/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6973737565732f47617261676973742f47617261676973742e4d6175746963)](https://github.com/Garagist/Garagist.Mautic/issues) [![GitHub forks](https://camo.githubusercontent.com/b81afcc4c5d61f27055599c67f67c8085648692a67e5e88b425d1f8fe2bad089/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f666f726b732f47617261676973742f47617261676973742e4d6175746963)](https://github.com/Garagist/Garagist.Mautic/network)

This package makes it possible to **send personalized newsletters** from Neos with [Mautic](https://www.mautic.org), **include forms** from Mautic as a content element and add **Mautic tracking**. The forms are integrated via the Javascript API. All backend requests to Mautic are event-sourced. This ensures that the tasks are processed even if Mautic is not available.

[![Screenshot with the overview of emails](https://user-images.githubusercontent.com/4510166/192508665-7dded40f-34e4-4035-b794-ca42eb8f12f0.png)](https://user-images.githubusercontent.com/4510166/192508665-7dded40f-34e4-4035-b794-ca42eb8f12f0.png)[![Screenshot with the view of a document](https://user-images.githubusercontent.com/4510166/192508719-a5c3e5c0-4994-4e24-b989-0943cce25ec6.png)](https://user-images.githubusercontent.com/4510166/192508719-a5c3e5c0-4994-4e24-b989-0943cce25ec6.png)[![Screenshot with the detail view of an email](https://user-images.githubusercontent.com/4510166/192508772-b8958a6b-fc75-4d78-8b4d-756395e4d8a5.png)](https://user-images.githubusercontent.com/4510166/192508772-b8958a6b-fc75-4d78-8b4d-756395e4d8a5.png)

Installation
------------

[](#installation)

Add the package in your site package:

```
composer require --no-update garagist/mautic
```

The run `composer update` in your project root.

Finally you need to run the following commands:

```
flow doctrine:migrate
flow eventstore:setupall
```

Configure Mautic
----------------

[](#configure-mautic)

1. Visit your Mautic installation and [create a user for API](https://docs.acquia.com/campaign-studio/settings/users-roles/).
2. [Enable API and HTTP basic auth](https://docs.acquia.com/campaign-studio/settings/api-quick-start/). Optional: Be sure your Mautic installation is running on HTTPS for the sake of security.
3. If you want to send test emails, please install our [GaragistMauticApiBundle](https://github.com/Garagist/GaragistMauticApiBundle) plugin.
4. Skip this, if your website and Mautic are running on the same server:
    - [Enable CORS](https://docs.acquia.com/campaign-studio/settings/configuration/#cors-settings), add your site to `valid domains`.

Configure Neos
--------------

[](#configure-neos)

The default values are set in [`Settings.Garagist.yaml`](Configuration/Settings.Garagist.yaml).

### `routeArgument` setting

[](#routeargument-setting)

`htmlTemplate` sets the argument used to call the `HTML` variant of the newsletter and send it to Mautic.

`plaintextTemplate` sets the argument used to call the plaintext variant of the newsletter and send it to Mautic.

If you use [Garagist.Mjml](https://github.com/Garagist/Garagist.Mjml) `htmlTemplate` is automatically set to `mjml`. The important thing is simply to respect the loading order of the composer and load [Garagist.Mjml](https://github.com/Garagist/Garagist.Mjml) after Garagist.Mautic.

### `api` setting

[](#api-setting)

Set your credentials `userName` and `password` from Mautic. `baseUrl` is the URL where Mautic can be reached via PHP. This may be different from the `publicUrl` (see next section) if Mautic is running in its own Docker container.

### `publicUrl` setting

[](#publicurl-setting)

Set here the URL where the Mautic installation is publicly accessible. This will be used for tracking, forms and links in the newsletter module.

### `enableTracking` setting

[](#enabletracking-setting)

Enable the Javascript tracking code from Mautic. By default it is set to `false` in the development context and to `true` in the production context.

### `mail` setting

[](#mail-setting)

`trackingPixel` injects the tracking pixel from Mautic right before the closing `body` tag.

### `form` setting

[](#form-setting)

`hide` sets the IDs of the forms you want to hide in the inpsector. You can pass an array (eg. `[1, 2, 3]`) or an integer

### `category` setting

[](#category-setting)

`newsletter` sets the ID of the category you want to use for the newsletters. Be aware that the category must exist in Mautic.

### `testMail` setting

[](#testmail-setting)

`recipients` defines the email addresses you want to use for send test emails. You can pass an array (eg. `['test@mail.example', 'user@mail.example']`) or an string (eg. `'test@mail.example'`). Note that the [GaragistMauticApiBundle](https://github.com/Garagist/GaragistMauticApiBundle) plugin must be installed in your Mautic installation. Also the setting `action.test` need to set to `true`.

### `segment` setting

[](#segment-setting)

- `lockPrefilled` set if an segment is prefilled from the creation/edit dialog, the user can't unselect it. Defaults to `true`
- `mapping`: The ID of the segment to use for the newsletter. But you can also define an array/object to handle the segment in your own data provider.
- `choose`: Add here to segments to choose from on creation/edit dialog. You can pass an array (eg. `[1, 2, 3]`) or an integer.
- `hide`: Add here the IDs of the segments you want to hide (eg. for unconfirmed contacts). You can pass an array (eg. `[1, 2, 3]`) or an integer.

### `action` setting

[](#action-setting)

In this group you can enable/disable folwing actions:

- `delete` Ability to delete emails, defaults to `true`
- `publish` Ability to publish emails, defaults to `true`
- `unpublish` Ability to unpublish emails, defaults to `true`
- `send` Ability to send emails, defaults to `true`
- `update` Ability to update emails, defaults to `true`
- `edit` Ability to change subject, preview text and/or receiver, defaults to `true`
- `test` Ability to send test (aka example) emails, defaults to `false`. You need to install the [GaragistMauticApiBundle](https://github.com/Garagist/GaragistMauticApiBundle) plugin in your Mautic installation

Personalization
---------------

[](#personalization)

It is possible to send personalized emails. To use this, simply apply the following markup in the text on your page:

```
{#ifNewsletter}Hello #FIRSTNAME# #Lastname#, this is your newsletter{:else}Fallback for Webview{/if}

```

Availble fields are every field from contactfield, surounded by an # on both sides (case insensitive)

NodeTypes
---------

[](#nodetypes)

### [Garagist.Mautic:Mixin.Email](NodeTypes/Mixin/Email.yaml)

[](#garagistmauticmixinemail)

Add this mixin to any document to enable the ability to send newsletter.

### [Garagist.Mautic:Mixin.Category](NodeTypes/Mixin/Category.yaml)

[](#garagistmauticmixincategory)

Add this mixin to any document to define this as a category for newsletters. This is used in the overview of the newsletter module.

### [Garagist.Mautic:Mixin.DoNotTrack](NodeTypes/Mixin/DoNotTrack.yaml)

[](#garagistmauticmixindonottrack)

Add this mixin to any document to have the ability to disable the Mautic tracking for this specific page.

### [Garagist.Mautic:Mixin.Form](NodeTypes/Mixin/Form.yaml)

[](#garagistmauticmixinform)

Add this mixin to a node to add the selector for Mautic forms. Be aware that you need to include the Fusion prototype [Garagist.Mautic:Component.Form](Resources/Private/Fusion/Component/Form.fusion) somewhere in your markup

###  Health Score

32

—

LowBetter than 71% of packages

Maintenance49

Moderate activity, may be stable

Popularity14

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 91% 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 ~97 days

Recently: every ~52 days

Total

12

Last Release

465d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/5fec51ac160a110a31a72a54ac29e276a447d8306205a052d35491ac9cf0589b?d=identicon)[jonnitto](/maintainers/jonnitto)

![](https://www.gravatar.com/avatar/73795aa56d38a252f4b3dbc303b3ce712fd834dfca14d1a9b8b607ec90fbefa8?d=identicon)[davidspiola](/maintainers/davidspiola)

---

Top Contributors

[![jonnitto](https://avatars.githubusercontent.com/u/4510166?v=4)](https://github.com/jonnitto "jonnitto (272 commits)")[![davidspiola](https://avatars.githubusercontent.com/u/7107011?v=4)](https://github.com/davidspiola "davidspiola (16 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (11 commits)")

---

Tags

hacktoberfestmauticmautic-apineoscmsnewsletter

### Embed Badge

![Health badge](/badges/garagist-mautic/health.svg)

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

###  Alternatives

[neos/neos-ui

Neos CMS UI written in React

2661.0M104](/packages/neos-neos-ui)[neos/neos

An open source Content Application Platform based on Flow. A set of core Content Management features is resting within a larger context that allows you to build a perfectly customized experience for your users.

116989.0k671](/packages/neos-neos)[neos/neos-base-distribution

Neos Base Distribution

4464.9k](/packages/neos-neos-base-distribution)[neos/demo

Site package for the Neos Demo Site

18181.0k6](/packages/neos-demo)[flowpack/media-ui

This module allows managing media assets including pictures, videos, audio and documents.

2184.5k2](/packages/flowpack-media-ui)[shel/neos-colorpicker

A plugin for Neos CMS which provides a colorpicker editor

1494.4k6](/packages/shel-neos-colorpicker)

PHPackages © 2026

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