Merge pull request #298 from RCheesley/scheduled-export-cron

Add docs for scheduled export of contacts

docs/configuration/command_line_interface.rst

@@ -103,7 +103,10 @@ These are the commands you may need to use in relation to your Mautic instance.
      - 
    * - ``mautic:contacts:deduplicate``
      - Merge Contacts based on same unique identifiers
-     - 
+
+  * - ``mautic:contacts:scheduled_export``
+     - Processes exports of Contacts to a CSV file and sends the results via Email.
+     -
    * - ``mautic:custom-field:create-column``
      - Creates the actual column in the table
      - 

docs/configuration/cron_jobs.rst

@@ -157,6 +157,21 @@ To import an especially large number of Contacts or Companies in the background,
 
 The time taken for this command to execute depends on the number of Contacts in the CSV file. However, on successful completion of the import operation, a notification appears on the Mautic dashboard.
 
+.. vale off
+
+Export Contacts cron job
+========================
+
+.. vale on
+
+To export Contacts to CSV - sending the results via Email - use the following command:
+
+.. code-block:: bash
+
+    php /path/to/mautic/bin/console mautic:contacts:scheduled_export
+
+The time taken for this command to execute depends on the number of Contacts in the CSV file. However, on successful completion of the export operation, Mautic sends an email with the link to download the CSV.
+
 Webhooks cron job
 =================
 

docs/configuration/settings.rst

@@ -319,12 +319,12 @@ See :ref:`here<contact's unsubscribe email preferences>` to set the Contact's Em
 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.
+
 .. image:: images/default-frequency-rule.png
   :width: 600
   :alt: Screenshot showing Default Frequency Rule Configuration in Mautic
 
-* **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>`.
@@ -452,7 +452,16 @@ Import settings
   :alt: Screenshot showing Import Settings Configuration in Mautic
 
 * **Automatically import in the background if the CSV has more rows than defined** - If there are more than the specified number of rows in an import file, the CSV automatically sets to import in the background which requires a :ref:`cron job<import contacts cron job>` to trigger. Set to 0 if you want to always import files in the background recommended for performance optimization.
-
+
+Export settings
+===============
+
+.. image:: images/export-settings.png
+  :width: 600
+  :alt: Screenshot showing Export Settings Configuration in Mautic
+
+* **Automatically export Contacts to CSV in the background** - If set to Yes, Mautic processes CSV exports of Contacts in the background and Mautic sends an Email with a link to download the file when it's processed.
+
 Segment settings
 ****************