Mercurial > p > roundup > code
changeset 7503:7b6278da3faa
Update roundup-mailgw install with other methods; formatting
reference admin_guide.html for alternate imap/pop methods (imap_oauth
or apop etc.)
Change example written intline into an exampe as line wrapping
distorts whitespace (space removed if line is wrapped) and needs to be
presented in a pre example section.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 21 Jun 2023 14:34:37 -0400 |
| parents | 5bac0a0afb7f |
| children | 1a912887d704 |
| files | doc/admin_guide.txt doc/installation.txt |
| diffstat | 2 files changed, 16 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/admin_guide.txt Tue Jun 20 00:53:39 2023 -0400 +++ b/doc/admin_guide.txt Wed Jun 21 14:34:37 2023 -0400 @@ -1210,11 +1210,10 @@ client id and the client secret need to be retrieved via cloud provider specific protocols or websites. - You need the requests_ library installed for OAuth. + You need the requests_ library installed to ue the IMAPS_OAUTH method. .. _requests: https://requests.readthedocs.io/en/latest/ - .. index:: ! roundup-admin single: roundup-admin; usage single: roundup-admin; data formats
--- a/doc/installation.txt Tue Jun 20 00:53:39 2023 -0400 +++ b/doc/installation.txt Wed Jun 21 14:34:37 2023 -0400 @@ -1532,6 +1532,10 @@ where pop_spec is "``username:password@server``" that specifies the roundup submission user's POP account name, password and server. +apop (authenticated) and pops (pop over ssl) methods are also +supported. See `the section on mailgw in the admin guide +<admin_guide.html#mail-gateway-script-command-line>`_. + On windows, you would set up the command `using the windows scheduler`_. As a regular job using an IMAP source @@ -1545,13 +1549,17 @@ where imap_spec is "``username:password@server``" that specifies the roundup submission user's IMAP account name, password and server. You may -optionally include a mailbox to use other than the default ``INBOX`` with -"``imap username:password@server mailbox``". - -If you have a secure (ie. HTTPS) IMAP server then you may use ``imaps`` -in place of ``imap`` in the command to use a secure connection. - -As with the POP job, on windows, you would set up the command +optionally include a mailbox to use other than the default ``INBOX`` with:: + + imap username:password@server mailbox + +If you have a secure (ie. HTTPS) IMAP server then you may use +``imaps`` in place of ``imap`` in the command to use a securnae +connection. To use imap with CRAM or OAUTH, see `the section on +mailgw in the admin guide +<admin_guide.html#mail-gateway-script-command-line>`_ . + +As with the POP job, on windows, you would set up the command `using the windows scheduler`_.