Move to top and rename to transport

mautic · Aug 8, 2023 · c7b70cf · c7b70cf
1 parent 0f75b52
commit c7b70cf
Showing 1 changed file with 104 additions and 102 deletions.
diff --git a/docs/configuration/settings.rst b/docs/configuration/settings.rst
@@ -161,105 +161,9 @@ Campaign settings
 Email settings
 **************
 
-Mail send settings
-==================
-
-.. image:: images/mail-send-settings.png
-  :width: 600
-  :alt: Screenshot showing Mail Send Settings Configuration in Mautic
-
-* **Name to send mail as** - The default name Emails come from. This is typically something like ``{YourCompany Marketing Team}`` or ``{YourCompany}``.
-
-* **Email address to send mail from** - The Email address for the name you're sending mail from. The address displays in the ``From:`` field when your Contacts receive your Emails.
-
-.. note::
-
-  Ensure that you configure your sender domain, ``DKIM``, bounce, and click tracking domains. For more information, see the :ref:`Email<emails>` documentation.
-
-* **Reply to address** -  To have Contacts reply to a different address than the specified From address, add the desired address here. This is the default ``reply-to`` address where messages are sent from Mautic unless it is overridden in an individual Email. If this field is blank, the address specified in **Email address to send mail** from is used. The ``reply-to`` setting is useful if your configured sender domain - which you use in the from address - contains a subdomain that doesn't have MX records or is otherwise an address that can't receive Emails.
-
-* **Custom return path (bounce) address** - Set a custom return path/bounce Email address for Emails sent from the system. Note that some mail transports, such as GMail, won't support this.
-
-* **Mailer is owner** - If Contacts in Mautic have owners, select Yes to use the Contact owner as the sender of Emails to any Contacts they're listed as the owner for. 
-
-.. note:: 
-
-    Mailer is owner overrides any other name or Email to send mail from, including the default and individual Emails. Every Contact owner's domain must have ``SPF`` and ``DKIM`` records. You can see this configuration for individual Emails, rather than globally.
-    For more information see :doc:`Mailer is owner</channels/emails>`
-
-* **Service to send mail through** - Select the Email service provider you use, and enter your credentials. 
-
-Default frequency rule
-======================
-
-* **Do not contact more than <number> each <period>** - This limits the number of Marketing Messages a Contact receives in a certain period of time day, week, month. Transactional messages don't count towards this limit. You can adjust this at the individual Contact level, either manually or by Preference Center setting. 
-
-.. note:: 
-
-  More information is available in the :doc:`Default Frequency Rule documentation</contacts/frequency_rules>`.
-
-Monitored inbox settings
+Email transport settings
 ========================
 
-.. image:: images/monitored-settings.png
-  :width: 600
-  :alt: Screenshot showing Monitored Settings Configuration in Mautic
-
-* **Default Mailbox** - If your messages are going to bounce, this inbox is where you receive those bounce notifications.
-
-* **Bounces** - A folder to monitor for new bounce messages or Emails.
-
-* **Unsubscribe Requests** - A folder to monitor for new unsubscribe requests. 
-
-* **Contact Replies** - Similar to the monitored inbox for bounces, this is the inbox Mautic checks for Contact replies. Using :ref:`Replies to Email<email settings>` decisions in any Campaign requires configuration. With ``Use custom connection settings?`` set to ``no``, Mautic checks the default mailbox. If set to ``yes``, you may track a different mailbox for replies.
-
-Message settings
-================
-
-.. image:: images/message-settings.png
-  :width: 600
-  :alt: Screenshot showing Message Settings Configuration in Mautic
-
-* **Text for the** ``{webview_text``} **token** - The message indicating the reader can view the Email in their browser. The default is; ``Having trouble reading this Email? Click here``.
-
-  To change the text, change the message between the ``<a href="|URL|">`` and ``</a>`` tags. Don't change the ``|URL|`` text, because that's a token, which creates a unique URL for each Contact.
-
-* **Default Email signature** - The signature for your default Emails, which pairs with the name & Email address in the **Mail Send** settings.
-
-* **Append tracking pixel into Email body?** - To track Email opens, select **Yes**. Select **No** to prevent tracking, reporting on, and using decisions based on Email opens.
-
-* **Convert embed images to Base64** - Select **Yes** to display embedded images in Emails using embedded base64 code rather than as embedded images.
-
-* **Disable trackable URLs** - Removes tracking from URLs in your Emails. Select Yes to prevent tracking, reporting on, and using decisions based on link clicks. Some Email service providers don't like redirecting URLs. Using trackable URLs in your Emails may impact deliverability.
-
-Unsubscribe settings
-====================
-
-.. image:: images/unsubscribe-settings.png
-  :width: 600
-  :alt: Screenshot showing Unsubscribe Settings Configuration in Mautic
-
-* **Text for the {unsubscribe_text} token** -  Like the ``{webview_text}`` token,  this allows you to customize the **Unsubscribe** link. 
-
-  For example - Edit between the ``<a href="|URL|">`` and ``</a>`` tags. Don't change the URL as it's tokenized. If you add ``{unsubscribe_url}`` as a token in the Email, you won't see this text.
-
-* **Unsubscribed and resubscribed confirmation message** - If a Contact unsubscribes or resubscribes, this message displays on the page after the respective action. Don't edit the ``|EMAIL|`` or the ``|URL|`` token in the ``<a href>`` tag.
-
-* **Show Contact preference settings** - Select **Yes** to direct the unsubscribe link to your configured Preference enter. If you haven't created a Preference Center, Mautic creates a default page based on the next 5 settings. The created page uses the default Theme for styling.
-
-* **Show Contact Segment preferences** - Select **Yes** to allow a Contact to change which Segments they're part of on the Preference Center page. Segments won't display on the Preference Center page if they aren't published and public.
-
-* **Show Contact frequency preferences** - Select **Yes** to allow an individual to limit the number of Marketing Messages they receive on each Channel from the Preference Center.
-
-* **Show pause Contact preferences** - Select **Yes** to allow Contacts to turn-off messages from your Mautic account to their Email address for a specified date range. This action isn't a full unsubscribe action, and at the end of the date range, In this case, it sends the message again after the date range ends, as this isn't a full unsubscribe action.
-
-* **Show Contact's Categories** - If you have Categories set for Contacts, Campaigns, Emails, etc., select Yes to allow the Contact to opt out of the Categories they choose from the Preference Center page.
-
-* **Show Contact's preferred Channel option** - If you have multiple Channels available within your Mautic instance. For example; Email, ``SMS``, mobile push, web notifications, etc., Contacts can choose their preferred Channel. This can be useful if you are using the Marketing Messages feature of Mautic. More information about the Preference Center is available :doc:`here</contacts/preference_center>`.
-
-Email delivery settings
-=======================
-
 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
@@ -275,7 +179,7 @@ Mautic now uses a specific way of providing the connection details for Email tra
 
 Mautic creates this automatically from the values entered in the Email configuration:
 
-.. image:: images/emails/smtp-dsn.png
+.. image:: images/smtp-dsn.png
     :width: 400
     :alt: SMTP API DSN example
 
@@ -337,7 +241,7 @@ After that, you can configure the transport in the Mautic configuration. The exa
 
 This is how it would be set up in Mautic's Email configuration:
 
-  .. image:: images/emails/sendgrid-api-dsn.png
+  .. image:: images/sendgrid-api-dsn.png
     :width: 400
     :alt: Sendgrid API DSN example
 
@@ -349,12 +253,12 @@ To replace the Sendgrid API key, add it to the relevant field in the Email confi
 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:
 
@@ -364,10 +268,108 @@ Mautic works most effectively with high send volumes if you use the queued deliv
 
 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.
 
+
+Mail send settings
+==================
+
+.. image:: images/mail-send-settings.png
+  :width: 600
+  :alt: Screenshot showing Mail Send Settings Configuration in Mautic
+
+* **Name to send mail as** - The default name Emails come from. This is typically something like ``{YourCompany Marketing Team}`` or ``{YourCompany}``.
+
+* **Email address to send mail from** - The Email address for the name you're sending mail from. The address displays in the ``From:`` field when your Contacts receive your Emails.
+
+.. note::
+
+  Ensure that you configure your sender domain, ``DKIM``, bounce, and click tracking domains. For more information, see the :ref:`Email<emails>` documentation.
+
+* **Reply to address** -  To have Contacts reply to a different address than the specified From address, add the desired address here. This is the default ``reply-to`` address where messages are sent from Mautic unless it is overridden in an individual Email. If this field is blank, the address specified in **Email address to send mail** from is used. The ``reply-to`` setting is useful if your configured sender domain - which you use in the from address - contains a subdomain that doesn't have MX records or is otherwise an address that can't receive Emails.
+
+* **Custom return path (bounce) address** - Set a custom return path/bounce Email address for Emails sent from the system. Note that some mail transports, such as GMail, won't support this.
+
+* **Mailer is owner** - If Contacts in Mautic have owners, select Yes to use the Contact owner as the sender of Emails to any Contacts they're listed as the owner for. 
+
+.. note:: 
+
+    Mailer is owner overrides any other name or Email to send mail from, including the default and individual Emails. Every Contact owner's domain must have ``SPF`` and ``DKIM`` records. You can see this configuration for individual Emails, rather than globally.
+    For more information see :doc:`Mailer is owner</channels/emails>`
+
+* **Service to send mail through** - Select the Email service provider you use, and enter your credentials. 
+
+Default frequency rule
+======================
+
+* **Do not contact more than <number> each <period>** - This limits the number of Marketing Messages a Contact receives in a certain period of time day, week, month. Transactional messages don't count towards this limit. You can adjust this at the individual Contact level, either manually or by Preference Center setting. 
+
+.. note:: 
+
+  More information is available in the :doc:`Default Frequency Rule documentation</contacts/frequency_rules>`.
+
+Monitored inbox settings
+========================
+
+.. image:: images/monitored-settings.png
+  :width: 600
+  :alt: Screenshot showing Monitored Settings Configuration in Mautic
+
+* **Default Mailbox** - If your messages are going to bounce, this inbox is where you receive those bounce notifications.
+
+* **Bounces** - A folder to monitor for new bounce messages or Emails.
+
+* **Unsubscribe Requests** - A folder to monitor for new unsubscribe requests. 
+
+* **Contact Replies** - Similar to the monitored inbox for bounces, this is the inbox Mautic checks for Contact replies. Using :ref:`Replies to Email<email settings>` decisions in any Campaign requires configuration. With ``Use custom connection settings?`` set to ``no``, Mautic checks the default mailbox. If set to ``yes``, you may track a different mailbox for replies.
+
+Message settings
+================
+
+.. image:: images/message-settings.png
+  :width: 600
+  :alt: Screenshot showing Message Settings Configuration in Mautic
+
+* **Text for the** ``{webview_text``} **token** - The message indicating the reader can view the Email in their browser. The default is; ``Having trouble reading this Email? Click here``.
+
+  To change the text, change the message between the ``<a href="|URL|">`` and ``</a>`` tags. Don't change the ``|URL|`` text, because that's a token, which creates a unique URL for each Contact.
+
+* **Default Email signature** - The signature for your default Emails, which pairs with the name & Email address in the **Mail Send** settings.
+
+* **Append tracking pixel into Email body?** - To track Email opens, select **Yes**. Select **No** to prevent tracking, reporting on, and using decisions based on Email opens.
+
+* **Convert embed images to Base64** - Select **Yes** to display embedded images in Emails using embedded base64 code rather than as embedded images.
+
+* **Disable trackable URLs** - Removes tracking from URLs in your Emails. Select Yes to prevent tracking, reporting on, and using decisions based on link clicks. Some Email service providers don't like redirecting URLs. Using trackable URLs in your Emails may impact deliverability.
+
+Unsubscribe settings
+====================
+
+.. image:: images/unsubscribe-settings.png
+  :width: 600
+  :alt: Screenshot showing Unsubscribe Settings Configuration in Mautic
+
+* **Text for the {unsubscribe_text} token** -  Like the ``{webview_text}`` token,  this allows you to customize the **Unsubscribe** link. 
+
+  For example - Edit between the ``<a href="|URL|">`` and ``</a>`` tags. Don't change the URL as it's tokenized. If you add ``{unsubscribe_url}`` as a token in the Email, you won't see this text.
+
+* **Unsubscribed and resubscribed confirmation message** - If a Contact unsubscribes or resubscribes, this message displays on the page after the respective action. Don't edit the ``|EMAIL|`` or the ``|URL|`` token in the ``<a href>`` tag.
+
+* **Show Contact preference settings** - Select **Yes** to direct the unsubscribe link to your configured Preference enter. If you haven't created a Preference Center, Mautic creates a default page based on the next 5 settings. The created page uses the default Theme for styling.
+
+* **Show Contact Segment preferences** - Select **Yes** to allow a Contact to change which Segments they're part of on the Preference Center page. Segments won't display on the Preference Center page if they aren't published and public.
+
+* **Show Contact frequency preferences** - Select **Yes** to allow an individual to limit the number of Marketing Messages they receive on each Channel from the Preference Center.
+
+* **Show pause Contact preferences** - Select **Yes** to allow Contacts to turn-off messages from your Mautic account to their Email address for a specified date range. This action isn't a full unsubscribe action, and at the end of the date range, In this case, it sends the message again after the date range ends, as this isn't a full unsubscribe action.
+
+* **Show Contact's Categories** - If you have Categories set for Contacts, Campaigns, Emails, etc., select Yes to allow the Contact to opt out of the Categories they choose from the Preference Center page.
+
+* **Show Contact's preferred Channel option** - If you have multiple Channels available within your Mautic instance. For example; Email, ``SMS``, mobile push, web notifications, etc., Contacts can choose their preferred Channel. This can be useful if you are using the Marketing Messages feature of Mautic. More information about the Preference Center is available :doc:`here</contacts/preference_center>`.
+
+
 .. vale off
 
 Tracking Opened Emails
-**********************
+======================
 
 .. vale on