Merge branch '5.x' into shortener-service-support

.github/styles/Mautic/FeatureList.yml

@@ -45,6 +45,8 @@ swap:
   point actions: Point Actions
   point triggers: Point Triggers
   points: Points
+  group: Group
+  groups: Groups
   plugin: Plugin
   plugins: Plugins
   report: Report

.readthedocs.yaml → .readthedocs.yaml

@@ -26,4 +26,4 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: docs/requirements.txt
+   - requirements: docs/requirements.txt

.vscode/welcome.md

@@ -1,9 +1,9 @@
-Welcome to the Mautic end user documentation editor!
+Welcome to the Mautic End User documentation editor., open
 
-We've already set up everything you need. To get started, follow these steps:
-1. Open a file in the `docs/` folder (files that end with `.rst` are docs files)
-2. Click the magnifier icon in the top right corner to see a LIVE preview of the file you're editing
+Everything you need is already set up. To get started, follow these steps:
+1. Open a file in the `docs/` folder - files that end with `.rst` are docs files.
+2. Click the magnifier icon in the top right corner to see a live preview of the file you're editing.
 
 Pretty cool, right?
 
-Happy writing!
+Happy writing.

README.md

@@ -62,9 +62,10 @@ The following provides instructions for how to build docs locally for visualizat
 1. Install Python 3 for your OS if not already installed
 2. Install Sphinx `pip install sphinx`
 3. Install sphinx-rtd-theme `pip install sphinx-rtd-theme`
-4. CD into the docs directory `cd [path to this repo]/docs`
-5. Run `make html`
-6. This will generate HTML in docs/build/html. Setup a web server with the web root as docs/build/html or open docs/build/html/index.html in a browser.
+4. Install MyST Parser `pip install myst_parser`
+5. CD into the docs directory `cd [path to this repo]/docs`
+6. Run `make html`
+7. This will generate HTML in docs/build/html. Setup a web server with the web root as docs/build/html or open docs/build/html/index.html in a browser.
 
 ### Vale
 Before pushing, run Vale and address suggestions and errors as applicable.

docs/campaigns/campaign_builder.rst

@@ -58,7 +58,7 @@ The actions that Mautic offers in a Campaign include:
    * - **Add Company action**  
      - Associates a Contact with a Company and sets the Company as the primary Company for the Contact.
    * - **Adjust Contact Points**  
-     - Adds or subtracts Points from the Contact’s Point total.
+     - Adds or subtracts Points from the Contact’s Point total or Group.
    * - **Change Campaigns**  
      - Removes a Contact from the existing Campaign, moves them into another Campaign, restarts the current Campaign or a combination of these. You must remove a Contact from a Campaign before restarting the Campaign.
    * - **Change Contact's Stage**  
@@ -205,6 +205,8 @@ Here are the different conditions that Mautic offers in the Campaign Builder:
      - Checks if the Contact is a member of selected Segments.
    * - **Contact Tags**    
      - Checks if specified Tags are on the Contact record.
+   * - **Contact points**
+     - Checks if the Contact has a certain number of Points or a Group score.
    * - **Form field value**    
      - Checks if values submitted for a selected field on a selected Form matches specified criteria.
    * - **Has active notification**    

docs/channels/emails.rst

@@ -309,7 +309,7 @@ This is how it would be set up in Mautic's Email configuration:
 To replace the Sendgrid API key, add it to the relevant field in the Email configuration and save. Mautic now uses the Sendgrid API to send Emails. 
 
 .. warning::
-  It's a nice perk that Mautic can use any transport provided by Symfony Mailer. However, be aware that such transports (from Symfony) don't support batch sending, even via API. They only send one email per request, as opposed to a thousand emails per request as is the case with some Mautic transports, which can make them slow at scale. They also don't support transport callback handling used for bounce management. If you plan to send larger volumes of Emails or need to use features which require callback handling, please consider using Email transports built specifically for such use. These plugins are available in the :doc:`Mautic Marketplace </marketplace/marketplace.rst>`.
+  It's a nice perk that Mautic can use any transport provided by Symfony Mailer. However, be aware that such transports (from Symfony) don't support batch sending, even via API. They only send one email per request, as opposed to a thousand emails per request as is the case with some Mautic transports, which can make them slow at scale. They also don't support transport callback handling used for bounce management. If you plan to send larger volumes of Emails or need to use features which require callback handling, please consider using Email transports built specifically for such use. These plugins are available in the :doc:`Mautic Marketplace <marketplace/marketplace.rst>`.
 
 The system can either send Emails immediately or queue them for processing in batches by a :doc:`cron job </configuration/cron_jobs>`.
 

docs/components/assets.rst

@@ -137,5 +137,24 @@ It's possible to delete an Asset by clicking on the 'delete' button while viewin
 
 .. warning:: 
     Once deleted, you can't retrieve an Asset, and statistics relating to the number of downloads for that Asset are no longer be available. Contact Points accumulated as a result of accessing the resource remain. It's recommended where possible to unpublish Assets which are no longer in use - in future there may be an archive feature.
-
 
+Display Assets directly in the browser
+============================
+
+By default, Mautic supports the following file types for direct display in the browser:
+
+.. vale off
+
+- gif
+- jpg
+- jpeg
+- mpg
+- mpeg
+- mp3
+- pdf
+- png
+- wav
+
+.. vale on
+
+If you want to change this default behavior, you can modify the ``local.php`` file and set an array of extensions for the ``streamed_extensions`` parameter.

docs/configuration/command_line_interface.rst

@@ -106,10 +106,13 @@ These are the commands you may need to use in relation to your Mautic instance.
      - 
    * - ``mautic:custom-field:create-column``
      - Creates the actual column in the table
+     - 
    * - ``mautic:email:fetch``
      - Fetch and process monitored Email.
-   * - messenger:consume email_transport
+     - 
+   * - ``messenger:consume email``
      - Processes mail queue
+     - 
    * - ``mautic:import``
      - If the CSV import is configured to run in background then this command will pick up the pending import jobs and imports the data from CSV files to Mautic.
      - 

docs/configuration/cron_jobs.rst

@@ -85,6 +85,19 @@ You can also limit the number of Contacts to process per script execution using
 
     that these messages are only added to the queue when frequency rules apply either system wide or per Contact.
 
+.. vale off
+
+Custom Field cron jobs
+=======================
+
+.. vale on
+
+**To keep Contacts and Company Custom Fields updated**
+
+.. code-block:: php
+
+    php /path/to/mautic/bin/console mautic:custom-field:create-column
+
 Optional
 ********
 
@@ -101,7 +114,7 @@ If the system configuration is queueing Emails, a cron job processes them.
 
 .. code-block:: php
 
-    php /path/to/mautic/bin/console messenger:consume email_transport
+    php /path/to/mautic/bin/console messenger:consume email
 
 .. vale off