.. This README is meant for consumption by humans and PyPI. PyPI can render rst files so please do not use Sphinx features.
If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
This text does not appear on PyPI or github. It is a comment.
.. image:: https://github.com/collective/collective.volto.otp/actions/workflows/plone-package.yml/badge.svg
:target: https://github.com/collective/collective.volto.otp/actions/workflows/plone-package.yml
.. image:: https://coveralls.io/repos/github/collective/collective.volto.otp/badge.svg?branch=main
:target: https://coveralls.io/github/collective/collective.volto.otp?branch=main
:alt: Coveralls
.. image:: https://codecov.io/gh/collective/collective.volto.otp/branch/master/graph/badge.svg
:target: https://codecov.io/gh/collective/collective.volto.otp
.. image:: https://img.shields.io/pypi/v/collective.volto.otp.svg
:target: https://pypi.python.org/pypi/collective.volto.otp/
:alt: Latest Version
.. image:: https://img.shields.io/pypi/status/collective.volto.otp.svg
:target: https://pypi.python.org/pypi/collective.volto.otp
:alt: Egg Status
.. image:: https://img.shields.io/pypi/pyversions/collective.volto.otp.svg?style=plastic :alt: Supported - Python Versions
.. image:: https://img.shields.io/pypi/l/collective.volto.otp.svg
:target: https://pypi.python.org/pypi/collective.volto.otp/
:alt: License
====================
collective.volto.otp
====================
otp validator for emails
Features
--------
- Email validation by otp
RestAPI
=======
@validate-email-address
-----------------------
Send an message to the passed email wit OTP code to verify the address.
Returns a HTTP 204 in case of success or HTTP 400 in case the email is badly composed.::
> curl -i -X POST http://localhost:8080/Plone/my-form/@validate-email-address --data-raw '{"email": "email@email.com", "uid": "ffffffff"}' -H 'Accept: application/json' -H 'Content-Type: application/json'
parameters:
* `email` email address.
* `uid` uid related to email field
@validate-email-token
---------------------
Supposed to validate the OTP code received by the user via email.
Returns HTTP 204 in case of success or HTTP 400 in case of failure ::
> curl -i -X POST http://localhost:8080/Plone/my-form/@validate-email-token --data-raw '{"email": "email@email.com", "otp": "blahblahblah"}' -H 'Accept: application/json' -H 'Content-Type: application/json'
parameters:
* `email` email address
* `uid` uid used to generate the OTP
* `otp` OTP code
Translations
------------
This product has been translated into
- Italian
Installation
------------
Install collective.volto.otp by adding it to your buildout::
[buildout]
...
eggs =
collective.volto.otp
and then running ``bin/buildout``
Authors
-------
RedTurtle
Contributors
------------
Put your name here, you deserve it!
- folix-01
Contribute
----------
- Issue Tracker: https://github.com/collective/collective.volto.otp/issues
- Source Code: https://github.com/collective/collective.volto.otp
- Documentation: https://docs.plone.org/foo/bar
Support
-------
If you are having issues, please let us know.
We have a mailing list located at: project@example.com
License
-------
The project is licensed under the GPLv2.
Contributors
============
- RedTurtle, info@redturtle.it
Changelog
=========
1.0.1 (2024-07-10)
------------------
- Alignments.
[folix-01]
1.0.0 (2024-06-13)
------------------
- Initial release.
[folix-01]
Raw data
{
"_id": null,
"home_page": "https://github.com/collective/collective.volto.otp",
"name": "collective.volto.otp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "Python Plone CMS",
"author": "RedTurtle",
"author_email": "info@redturtle.it",
"download_url": "https://files.pythonhosted.org/packages/40/b2/943899f15dd832e1f004318fa77fa5fe825eebccd237e750efa64c1abd43/collective.volto.otp-1.0.1.tar.gz",
"platform": null,
"description": ".. This README is meant for consumption by humans and PyPI. PyPI can render rst files so please do not use Sphinx features.\n If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html\n This text does not appear on PyPI or github. It is a comment.\n\n.. image:: https://github.com/collective/collective.volto.otp/actions/workflows/plone-package.yml/badge.svg\n :target: https://github.com/collective/collective.volto.otp/actions/workflows/plone-package.yml\n\n.. image:: https://coveralls.io/repos/github/collective/collective.volto.otp/badge.svg?branch=main\n :target: https://coveralls.io/github/collective/collective.volto.otp?branch=main\n :alt: Coveralls\n\n.. image:: https://codecov.io/gh/collective/collective.volto.otp/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/collective/collective.volto.otp\n\n.. image:: https://img.shields.io/pypi/v/collective.volto.otp.svg\n :target: https://pypi.python.org/pypi/collective.volto.otp/\n :alt: Latest Version\n\n.. image:: https://img.shields.io/pypi/status/collective.volto.otp.svg\n :target: https://pypi.python.org/pypi/collective.volto.otp\n :alt: Egg Status\n\n.. image:: https://img.shields.io/pypi/pyversions/collective.volto.otp.svg?style=plastic :alt: Supported - Python Versions\n\n.. image:: https://img.shields.io/pypi/l/collective.volto.otp.svg\n :target: https://pypi.python.org/pypi/collective.volto.otp/\n :alt: License\n\n\n====================\ncollective.volto.otp\n====================\n\notp validator for emails\n\nFeatures\n--------\n\n- Email validation by otp\n\nRestAPI\n=======\n\n\n@validate-email-address\n-----------------------\n\nSend an message to the passed email wit OTP code to verify the address.\nReturns a HTTP 204 in case of success or HTTP 400 in case the email is badly composed.::\n\n> curl -i -X POST http://localhost:8080/Plone/my-form/@validate-email-address --data-raw '{\"email\": \"email@email.com\", \"uid\": \"ffffffff\"}' -H 'Accept: application/json' -H 'Content-Type: application/json'\n\nparameters:\n\n* `email` email address.\n* `uid` uid related to email field\n\n@validate-email-token\n---------------------\n\nSupposed to validate the OTP code received by the user via email.\nReturns HTTP 204 in case of success or HTTP 400 in case of failure ::\n\n> curl -i -X POST http://localhost:8080/Plone/my-form/@validate-email-token --data-raw '{\"email\": \"email@email.com\", \"otp\": \"blahblahblah\"}' -H 'Accept: application/json' -H 'Content-Type: application/json'\n\nparameters:\n\n* `email` email address\n* `uid` uid used to generate the OTP\n* `otp` OTP code\n\n\nTranslations\n------------\n\nThis product has been translated into\n\n- Italian\n\n\nInstallation\n------------\n\nInstall collective.volto.otp by adding it to your buildout::\n\n [buildout]\n\n ...\n\n eggs =\n collective.volto.otp\n\n\nand then running ``bin/buildout``\n\n\nAuthors\n-------\n\nRedTurtle\n\n\nContributors\n------------\n\nPut your name here, you deserve it!\n\n- folix-01\n\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/collective/collective.volto.otp/issues\n- Source Code: https://github.com/collective/collective.volto.otp\n- Documentation: https://docs.plone.org/foo/bar\n\n\nSupport\n-------\n\nIf you are having issues, please let us know.\nWe have a mailing list located at: project@example.com\n\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\n\nContributors\n============\n\n- RedTurtle, info@redturtle.it\n\n\nChangelog\n=========\n\n\n1.0.1 (2024-07-10)\n------------------\n\n- Alignments.\n [folix-01]\n\n\n1.0.0 (2024-06-13)\n------------------\n\n- Initial release.\n [folix-01]",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "otp validator for emails",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/collective/collective.volto.otp",
"PyPI": "https://pypi.org/project/collective.volto.otp/",
"Source": "https://github.com/collective/collective.volto.otp",
"Tracker": "https://github.com/collective/collective.volto.otp/issues"
},
"split_keywords": [
"python",
"plone",
"cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40b2943899f15dd832e1f004318fa77fa5fe825eebccd237e750efa64c1abd43",
"md5": "7c8a4c1180454effc2c077cee3a0ea3b",
"sha256": "8b54dd62995a61a0318bed48e4f8f2d4da5984a73d333d6359d425f71a0c58d1"
},
"downloads": -1,
"filename": "collective.volto.otp-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "7c8a4c1180454effc2c077cee3a0ea3b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 28687,
"upload_time": "2024-07-10T10:39:59",
"upload_time_iso_8601": "2024-07-10T10:39:59.977023Z",
"url": "https://files.pythonhosted.org/packages/40/b2/943899f15dd832e1f004318fa77fa5fe825eebccd237e750efa64c1abd43/collective.volto.otp-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-10 10:39:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "collective",
"github_project": "collective.volto.otp",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "collective.volto.otp"
}
JSON
