sievemgr


Namesievemgr JSON
Version 0.7.4.7 PyPI version JSON
download
home_pageNone
SummaryFully-featured ManageSieve command-line client and library
upload_time2024-08-16 16:21:04
maintainerNone
docs_urlNone
authorOdin Kroeger
requires_python>=3.9
licenseNone
keywords managesieve sieve mail filter
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. image:: https://www.bestpractices.dev/badge_static/97
   :target: https://www.bestpractices.dev/en/projects/8336
   :alt: OpenSSF best practices badge

############
SieveManager
############

Sieve is a programming language for filtering email. Sieve scripts are
typically run by the mail server when mail is delivered to an inbox,
so they need to be managed remotely.

SieveManager is a command-line client for uploading, downloading,
and managing remote Sieve scripts using the ManageSieve protocol.
It can also be used as a Python module.

**WARNING**: The command-line interface, the configuration semantics,
and the Python API may still change.

.. _Sieve: http://sieve.info
.. _`home page`: https://odkr.codeberg.page/sievemgr


Example
=======

Upload and activate a Sieve script:

.. code:: none

    $ sievemgr user@imap.foo.example
    user@imap.foo.example's password: <password>
    sieve://user@imap.foo.example> put script.sieve
    sieve://user@imap.foo.example> activate script.sieve

In Python:

.. code:: python

    from sievemgr import SieveManager
    with SieveManager('imap.foo.example') as mgr:
        mgr.authenticate('user', 'password')
        with open('sieve.script', 'br') as script:
            mgr.putscript(script, 'sieve.script')
        mgr.setactive('sieve.script')


Features
========

* Complies fully with RFC 5804 (ManageSieve protocol)

* Login can be automated with:
  
  * Password managers
  * GnuPG-encrypted password files
  * ``sieve.cf``
  * ``.netrc``

* Password-based authentication with:

  * CRAM-MD5
  * LOGIN
  * PLAIN
  * SCRAM-\* and SCRAM-\*-PLUS [#untested]_ with

    * SHA-1
    * SHA-2-234
    * SHA-2-256
    * SHA-2-384
    * SHA-2-512
    * SHA-3-512

* TLS client authentication

* Proxy authentication

* Tab-completion

* Scriptable

* Emacs-like backup of scripts

* Checks whether TLS certificates have been revoked
  (using lightweight OCSP)

* Supports TLS Server Name Indication

* Supports giving IPv6 addresses on the command-line


.. [#untested] SCRAM-\*-PLUS authentication is untested.


Documentation
=============

Use **sievemgr -h**, type "help" in the SieveManager shell,
or see the `home page`_.


Contact
=======

Home page:
    https://odkr.codeberg.page/sievemgr

Issue tracker:
    https://github.com/odkr/sievemgr/issues

Source code (primary):
    https://codeberg.org/odkr/sievemgr

Source code (secondary):
    https://notabug.org/odkr/sievemgr


License
=======

Copyright 2023 and 2024  Odin Kroeger

SieveManager is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the FreeSoftware Foundation, either version 3 of the License, or (at
your option) any later version.

SieveManager is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with SieveManager. If not, see <https://www.gnu.org/licenses/>.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sievemgr",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "managesieve, sieve, mail, filter",
    "author": "Odin Kroeger",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/0f/ba/b66df22f0debb44e89cbcc5098e7411e0f705f4a16d0e85d249fc4fac1be/sievemgr-0.7.4.7.tar.gz",
    "platform": null,
    "description": ".. image:: https://www.bestpractices.dev/badge_static/97\n   :target: https://www.bestpractices.dev/en/projects/8336\n   :alt: OpenSSF best practices badge\n\n############\nSieveManager\n############\n\nSieve is a programming language for filtering email. Sieve scripts are\ntypically run by the mail server when mail is delivered to an inbox,\nso they need to be managed remotely.\n\nSieveManager is a command-line client for uploading, downloading,\nand managing remote Sieve scripts using the ManageSieve protocol.\nIt can also be used as a Python module.\n\n**WARNING**: The command-line interface, the configuration semantics,\nand the Python API may still change.\n\n.. _Sieve: http://sieve.info\n.. _`home page`: https://odkr.codeberg.page/sievemgr\n\n\nExample\n=======\n\nUpload and activate a Sieve script:\n\n.. code:: none\n\n    $ sievemgr user@imap.foo.example\n    user@imap.foo.example's password: <password>\n    sieve://user@imap.foo.example> put script.sieve\n    sieve://user@imap.foo.example> activate script.sieve\n\nIn Python:\n\n.. code:: python\n\n    from sievemgr import SieveManager\n    with SieveManager('imap.foo.example') as mgr:\n        mgr.authenticate('user', 'password')\n        with open('sieve.script', 'br') as script:\n            mgr.putscript(script, 'sieve.script')\n        mgr.setactive('sieve.script')\n\n\nFeatures\n========\n\n* Complies fully with RFC 5804 (ManageSieve protocol)\n\n* Login can be automated with:\n  \n  * Password managers\n  * GnuPG-encrypted password files\n  * ``sieve.cf``\n  * ``.netrc``\n\n* Password-based authentication with:\n\n  * CRAM-MD5\n  * LOGIN\n  * PLAIN\n  * SCRAM-\\* and SCRAM-\\*-PLUS [#untested]_ with\n\n    * SHA-1\n    * SHA-2-234\n    * SHA-2-256\n    * SHA-2-384\n    * SHA-2-512\n    * SHA-3-512\n\n* TLS client authentication\n\n* Proxy authentication\n\n* Tab-completion\n\n* Scriptable\n\n* Emacs-like backup of scripts\n\n* Checks whether TLS certificates have been revoked\n  (using lightweight OCSP)\n\n* Supports TLS Server Name Indication\n\n* Supports giving IPv6 addresses on the command-line\n\n\n.. [#untested] SCRAM-\\*-PLUS authentication is untested.\n\n\nDocumentation\n=============\n\nUse **sievemgr -h**, type \"help\" in the SieveManager shell,\nor see the `home page`_.\n\n\nContact\n=======\n\nHome page:\n    https://odkr.codeberg.page/sievemgr\n\nIssue tracker:\n    https://github.com/odkr/sievemgr/issues\n\nSource code (primary):\n    https://codeberg.org/odkr/sievemgr\n\nSource code (secondary):\n    https://notabug.org/odkr/sievemgr\n\n\nLicense\n=======\n\nCopyright 2023 and 2024  Odin Kroeger\n\nSieveManager is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe FreeSoftware Foundation, either version 3 of the License, or (at\nyour option) any later version.\n\nSieveManager is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\nSee the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with SieveManager. If not, see <https://www.gnu.org/licenses/>.\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Fully-featured ManageSieve command-line client and library",
    "version": "0.7.4.7",
    "project_urls": {
        "homepage": "https://odkr.codeberg.page/sievemgr",
        "issues": "https://github.com/odkr/sievemgr/issues",
        "repository": "https://codeberg.org/odkr/sievemgr"
    },
    "split_keywords": [
        "managesieve",
        " sieve",
        " mail",
        " filter"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6b4977bc2d08731f2fbcfd60a1a2cc8cc89700e551f42b6aa7ac780ceb212f35",
                "md5": "9a30710111d1df8fc107f8bc5f82aadc",
                "sha256": "94737d3bba7276bc304188517a6f86188e2cc676c65d3eb0eb27de5795fc86d2"
            },
            "downloads": -1,
            "filename": "sievemgr-0.7.4.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9a30710111d1df8fc107f8bc5f82aadc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 61246,
            "upload_time": "2024-08-16T16:21:03",
            "upload_time_iso_8601": "2024-08-16T16:21:03.493616Z",
            "url": "https://files.pythonhosted.org/packages/6b/49/77bc2d08731f2fbcfd60a1a2cc8cc89700e551f42b6aa7ac780ceb212f35/sievemgr-0.7.4.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0fbab66df22f0debb44e89cbcc5098e7411e0f705f4a16d0e85d249fc4fac1be",
                "md5": "11d2e805db7ccdde63b7d414dbf25fae",
                "sha256": "72bc08a47e8e390948287449ade63d5f0f025c1aaa1d90c1de20b048432654d2"
            },
            "downloads": -1,
            "filename": "sievemgr-0.7.4.7.tar.gz",
            "has_sig": false,
            "md5_digest": "11d2e805db7ccdde63b7d414dbf25fae",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 76595,
            "upload_time": "2024-08-16T16:21:04",
            "upload_time_iso_8601": "2024-08-16T16:21:04.911078Z",
            "url": "https://files.pythonhosted.org/packages/0f/ba/b66df22f0debb44e89cbcc5098e7411e0f705f4a16d0e85d249fc4fac1be/sievemgr-0.7.4.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-16 16:21:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "odkr",
    "github_project": "sievemgr",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "sievemgr"
}
        
Elapsed time: 1.49340s