From e83b00674fe063f3b2ffc480273432643f265b23 Mon Sep 17 00:00:00 2001 From: typonaut <55769287+typonaut@users.noreply.github.com> Date: Thu, 8 Oct 2020 03:18:50 +0100 Subject: [PATCH] Update configuration.rst Adds documentation as to the function of "E-Mail Check Interval" and its interaction with a crontab. --- docs/configuration.rst | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index d3613f23..d1f4b63e 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -1,12 +1,12 @@ Configuration ============= + **IMPORTANT NOTE**: Any tickets created via POP3 or IMAP mailboxes will DELETE the original e-mail from the mail server. + Before django-helpdesk will be much use, you need to do some basic configuration. Most of this is done via the Django admin screens. 1. Visit ``http://yoursite/admin/`` and add a Helpdesk Queue. If you wish, enter your POP3 or IMAP server details. - **IMPORTANT NOTE**: Any tickets created via POP3 or IMAP mailboxes will DELETE the original e-mail from the mail server. - 2. Visit ``http://yoursite/helpdesk/`` (or whatever path as defined in your ``urls.py``) 3. If you wish to automatically create tickets from the contents of an e-mail inbox, set up a cronjob to run the management command on a regular basis. @@ -17,8 +17,6 @@ Before django-helpdesk will be much use, you need to do some basic configuration This will run the e-mail import every 5 minutes - **IMPORTANT NOTE**: Any tickets created via POP3 or IMAP mailboxes will DELETE the original e-mail from the mail server. - You will need to create a support queue, and associated login/host values, in the Django admin interface, in order for mail to be picked-up from the mail server and placed in the tickets table of your database. The values in the settings file alone, will not create the necessary values to trigger the get_email function. 4. If you wish to automatically escalate tickets based on their age, set up a cronjob to run the escalation command on a regular basis:: @@ -44,3 +42,15 @@ Before django-helpdesk will be much use, you need to do some basic configuration 8. If you wish to use SOCKS4/5 proxy with Helpdesk Queue email operations, install PySocks manually. Please note that mixing both SOCKS and non-SOCKS email sources for different queues is only supported under Python 2; on Python 3, SOCKS proxy support is all-or-nothing: either all queue email sources must use SOCKS or none may use it. If you need this functionality on Python 3 please `let us know `_. You're now up and running! Happy ticketing. + +Queue settings via admin interface +---------------------------------- +E-Mail Check Interval +^^^^^^^^^^^^^^^^^^^^^ +This setting does not trigger e-mail collection, it merely throttles it. In order to trigger e-mail collection you must run a crontab to trigger ``manage.py get_email``. The setting in *E-Mail Check Interval* prevents your crontab from running the e-mail trigger more often than the interval set. + +For example, setting *E-Mail Check Interval* to ``5`` will limit the collection of e-mail to once every five minutes, even if your crontab is firing every five seconds. If your cron job is set to fire once every hour, then e-mail will only be collected once every hour. + +The cron job triggers the collection of e-mail, *E-Mail Check Interval* restricts how often the trigger is effective. + +To remove this limit, set *E-Mail Check Interval* to ``0``.