.. ==================================================
.. Header hierarchy
.. ==
..  --
..   ^^
..    ""
..     ;;
..      ,,
..
.. --------------------------------------------used to the update the records specified ------
.. Best Practice T3 reST: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/CheatSheet.html
..             Reference: https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/WritingReST/Index.html
.. Italic *italic*
.. Bold **bold**
.. Code ``text``
.. External Links:          `Bootstrap <http://getbootstrap.com/>`__
.. Internal Link:           :ref:`downloadButton` (default url text) or :ref:`Download Button<downloadButton>` (explicit url text)
.. Anker for internal link: .. _`download`:
.. Add Image:               .. image:: ./Images/a4.jpg
..
.. Add image with caption:   .. figure:: ./Images/black_dot.png
..                              :class: with-border
..                              :width: 20px
.. Add Attachment (place in Documentation/_static):  `Download CSV <_static/yourfile.csv>`__
..
.. Admonitions
..           .. note::   .. important::     .. tip::     .. warning::
.. Color:   (blue)       (orange)           (green)      (red)
..
.. Definition:
.. some text becomes strong (only one line)
..      description has to indented
..
.. Code Block: .. code-block:: sql
..

.. -*- coding: utf-8 -*- with BOM.

.. include:: Includes.txt


.. _emailSync:

Email Sync
==========

Configuration
-------------

Preparation
^^^^^^^^^^^

* Keep sure table Setting is up to date.

Create a new Typo3 page for IMAP configuration and add a tt-content with following content::
  file=_emailSync

Use this page to manage all your IMAP accounts and folders.

QFQ Config
^^^^^^^^^^

* Extension > QFQ > Debug

  * imapLogMode: debug, verbose, error, none
  * imapLog: fileadmin/protected/qfqProject/log/imap.log

Running
^^^^^^^

The php script `typo3conf/ext/qfq/Classes/External/email-sync.php` will sync all mails from specified accounts and folders
to table `EmailSync`::

    email-sync.php sync|listAllFolder|listAllFolderMail

Mode:

* sync: all mails from configured accounts & folders (via IMAP ) will be copied
  to table `EmailSync`.

  * If the specified folder does not exist, report all folder to imap.log.

* listAllFolder: for every configured account list all folders.
* listAllFolderMail: for every configured account list all folders with their emails.