Skip to content

Commit d272f4d

Browse files
committed
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.
1 parent 8b24510 commit d272f4d

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

doc/admin_guide.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1210,11 +1210,10 @@ IMAPS_OAUTH:
12101210
client id and the client secret need to be retrieved via cloud provider
12111211
specific protocols or websites.
12121212

1213-
You need the requests_ library installed for OAuth.
1213+
You need the requests_ library installed to ue the IMAPS_OAUTH method.
12141214

12151215
.. _requests: https://requests.readthedocs.io/en/latest/
12161216

1217-
12181217
.. index:: ! roundup-admin
12191218
single: roundup-admin; usage
12201219
single: roundup-admin; data formats

doc/installation.txt

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1532,6 +1532,10 @@ installed)::
15321532
where pop_spec is "``username:password@server``" that specifies the roundup
15331533
submission user's POP account name, password and server.
15341534

1535+
apop (authenticated) and pops (pop over ssl) methods are also
1536+
supported. See `the section on mailgw in the admin guide
1537+
<admin_guide.html#mail-gateway-script-command-line>`_.
1538+
15351539
On windows, you would set up the command `using the windows scheduler`_.
15361540

15371541
As a regular job using an IMAP source
@@ -1545,13 +1549,17 @@ installed)::
15451549

15461550
where imap_spec is "``username:password@server``" that specifies the roundup
15471551
submission user's IMAP account name, password and server. You may
1548-
optionally include a mailbox to use other than the default ``INBOX`` with
1549-
"``imap username:password@server mailbox``".
1552+
optionally include a mailbox to use other than the default ``INBOX`` with::
1553+
1554+
imap username:password@server mailbox
15501555

1551-
If you have a secure (ie. HTTPS) IMAP server then you may use ``imaps``
1552-
in place of ``imap`` in the command to use a secure connection.
1556+
If you have a secure (ie. HTTPS) IMAP server then you may use
1557+
``imaps`` in place of ``imap`` in the command to use a securnae
1558+
connection. To use imap with CRAM or OAUTH, see `the section on
1559+
mailgw in the admin guide
1560+
<admin_guide.html#mail-gateway-script-command-line>`_ .
15531561

1554-
As with the POP job, on windows, you would set up the command
1562+
As with the POP job, on windows, you would set up the command
15551563
`using the windows scheduler`_.
15561564

15571565

0 commit comments

Comments
 (0)