getmail 6.19.5__tar.gz

getmail-6.19.5/.github/workflows/lint.yml

@@ -0,0 +1,15 @@
+# https://github.com/codespell-project/codespell
+# https://beta.ruff.rs
+name: lint
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - run: pip install --user codespell[toml] ruff
+    - run: codespell
+    - run: ruff check .

getmail-6.19.5/.gitignore

@@ -0,0 +1,141 @@
+test/temp.*
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+.build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

getmail-6.19.5/MANIFEST.in

@@ -0,0 +1,13 @@
+include README
+include MANIFEST.in
+include docs/*.txt
+include docs/*.html
+include docs/BUGS
+include docs/CHANGELOG
+include docs/COPYING
+include docs/THANKS
+include docs/getmaildocs.css
+include docs/getmailrc-examples
+include docs/*.1
+include getmail getmail_fetch getmail_maildir getmail_mbox setup.py
+include getmailcore/*.py

getmail-6.19.5/Makefile

@@ -0,0 +1,73 @@
+# docs/COPYING 2a + DRY: https://github.com/getmail6/getmail6
+# Please refer to the git history regarding who changed what and when in this file.
+
+# Needs Docker Daemon running
+# systemctl start docker
+
+.PHONY: doc
+doc:
+	links -dump docs/documentation.html > docs/documentation.txt
+	links -dump docs/configuration.html > docs/configuration.txt
+	links -dump docs/faq.html > docs/faq.txt
+	links -dump docs/troubleshooting.html > docs/troubleshooting.txt
+
+.PHONY: testclean
+testclean:
+	[ -d /tmp/mailserver/ ] && (cd /tmp/mailserver && docker-compose down) || true
+	[ -d /tmp/mailserver/ ] && sudo rm -rf /tmp/mailserver || true
+
+.PHONY: test3
+test3:
+	cd test && ./prepare_test.sh
+	cd /tmp/mailserver && test/bats/bin/bats test/test_getmail_with_docker_mailserver.bats
+
+.PHONY: testpython
+testpython:
+	pytest test/test.py
+
+.PHONY: test
+test: testpython testclean test3
+	cd /tmp/mailserver && docker-compose down
+
+.PHONY: lint
+lint:
+	ruff check .
+
+.PHONY: check
+check: lint
+	/usr/bin/man -l docs/getmail.1
+	/usr/bin/man -l docs/getmails.1
+	/usr/bin/man -l docs/getmail_fetch.1
+	/usr/bin/man -l docs/getmail_maildir.1
+	/usr/bin/man -l docs/getmail_mbox.1
+	restview --long-description --strict
+
+.PHONY: dist
+dist: doc
+	echo "need sudo to create wheel"
+	sudo python setup.py bdist_wheel sdist
+	echo "note:"
+	echo "use ./pypi.sh to upload to PYPI"
+
+# use ./pypi.sh to upload to PYPI
+.PHONY: up6
+up6: dist
+	twine upload dist/`ls dist -rt *.whl | tail -1` dist/`ls dist -rt *.tar.gz | tail -1` -u__token__ -p`pass show pypi.org/getmail6_api_token`
+
+.PHONY: up
+up: dist
+	twine upload dist/`ls dist -rt *.whl | tail -1` dist/`ls dist -rt *.tar.gz | tail -1` -u__token__ -p`pass show pypi.org/getmail_api_token`
+
+.PHONY: tag
+tag: dist
+	$(eval TAGMSG="v$(shell ./getmail --version | cut -d ' ' -f 2)")
+	echo $(TAGMSG)
+	git tag -s $(TAGMSG) -m"$(TAGMSG)"
+	git verify-tag $(TAGMSG)
+	git push origin $(TAGMSG) --follow-tags
+
+.PHONY: cleandocker
+cleandocker:
+	docker network prune
+	docker rm -vf $$(docker ps -aq)
+	docker rmi -f $$(docker images -aq)

getmail-6.19.5/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.1
+Name: getmail
+Version: 6.19.5
+Summary: a mail retrieval, sorting, and delivering system
+Home-page: https://www.getmail6.org/
+Download-URL: https://github.com/getmail6/getmail6/releases
+Author: Charles Cazabon, Roland Puntaier, and others
+Author-email: charlesc-getmail@pyropus.ca
+Maintainer-email: roland.puntaier@gmail.com
+License: GPL-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: GNU General Public License (GPL)
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python
+Classifier: Topic :: Communications :: Email
+Classifier: Topic :: Communications :: Email :: Filters
+Classifier: Topic :: Communications :: Email :: Post-Office :: IMAP
+Classifier: Topic :: Communications :: Email :: Post-Office :: POP3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+
+.. vim: syntax=rst
+
+.. docs/COPYING 2a + DRY: https://github.com/getmail6/getmail6
+.. Please refer to the git history regarding who changed what and when in this file.
+
+Description
+===========
+
+getmail6 is a flexible, extensible mail retrieval system with
+support for POP3, IMAP4, SSL variants of both, maildirs, mboxrd files,
+external MDAs, arbitrary message filtering, single-user and domain-mailboxes,
+and many other useful features.
+
+Licence
+=======
+
+getmail is Copyright (C) 1998-2024 Charles Cazabon and others.
+getmail is licensed for use under the GNU General Public License version 2 (only).
+See ``docs/COPYING`` for specific terms and distribution information.
+
+Bugs
+====
+
+getmail6 has adaptations to work with Python 3.
+These changes might still contain some bugs.
+Please report them at https://github.com/getmail6/getmail6.
+See ``docs/BUGS`` for instructions on reporting bugs.
+
+Installation
+============
+
+To install::
+
+  pip install getmail6
+
+To uninstall::
+
+  pip uninstall getmail6
+
+You can install getmail6 in your home directory if you add ``--user``.
+
+If getmail6 is available via your Linux distribution, you better use that.
+
+Usage
+=====
+
+getmail6 is not a python API.
+getmail6 provides command line tools:
+
+- getmail
+- getmail_maildir
+- getmail_mbox
+- getmail_fetch
+- getmail-gmail-xoauth-tokens
+
+Configuration
+=============
+
+Before using ``getmail`` you must configure it.
+See ``docs/configuration.txt`` and ``docs/getmailrc-examples``.
+An example::
+
+  [retriever]
+  type = SimpleIMAPSSLRetriever
+  server = imap.gmail.com 
+  port = 993
+  username = <your_email_here>
+  #password = ... or
+  password_command = ("pass", "<your_email_here>")
+
+  [destination]
+  type = Maildir
+  path = ~/Mail/<your_email_here>/INBOX/
+
+  [options]
+  read_all = true
+  delete = true
+
+Gmail
+=====
+
+For **gmail**,
+after having enabled 2-Step Authentication,
+let google generate an "app password" for you.
+Then, for the above example,
+use ``pass edit <your_email_here>`` and change to the generate one.
+
+- Go to https://mail.google.com
+- If you are signed in, on the left upper corner there is a cogwheel symbol for settings
+- Choose "See all Settings"
+- "Accounts and Imports" tab, then "Other Google Account Settings"/"Security" brings you to
+  https://myaccount.google.com/u/0/security?hl=en
+- Turn on "2-Step Verification" (also known as 2-factor-authentication or 2FA)
+- In "App passwords", generate a password for your device
+- Update this in your password command.
+
+See also: https://support.google.com/accounts/answer/185833
+
+getmail is a native app.
+See
+https://developers.google.com/identity/protocols/oauth2/native-app
+Still, to download your email from gmail to your computer using OAuth2
+you need to grant getmail OAuth2 access to the scope ``https://mail.google.com/``,
+as you would to web apps.
+Unfortunately, the init step in example 12 in ``docs/getmailrc-examples``
+has to be repeated regularly.
+This makes the *app password* method above a better alternative.
+Don't forget to remove the ``use_xoauth2`` line,
+if you switch from Oauth2 to *app password*.
+
+Tests
+=====
+
+There is now a test folder that uses
+`docker-mailserver <https://github.com/docker-mailserver/docker-mailserver>`__
+for black box testing.
+
+Tests are work in progress.
+
+Documentation
+=============
+
+See the HTML documentation for details on setting up and using ``getmail``.
+
+::
+
+  docs/documentation.html
+  docs/configuration.html
+  docs/faq.html
+  docs/troubleshooting.html
+
+
+It is included in the ``docs`` subdirectory,
+and will be installed in ``<PREFIX>/doc/getmail-<version>/`` (by default).
+
+

getmail-6.19.5/README

@@ -0,0 +1,136 @@
+.. vim: syntax=rst
+
+.. docs/COPYING 2a + DRY: https://github.com/getmail6/getmail6
+.. Please refer to the git history regarding who changed what and when in this file.
+
+Description
+===========
+
+getmail6 is a flexible, extensible mail retrieval system with
+support for POP3, IMAP4, SSL variants of both, maildirs, mboxrd files,
+external MDAs, arbitrary message filtering, single-user and domain-mailboxes,
+and many other useful features.
+
+Licence
+=======
+
+getmail is Copyright (C) 1998-2024 Charles Cazabon and others.
+getmail is licensed for use under the GNU General Public License version 2 (only).
+See ``docs/COPYING`` for specific terms and distribution information.
+
+Bugs
+====
+
+getmail6 has adaptations to work with Python 3.
+These changes might still contain some bugs.
+Please report them at https://github.com/getmail6/getmail6.
+See ``docs/BUGS`` for instructions on reporting bugs.
+
+Installation
+============
+
+To install::
+
+  pip install getmail6
+
+To uninstall::
+
+  pip uninstall getmail6
+
+You can install getmail6 in your home directory if you add ``--user``.
+
+If getmail6 is available via your Linux distribution, you better use that.
+
+Usage
+=====
+
+getmail6 is not a python API.
+getmail6 provides command line tools:
+
+- getmail
+- getmail_maildir
+- getmail_mbox
+- getmail_fetch
+- getmail-gmail-xoauth-tokens
+
+Configuration
+=============
+
+Before using ``getmail`` you must configure it.
+See ``docs/configuration.txt`` and ``docs/getmailrc-examples``.
+An example::
+
+  [retriever]
+  type = SimpleIMAPSSLRetriever
+  server = imap.gmail.com 
+  port = 993
+  username = <your_email_here>
+  #password = ... or
+  password_command = ("pass", "<your_email_here>")
+
+  [destination]
+  type = Maildir
+  path = ~/Mail/<your_email_here>/INBOX/
+
+  [options]
+  read_all = true
+  delete = true
+
+Gmail
+=====
+
+For **gmail**,
+after having enabled 2-Step Authentication,
+let google generate an "app password" for you.
+Then, for the above example,
+use ``pass edit <your_email_here>`` and change to the generate one.
+
+- Go to https://mail.google.com
+- If you are signed in, on the left upper corner there is a cogwheel symbol for settings
+- Choose "See all Settings"
+- "Accounts and Imports" tab, then "Other Google Account Settings"/"Security" brings you to
+  https://myaccount.google.com/u/0/security?hl=en
+- Turn on "2-Step Verification" (also known as 2-factor-authentication or 2FA)
+- In "App passwords", generate a password for your device
+- Update this in your password command.
+
+See also: https://support.google.com/accounts/answer/185833
+
+getmail is a native app.
+See
+https://developers.google.com/identity/protocols/oauth2/native-app
+Still, to download your email from gmail to your computer using OAuth2
+you need to grant getmail OAuth2 access to the scope ``https://mail.google.com/``,
+as you would to web apps.
+Unfortunately, the init step in example 12 in ``docs/getmailrc-examples``
+has to be repeated regularly.
+This makes the *app password* method above a better alternative.
+Don't forget to remove the ``use_xoauth2`` line,
+if you switch from Oauth2 to *app password*.
+
+Tests
+=====
+
+There is now a test folder that uses
+`docker-mailserver <https://github.com/docker-mailserver/docker-mailserver>`__
+for black box testing.
+
+Tests are work in progress.
+
+Documentation
+=============
+
+See the HTML documentation for details on setting up and using ``getmail``.
+
+::
+
+  docs/documentation.html
+  docs/configuration.html
+  docs/faq.html
+  docs/troubleshooting.html
+
+
+It is included in the ``docs`` subdirectory,
+and will be installed in ``<PREFIX>/doc/getmail-<version>/`` (by default).
+
+

getmail-6.19.5/docs/BUGS

@@ -0,0 +1,33 @@
+Known bugs
+==========
+
+None, but we are very interested in hearing your experiences with
+using this version with Python version 3 or newer.
+
+Reporting bugs
+==============
+
+Before reporting a problem
+--------------------------
+
+If you want to report a getmail problem, please ensure
+
+- you are running the latest version of getmail from the
+  website at http://getmail6.org/
+
+- you have installed getmail from the .tar.gz file I provide
+
+Then follow the rest of the instructions below.
+
+How to report a problem with getmail
+------------------------------------
+
+IMPORTANT:  Please include the output of
+
+  getmail [your usual options] --dump
+
+and a copy of your getmail rc file(s) (with password masked) with any
+bug report.
+
+If you find a bug in getmail, please open an issue on GitHub at
+https://github.com/getmail6/getmail6/issues