Mautic

https://docs.mautic.org/en/7.1
Admin
Mautic is an open-source marketing automation platform that enables businesses to manage contacts,...
Tokens:106,481
Snippets:1,002
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Mautic install command with parameters

Source: https://docs.mautic.org/en/7.1/getting_started/how_to_install_mautic.html

Example of running the installation command with specific parameters provided via the CLI.

```bash
path/to/php bin/console mautic:install https://m.example.com
--mailer_from_name="Example From Name" --mailer_from_email="mautic@localhost"
--mailer_transport="smtp" --mailer_host="localhost" --mailer_port="1025"
--db_driver="pdo_mysql" --db_host="db" --db_port="3306" --db_name="db" --db_user="db" --db_password="db"
--db_backup_tables="false" --admin_email="admin@mautic.local" --admin_password="Maut1cR0cks!"
```

--------------------------------

### Example local.php configuration

Source: https://docs.mautic.org/en/7.1/getting_started/how_to_install_mautic.html

A sample local.php file used to define database and mailer settings for the installation.

```php
<?php
// Example local.php to test install (to adapt of course)
$parameters = array(
  // Do not set db_driver and mailer_from_name as they are used to assume Mautic is installed
  'db_host' => 'localhost',
  'db_table_prefix' => null,
  'db_port' => 3306,
  'db_name' => 'mautic',
  'db_user' => 'mautic',
  'db_password' => 'mautic',
  'db_backup_tables' => false,
  'db_backup_prefix' => 'bak_',
  'admin_email' => 'admin@example.com',
  'admin_password' => 'Maut1cR0cks!',
  'mailer_transport' => null,
  'mailer_host' => null,
  'mailer_port' => null,
  'mailer_user' => null,
  'mailer_password' => null,
  'mailer_api_key' => null,
  'mailer_encryption' => null,
  'mailer_auth_mode' => null,
);
```

--------------------------------

### Initialize WordPress Development Environment

Source: https://docs.mautic.org/en/7.1/plugins/wordpress.html

Run these commands to install dependencies, build assets, and start the Docker-based WordPress environment.

```bash
npm install
npm run build:dev
npm run env:start
npm run env:install
```

--------------------------------

### Full template configuration example

Source: https://docs.mautic.org/en/7.1/builders/email_landing_page.html

A complete example of a configuration file for a Mautic theme supporting multiple builders.

```json
{
  "name": "Blank",
  "author": "Mautic team",
  "authorUrl": "https://mautic.org",
  "builder": ["legacy", "grapesjsbuilder"],
  "features": ["page", "email", "form"]
}
```

--------------------------------

### Mautic install command options

Source: https://docs.mautic.org/en/7.1/getting_started/how_to_install_mautic.html

List of available flags and options for the mautic:install command.

```text
--db_driver=DB_DRIVER                    Database driver. [default: "pdo_mysql"]
 --db_host=DB_HOST                        Database host.
 --db_port=DB_PORT                        Database port.
 --db_name=DB_NAME                        Database name.
 --db_user=DB_USER                        Database user.
 --db_password=DB_PASSWORD                Database password.
 --db_table_prefix=DB_TABLE_PREFIX        Database tables prefix.
 --db_backup_tables=DB_BACKUP_TABLES      Backup database tables if they exist; otherwise drop them. [default: true]
 --db_backup_prefix=DB_BACKUP_PREFIX      Database backup tables prefix. [default: "bak_"]
 --admin_firstname=ADMIN_FIRSTNAME        Admin first name.
 --admin_lastname=ADMIN_LASTNAME          Admin last name.
 --admin_username=ADMIN_USERNAME          Admin username.
 --admin_email=ADMIN_EMAIL                Admin email.
 --admin_password=ADMIN_PASSWORD          Admin user.
 --mailer_from_name[=MAILER_FROM_NAME]    From name for email sent from Mautic.
 --mailer_from_email[=MAILER_FROM_EMAIL]  From email sent from Mautic.
 --mailer_transport[=MAILER_TRANSPORT]    Mail transport.
 --mailer_host=MAILER_HOST                SMTP host.
 --mailer_port=MAILER_PORT                SMTP port.
 --mailer_user=MAILER_USER                SMTP username.
 --mailer_password[=MAILER_PASSWORD]      SMTP password.
 --mailer_encryption[=MAILER_ENCRYPTION]  SMTP encryption (null|tls|ssl).
 --mailer_auth_mode[=MAILER_AUTH_MODE]    SMTP auth mode (null|plain|login|cram-md5).
 --mailer_spool_type=MAILER_SPOOL_TYPE    Spool mode (file|memory).
 --mailer_spool_path=MAILER_SPOOL_PATH    Spool path.
```

--------------------------------

### Date/Time Format Example

Source: https://docs.mautic.org/en/7.1/contacts/import_contacts.html

Example of the recommended ISO8601 date/time format for contact imports.

```text
2019-01-02 19:08:42
```

--------------------------------

### Install AMQP dependency

Source: https://docs.mautic.org/en/7.1/configuration/settings.html

Install the required Composer dependency for the AMQP transport.

```bash
composer require symfony/amqp-messenger
```

--------------------------------

### Certificate Directory Structure Example

Source: https://docs.mautic.org/en/7.1/configuration/smime_email_signing.html

Example of the expected directory structure for S/MIME certificates within the path defined by smime_certificates_path.

```text
/var/smime_certificates/
├── admin@example.com.crt
├── admin@example.com.pem
├── support@example.com.crt
└── support@example.com.pem
```

--------------------------------

### Mautic installation output

Source: https://docs.mautic.org/en/7.1/getting_started/how_to_install_mautic.html

Sample output displayed during the Mautic installation process, including status checks and completion confirmation.

```text
Mautic Install
==============

Parsing options and arguments...
0 - Checking installation requirements...
Missing optional settings:
  - [0] The <strong>memory_limit</strong> setting in your PHP configuration is lower than the suggested minimum limit of %min_memory_limit%. Mautic can have performance issues with large datasets without sufficient memory.
Ready to Install!
1 - Creating database...
1.1 - Creating schema...
1.2 - Loading fixtures...
2 - Creating admin user...
3 - Email configuration and final steps...

================
Install complete
================
```

--------------------------------

### Configure RabbitMQ in local configuration

Source: https://docs.mautic.org/en/7.1/queue/queue.html

Example configuration parameters for connecting Mautic to a RabbitMQ server.

```php
'queue_protocol' => 'rabbitmq',
'rabbitmq_host' => 'b-180b97c2-6b05-4b10-80ed-09182eac3a02.mq.us-west-1.amazonaws.com',
'rabbitmq_port' => '5671',
'rabbitmq_vhost' => '/',
'rabbitmq_user' => 'some_user',
'rabbitmq_password' => 'some_password',
'rabbitmq_idle_timeout' => 0,
'rabbitmq_idle_timeout_exit_code' => 0,
```

--------------------------------

### Start Mautic development environment with DDEV

Source: https://docs.mautic.org/en/7.1/getting_started/how_to_install_mautic.html

Initialize and start the DDEV environment within the Mautic directory to spin up services like Mailhog, PHPMyAdmin, and Redis Commander.

```bash
ddev start
```

--------------------------------

### Install Bitly bundle via Composer

Source: https://docs.mautic.org/en/7.1/configuration/shortener.html

Use this command to install the Bitly bundle for Mautic 5 via Composer.

```bash
composer require webmecanik/mautic-bitly-bundle
```

--------------------------------

### Install Mautic Sparkpost plugin

Source: https://docs.mautic.org/en/7.1/configuration/settings.html

Composer command to install the Mautic Sparkpost plugin for enhanced transport support.

```bash
composer require ts-navghane/sparkpost-plugin
```

--------------------------------

### Search Marketplace Plugins

Source: https://docs.mautic.org/en/7.1/marketplace/marketplace.html

Example command to filter the plugin list for a specific term, such as 'Captcha'.

```bash
bin/console mautic:marketplace:list --filter=captcha
```

--------------------------------

### Consume email queue

Source: https://docs.mautic.org/en/7.1/configuration/settings.html

Run this command to start consuming messages from the email queue.

```bash
php bin/console messenger:consume email
```

--------------------------------

### Install SendGrid Transport via Composer

Source: https://docs.mautic.org/en/7.1/configuration/settings.html

Command to install the official Symfony SendGrid transport plugin when Mautic is installed via Composer.

```bash
composer require symfony/sendgrid-mailer
```

--------------------------------

### Initialize new project without installation

Source: https://docs.mautic.org/en/7.1/getting_started/how_to_install_mautic.html

Run the create-project command with the --no-install flag to prepare a new Mautic project directory before modifying the folder structure.

```bash
composer create-project mautic/recommended-project:^5 some-dir --no-interaction --no-install
```

--------------------------------

### Install Beanstalkd dependency

Source: https://docs.mautic.org/en/7.1/configuration/settings.html

Install the required Composer dependency for the Beanstalkd transport.

```bash
composer require symfony/beanstalkd-messenger
```

--------------------------------

### Create Mautic project with Composer

Source: https://docs.mautic.org/en/7.1/getting_started/switching_composer.html

Run this command in the /var/www directory to initialize a new Mautic project using Composer.

```bash
composer create-project mautic/recommended-project:^5 html-new --no-interaction
```

--------------------------------

### List Marketplace Plugins

Source: https://docs.mautic.org/en/7.1/marketplace/marketplace.html

Executes the command to list the first page of available plugins in the Mautic Marketplace.

```bash
bin/console mautic:marketplace:list
```

```text
+-------------------------------------------------------+-----------+--------+
| name                                                  | downloads | favers |
+----------------------------------------------------+--------+-----+
| mautic/mautic-saelos-bundle                           | 11623     | 11     |
| koco/mautic-recaptcha-bundle                          | 2662      | 24     |
|     This plugin brings reCAPTCHA integration to       |           |        |
|     mautic.                                           |           |        |
| thedmsgroup/mautic-extended-field-bundle              | 3069      | 25     |
|     Extends custom fields for scalability and         |           |        |
|     HIPAA/PCI compliance.                             |           |        |
| mtcextendee/mautic-sql-conditions-bundle              | 190       | 6      |
| maatoo/mautic-referrals-bundle                        | 1063      | 5      |
|     This plugin enables referrals in mautic.          |           |        |
| thedmsgroup/mautic-health-bundle                      | 2139      | 11     |
|     Checks the health of the Mautic instance.         |           |        |
| thedmsgroup/mautic-dashboard-warm-bundle              | 1921      | 12     |
|     Improves the performance of the dashboard by      |           |        |
|     sharing/extending/warming caches.                 |           |        |
| thedmsgroup/mautic-contact-source-bundle              | 2852      | 43     |
|     Creates API endpoints for receiving contacts from |           |        |
|     external sources.                                 |           |        |
| thedmsgroup/mautic-contact-client-bundle              | 4035      | 70     |
|     Create custom integrations without writing code.  |           |        |
| thedmsgroup/mautic-campaign-watch-bundle              | 1817      | 14     |
|     Visual improvements for campaigns.                |           |        |
| raow/mautic-rss-to-email-bundle                       | 971       | 69     |
| mtcextendee/mautic-random-smtp-bundle                 | 101       | 10     |
| kuzmany/mautic-recommender-bundle                     | 250       | 30     |
| kuzmany/mautic-custom-tags-bundle                     | 119       | 20     |
| dazzle/mautic-sendinblue-bundle                       | 73        | 5      |
|     Allows to send E-mails with Sendinblue            |           |        |
+-------------------------------------------------------+-----------+--------+
Total packages: 69
Execution time: 388 ms
```

--------------------------------

### Install Amazon SQS dependency

Source: https://docs.mautic.org/en/7.1/configuration/settings.html

Install the required Composer dependency for the Amazon SQS transport.

```bash
composer require symfony/amazon-sqs-messenger
```

--------------------------------

### Marketplace List Help Options

Source: https://docs.mautic.org/en/7.1/marketplace/marketplace.html

Displays the available options for filtering and pagination when using the list command.

```bash
-p, --page[=PAGE]      Page number [default: 1]
-l, --limit[=LIMIT]    Packages per page [default: 15]
-f, --filter[=FILTER]  Filter the packages [default: ""]
-h, --help             Display this help message
```

--------------------------------

### Staggered cron job schedule example

Source: https://docs.mautic.org/en/7.1/configuration/cron_jobs.html

An example of how to stagger cron jobs to prevent them from running at the exact same minute.

```text
- 0,15,30,45 <— mautic:segments:update
- 5,20,35,50 <— mautic:campaigns:update
- 10,25,40,55 <— mautic:campaigns:trigger
```

--------------------------------

### Company Field Label Modifier Examples

Source: https://docs.mautic.org/en/7.1/configuration/variables.html

Examples of using the label modifier for company select and boolean fields.

```text
{contactfield=company_type|label}
{contactfield=company_active|label}
```

--------------------------------

### Email recipient format example

Source: https://docs.mautic.org/en/7.1/reports/reports.html

Example of the comma-separated format required for specifying multiple email recipients for scheduled reports.

```text
example1@example.com, example2@example.com
```
Tokens:
Raw