Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix vale issues 5.x #218

Merged
merged 48 commits into from
Feb 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
d67d260
Fix email.rst & remove Symfony Mailer - in config
RCheesley Nov 22, 2023
f08961b
Vale fixes for Settings
RCheesley Nov 22, 2023
4f4a29e
Fix focus items
RCheesley Nov 22, 2023
a711747
Fix UTM Tags
RCheesley Nov 22, 2023
1cce109
Fix marketing messages
RCheesley Nov 22, 2023
5a569b1
Fix how to install Mautic
RCheesley Nov 22, 2023
7c5d30e
Fix push notifications
RCheesley Nov 22, 2023
5853f5f
Fix social monitoring
RCheesley Nov 22, 2023
fc85649
Fix web notifications
RCheesley Nov 22, 2023
fc8d987
Fix SMS
RCheesley Nov 22, 2023
13abd26
Fix segments
RCheesley Nov 22, 2023
e363fc9
Fix reports
RCheesley Nov 22, 2023
eb6212f
fix updating mautic page
RCheesley Nov 22, 2023
1241b59
fix switch to composer
RCheesley Nov 22, 2023
1c21fc8
fix companies
RCheesley Nov 22, 2023
423ce91
Campaigns
RCheesley Nov 22, 2023
efab588
Fix forms
RCheesley Nov 22, 2023
387c67d
Fix themes
RCheesley Nov 22, 2023
a5f7eef
fix categories
RCheesley Nov 22, 2023
9573126
Campaigns
RCheesley Nov 22, 2023
f4e6988
manage contacts
RCheesley Nov 22, 2023
4084017
Focus items
RCheesley Dec 22, 2023
0ad6ebd
SMS
RCheesley Dec 22, 2023
b741efd
Authentication
RCheesley Dec 22, 2023
cc73152
Forms
RCheesley Dec 22, 2023
3d34d01
Contacts
RCheesley Dec 22, 2023
53a60a3
Points - MQLs
RCheesley Dec 22, 2023
5f1f6ba
Point groups
RCheesley Dec 22, 2023
b6f3381
Assets
RCheesley Dec 22, 2023
6b39351
Points troubleshooting
RCheesley Dec 22, 2023
2e30cd6
Dashboard
RCheesley Dec 22, 2023
0ded084
Dynamic Content
RCheesley Dec 22, 2023
2aa95a0
Marketplace
RCheesley Dec 22, 2023
c5c97bd
landing pages
RCheesley Dec 22, 2023
ac053d1
Search operators
RCheesley Dec 22, 2023
0980831
Roles
RCheesley Dec 22, 2023
ec912bd
Contacts overview
RCheesley Dec 22, 2023
ebede17
Import contacts
RCheesley Dec 22, 2023
8b07dd1
Custom fields
RCheesley Dec 22, 2023
8d5cd08
Twilio
RCheesley Dec 22, 2023
cf2c8de
Cron jobs
RCheesley Dec 22, 2023
b89fbdc
iContact
RCheesley Dec 22, 2023
7637363
Mailchimp
RCheesley Dec 22, 2023
5df2625
Creating themes
RCheesley Dec 22, 2023
eaeee51
Fix typo
RCheesley Dec 22, 2023
f2c7d38
Merge branch '5.x' into fix-vale-issues-5.x
RCheesley Jan 9, 2024
77e6c29
Fix incorrect Vale warnings
RCheesley Jan 9, 2024
f2a0548
Merge branch '5.x' into fix-vale-issues-5.x
RCheesley Feb 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/styles/Mautic/FeatureList.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ swap:
point actions: Point Actions
point triggers: Point Triggers
points: Points
group: Group
groups: Groups
point group: Point Group
point groups: Point Groups
plugin: Plugin
plugins: Plugins
report: Report
Expand Down
12 changes: 12 additions & 0 deletions .github/styles/Vocab/Mautic/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Autoloader
autoloader
Autowired
autowired
Azure
bcc
Beanstalkd
Bing
Expand All @@ -18,6 +19,7 @@ CCPA
Citrix
Clearbit
CloudAMQP
CMS
config
Company(ies)
Composer
Expand All @@ -26,6 +28,7 @@ ConnectWise
Contribution(s)
CORS
cPanel
CRM
cron
Cron
CTRL
Expand All @@ -34,6 +37,7 @@ DDEV
Do Not Contact
DNC
Dripflow
DSN
Dynamic Web Content
FALSE
Focus Item
Expand All @@ -42,6 +46,7 @@ Froala
Froogaloop
FTP
gcm
GDPR
GIF
GitBook
GitHub
Expand All @@ -55,23 +60,28 @@ HTML
http
https
HubSpot
iContact
IDP
IIS
IMAP
IPs
infographics
JavaScript
Joomla
Joomla!
Libre
Licensor
LinkedIn
MailChimp
Mailjet
Marketing Messages
Mautic
MaxMind
Middlewares
middlewares
MJML
MQL
MQLs
Multiselect
multiselect
MVP
Expand All @@ -94,6 +104,7 @@ post
PUT
Rackspace
Remarketing
REST
Salesforce
SAML
Schimpf
Expand All @@ -111,6 +122,7 @@ sublicense
SugarCRM
Suhosin
Symfony
TLS
Todo
Transifex
TRUE
Expand Down
4 changes: 2 additions & 2 deletions docs/authentication/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ The IDP may ask for the following settings:

#. Custom attributes - Mautic requires three custom attributes in the IDP responses for the User Email, first name and last name. Username is also supported but is optional. Configure the attribute names used by the IDP in Mautic's Configuration > User/Authentication Settings under the 'Enter the names of the attributes the configured IDP uses for the following Mautic User fields' section.

Example: Azure SAML SSO
=======================
Example - Azure SAML SSO
========================

1) Register new Enterprise applications by navigating to ``Create your own Application`` and then ``Integrate any other application you don't find in the gallery (Non-gallery)``
2) Go to Single Sign-On
Expand Down
10 changes: 3 additions & 7 deletions docs/builders/creating_themes.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
.. vale off

Creating Themes
###############

.. vale on

:xref:`MJML` allows marketers to create and maintain beautiful and responsive Themes for Mautic easily.

.. vale off
Expand Down Expand Up @@ -127,16 +123,16 @@ File structure
Steps to save the Theme package
===============================

Once your design in MJML is finalized, go through the following steps to create the Theme package:
Once you have finalized your design in MJML, go through the following steps to create the Theme package:

* Save your images in the Assets folder.

* Save your MJML in the ``html`` folder as ``email.mjml.twig`` AND ``email.html.twig``.
* Save your MJML in the ``html`` folder as ``email.mjml.twig`` **and** ``email.html.twig``.

* Use the ``base.html.twig`` and ``message.html.twig`` files from the basic Theme or make your changes there.

* Save your ``config.json`` as described previously

* Create a thumbnail - use the dimensions of 400px wide, 600px high.

* Compress the contents of the folder as a Zip file - ensure that the files and folders aren't within a sub-folder in the Zip file.
* Compress the contents of the folder as a Zip file - ensure that the files and folders aren't within a sub-folder in the Zip file.
6 changes: 3 additions & 3 deletions docs/campaigns/campaign_builder.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,16 +198,16 @@ Here are the different conditions that Mautic offers in the Campaign Builder:
* - **Contact device**
- Checks if the Contact has interacted with your Campaign from a specific device type, brand, or OS.
* - **Contact field value**
- Checks if the information matches the selected criteria on the Contact record, the Contacts primary Company, or UTM tags.
- Checks if the information matches the selected criteria on the Contact record, the Contact's primary Company, or UTM tags.
* - **Contact owner**
- Checks if the selected User is the Contact's owner.
* - **Contact Segments**
- Checks if the Contact is a member of selected Segments.
* - **Contact Tags**
- Checks if specified Tags are on the Contact record.
* - **Contact points**
* - **Contact Points**
- Checks if the Contact has a certain number of Points or a Group score.
* - **Form field value**
* - **Form Field value**
- Checks if values submitted for a selected field on a selected Form matches specified criteria.
* - **Has active notification**
- Checks if the Contact has an active web notification.
Expand Down
6 changes: 3 additions & 3 deletions docs/campaigns/creating_campaigns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ following set up:

#. Create a Contact Segment or a Form to initialize your Campaign. If you already have an existing Segment or Form to use, ensure that they're up-to-date.

#. Create any custom field that you need for your Contact profile.
#. Create any Custom Field that you need for your Contact profile.
#. Set up and configure any Integration that you intend to use in your Campaign.
#. Set up appropriate Channels such as Text Messages, Email, Focus items to communicate with your Contacts.
#. Create Assets, Landing pages, or other Components that you want to use for your Campaign. If using Assets, ensure that you upload them before creating your Campaign.
#. Set up appropriate Channels such as Text Messages, Email, Focus Items to communicate with your Contacts.
#. Create Assets, Landing Pages, or other Components that you want to use for your Campaign. If using Assets, ensure that you upload them before creating your Campaign.

Although you can set up Channels and create Components during the process of creating the Campaign, it's ideal to have them ready beforehand as it makes the Campaign building process faster and more efficient.

Expand Down
4 changes: 2 additions & 2 deletions docs/categories/categories-overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ Using Categories for Contacts

.. vale on

In addition to organizing various Mautic elements Categories can be used to organize Contacts. In Contact details use the Preference menu to open Contact Preference Center.
In addition to organizing various Mautic elements Categories can help you organize Contacts. In Contact details use the Preference menu to open Contact Preference Center.

.. image:: images/assign-category-to-contact.jpeg
:width: 600
:alt: Screenshot of assigning Category to Contact

Contact Categories can be used in Segment and dynamic content filters.
Mautic allows the assignment of Contact Categories in Segment and Dynamic Content filters.

111 changes: 2 additions & 109 deletions docs/channels/emails.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Template Emails

.. vale on

Template Emails are transactional by default. They're used in Campaigns, Form submit actions, Point triggers, etc. It's possible to send template Emails to the same Contact multiple times. You can't send template Emails to a Contact outside of another Mautic Component except when sending an Email directly to a Contact - in this case Mautic clones the content.
Template Emails are transactional by default. They're used in Campaigns, Form submit actions, Point Triggers, etc. It's possible to send template Emails to the same Contact multiple times. You can't send template Emails to a Contact outside of another Mautic Component except when sending an Email directly to a Contact - in this case Mautic clones the content.

.. note::
For this reason, template Emails sent directly to a Contact aren't associated with the template Email itself and thus stats aren't tracked against it.
Expand Down Expand Up @@ -222,113 +222,6 @@ Using the Email signature

Marketers can place the signature into an Email using the ``{signature}`` token.

Email delivery
##############

As Mautic uses the :xref:`Symfony Mailer` library since v5, it supports all Symfony Mailer core plugins out of the box. Transports for other Email services might be found on GitHub or Packagist.

SMTP transport
**************

The SMTP transport is the default transport used for sending Emails with Mautic. It's configured in the Mautic configuration under the Email Settings tab. The configuration is the same as in the :xref:`Symfony Mailer` documentation.

Mautic now uses a specific way of providing the connection details for Email transports to interpret, which is called a Data Source Name, or DSN. This is the example Data Source Name configuration mentioned in the :xref:`Symfony Mailer` documentation for SMTP:

.. code-block:: shell

smtp://user:[email protected]:port

Mautic creates this automatically from the values entered in the Email configuration:

.. image:: images/emails/smtp-dsn.png
:width: 400
:alt: SMTP API DSN example

.. list-table:: Example DSN ``smtp://user:[email protected]:port/path?option1=value1&option2=value2`` explained
:widths: 10 20 150
:header-rows: 1
:stub-columns: 1

* - DSN part
- Example
- Explanation
* - Scheme
- smtp
- Defines which email transport (plugin) will handle the email sending. It also defines which other DSN parts must be present.
* - User
- john
- Some transport wants username and password to authenticate the connection. Some public or private key. Some just API key.
* - Password
- pa$$word
- As mentioned above, read documentation for your particular transport and fill in the fields that are required. For SMPT this is for password.
* - Host
- smtp.mydomain.com
- For SMTP this is the domain name where your SMTP server is running. Other transports may have the domain handled inside it so many wants to put just ``default`` text here.
* - Path
- any/path
- This is usually empty. For SMTP this may be the path to the SMTP server. For other transports this may be the path to the API endpoint.
* - Port
- 465
- Important for SMTP. The port value defines which encryption is used. This is usually 465 for SSL or 587 for TLS. Avoid using port 25 for security reasons. For other transports this may be the port to the API endpoint.
* - Options
- timeout=10
- This is optional. This may be the timeout for the connection or similar configuration. The config form will allow you to create multiple options.

.. note::
Use the Mautic's global configuration to paste in the DSN information, especially the API keys and passwords. The values must be URL-encoded, and the configuration form does that for you. If you are pasting DSN settings directly into the config/local.php file, you must URL-encode the values yourself.


.. vale off

Example API transport installation

.. vale on

**********************************
.. warning::
Installing Symfony Transports is possible when you've :doc:`installed Mautic via Composer </getting_started/how_to_install_mautic.rst>`.

If you want to use :xref:`Sendgrid` API instead of SMTP to send Emails, for example, you can install the official Symfony Sendgrid Transport by running the following command that is mentioned along others in the :xref:`Symfony Mailer` documentation.

.. code-block:: shell

composer require symfony/sendgrid-mailer

After that, you can configure the transport in the Mautic configuration. The example DSN is again mentioned in the :xref:`Symfony Mailer` documentation along with other transports. In the example of using the Sendgrid API, the DSN looks like this:

.. code-block:: shell

sendgrid+api://KEY@default

This is how it would be set up in Mautic's Email configuration:

.. image:: images/emails/sendgrid-api-dsn.png
:width: 400
:alt: Sendgrid API DSN example

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>`.

The system can either send Emails immediately or queue them for processing in batches by a :doc:`cron job </configuration/cron_jobs>`.

Immediate delivery
******************

This is the default means of delivery. As soon as an action in Mautic triggers an Email to send, it's sent immediately. If you expect to send a large number of Emails, you should use the queue. Sending Email immediately may slow the response time of Mautic if using a remote mail service, since Mautic has to establish a connection with that service before sending the mail. Also attempting to send large batches of Emails at once may hit your server's resource limits or Email sending limits if on a shared host.

Queued delivery
***************

Mautic works most effectively with high send volumes if you use the queued delivery method. Mautic stores the Email in the configured spool directory until the execution of the command to process the queue. Set up a :doc:`cron job </configuration/cron_jobs>` at the desired interval to run the command:

.. code-block:: shell

php /path/to/mautic/bin/console messenger:consume email_transport

Some hosts may have limits on the number of Emails sent during a specified time frame and/or limit the execution time of a script. If that's the case for you, or if you just want to moderate batch processing, you can configure batch numbers and time limits in Mautic's Configuration. See the :doc:`cron job documentation </configuration/cron_jobs>` for more specifics.

.. vale off

Tracking Opened Emails
Expand Down Expand Up @@ -418,7 +311,7 @@ If you select an Unsubscribe folder, Mautic also appends the Email as part of th
Webhook bounce management
*************************

Since Mautic 5 all the Email transports use the same Webhook (sometimes called callback) URL: ``https://mautic.example.com/mailer/callback``. Please follow the documentation for the specific Email transport you've installed to get more information about the Webhook configuration.
Since Mautic 5 all the Email transports use the same Webhook - sometimes called callback - URL: ``https://mautic.example.com/mailer/callback``. Please follow the documentation for the specific Email transport you've installed to get more information about the Webhook configuration.


.. vale off
Expand Down
16 changes: 8 additions & 8 deletions docs/channels/focus_items.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Focus Items
###########

Focus items allow you to engage Users on your site through bars, modals, notifications, popups, and light boxes. It's possible to initiate Focus Items at different times and with different actions such as exit intent.
Focus Items allow you to engage Users on your site through bars, modals, notifications, popups, and light boxes. It's possible to initiate Focus Items at different times and with different actions such as exit intent.

You can find Focus Items listed under the Channels menu.

Expand Down Expand Up @@ -93,7 +93,7 @@ Visitors can choose to close this type of Focus Item with the *X* button in the
Full page
~~~~~~~~~

The full page Focus Item completely takes over the whole page, hiding the rest of the page content until the visitor clicks the *X* button in the top right hand corner of the Focus Item.
The full page Focus Item completely takes over the whole page, hiding the page content until the visitor clicks the *X* button in the top right hand corner of the Focus Item.

There are no additional configuration options for this style of Focus Item.

Expand Down Expand Up @@ -127,7 +127,7 @@ This editor mode allows a simplified experience with a few fields - depending on
- **Select the Form to insert** - This option is only available for Collect Data Focus Item types. It allows you to select an existing Mautic Form to use with the Focus Item. For styling and formatting reasons, you may want to create a Form specifically for the Focus Item, adding styling attributes to the Attributes tab on the Form fields.
- **Link text** - This option is only available for Emphasize a Link Focus Item types. It allows you to specify the text used on the Focus Item's button.
- **Link URL** - This option is only available for Emphasize a Link Focus Item types. It allows you to specify the URL where you'd like to drive visitors with the Focus Item.
- **Open in a new window** - This option is only available for Emphasize a Link Focus Item types. If set to Yes, this ensures that the link is opened in a new window. If set to No, the link opens in the current tab.
- **Open in a new window** - This option is only available for Emphasize a Link Focus Item types. If set to Yes, this ensures that the link opens in a new window. If set to No, the link opens in the current tab.

Editor
~~~~~~
Expand Down Expand Up @@ -167,7 +167,7 @@ When creating a new Focus Item, you can set the following fields:

.. vale on

**Google Analytics UTM tags** - Mautic supports UTM tagging in Emails, Focus Items, and Landing Pages. Any UTM tags with values populated are automatically appended to the end of any links used in the focus item. See :doc:`/channels/utm_tags` for more information.
**Google Analytics UTM tags** - Mautic supports UTM tagging in Emails, Focus Items, and Landing Pages. Any UTM tags with values populated are automatically appended to the end of any links used in the Focus Item. See :doc:`/channels/utm_tags` for more information.

.. image:: images/focus_items/focus_item_create.png
:width: 400
Expand All @@ -180,7 +180,7 @@ Using the Focus Item builder

.. vale on

After you specify the general information for the Focus Item, click the builder option in the top right corner. If you've specified a URL in the Website field on the details page, the system displays a preview. If you don't see a preview, the website might block iframe previews. Hence, you may need to add the focus item to a development or staging environment without these security restrictions - if available - to see the preview.
After you specify the general information for the Focus Item, click the builder option in the top right corner. If you've specified a URL in the Website field on the details page, the system displays a preview. If you don't see a preview, the website might block iframe previews. Hence, you may need to add the Focus Item to a development or staging environment without these security restrictions - if available - to see the preview.

.. note::
The preview of the website doesn't appear until you select a style from the options on the Focus Item Builder.
Expand All @@ -203,11 +203,11 @@ Once you have created your Focus Item, you're ready to publish it to your websit
Deploying to a website
======================

When you save the Focus Item, the code snippet required to display it on your website is shown in a green box on the Focus Item overview.
When you save the Focus Item, Mautic shows the code snippet required to display it on your website in a green box on the Focus Item overview.

.. image:: images/focus_items/focus_item_embed.png
:width: 400
:alt: Screenshot showing the Focus Item code to be embedded within a website.
:alt: Screenshot showing the Focus Item code to embed within a website.

.. note::
You may need assistance from your web development team to implement the Focus Item tracking code on your website.
Expand All @@ -233,6 +233,6 @@ Measuring success

When using the Emphasize a Link type, Mautic displays the link on the Focus Item overview where you can view the number of unique clicks.

If you change the link in a Focus Item after deployment, all links are listed in the overview.
If you change the link in a Focus Item after deployment, Mautic lists all links in the overview.

Additionally, Mautic applies UTM tags on Focus Items to both Form submissions and link clicks. If you are using a Focus Item to submit a Form, it's recommended that you have a Submit Action on the Form to record the UTM tags.
Loading
Loading