path: root/imap-dl
diff options
authorDaniel Kahn Gillmor <>2020-03-10 17:16:10 -0400
committerDaniel Kahn Gillmor <>2020-03-10 17:16:10 -0400
commit66a987a52a66aa36b3dfdb4ab8fa6af1c0d5ccf2 (patch)
tree36fddba71fa390d05a1b8161a8e277c295a55472 /imap-dl
parentf3a9d113fd89db152db9cd2f061fc8f7367f0fc9 (diff)
imap-dl: update documentation to be less explicitly "getmail"y
The fact that imap-dl came out of getmail and borrows a bit of configuration shouldn't be relevant for new users. Make the documentation more agnostic about where they're coming from. Signed-off-by: Daniel Kahn Gillmor <>
Diffstat (limited to 'imap-dl')
1 files changed, 4 insertions, 15 deletions
diff --git a/imap-dl b/imap-dl
index 469b81d..de6be60 100755
--- a/imap-dl
+++ b/imap-dl
@@ -17,22 +17,9 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <>.
-DESCRIPTION = '''A simple replacement for a minimalist use of getmail.
+DESCRIPTION = '''Fetch messages from an IMAP inbox into a maildir
-In particular, if you use getmail to reach an IMAP server as though it
-were POP (retrieving from the server and optionally deleting), you can
-point this script to the getmail config and it should do the same
-It tries to ensure that the configuration file is of the expected
-type, and will terminate raising an exception, and it should not lose
-If there's any interest in supporting other similarly simple use cases
-for getmail, patches are welcome.
-If you've never used getmail, you can make the simplest possible
-config file like so:
+Example config file:
@@ -46,6 +33,8 @@ path = /home/foo/Maildir
delete = True
+Run "man imap-dl" for more details.
import re