org.views.userprofile
=====================

.. py:module:: org.views.userprofile

.. autoapi-nested-parse::

   The settings of the logged in user. 



Functions
---------

.. autoapisummary::

   org.views.userprofile.handle_user_profile
   org.views.userprofile.unsubscribe
   org.views.userprofile.handle_unsubscribe
   org.views.userprofile.handle_unsubscribe_rfc8058


Module Contents
---------------

.. py:function:: handle_user_profile(self: onegov.org.models.Organisation, request: onegov.org.request.OrgRequest, form: onegov.form.Form, layout: onegov.org.layout.DefaultLayout | None = None) -> onegov.core.types.RenderData | webob.Response

   Handles the GET and POST login requests. 


.. py:function:: unsubscribe(request: onegov.org.request.OrgRequest) -> bool

   Unsubscribe a user from all *regular* e-mails.

   Returns True, if the request was valid.



.. py:function:: handle_unsubscribe(self: onegov.org.models.Organisation, request: onegov.org.request.OrgRequest, layout: onegov.org.layout.DefaultLayout | None = None) -> onegov.core.types.RenderData | webob.Response

   Unsubscribes a user from all *regular* e-mails.

   To be able to use this method, an url has to be created like this::

       '{}?token={}'.format((
           request.link(org, name='unsubscribe'),
           request.new_url_safe_token(
               {'user': 'user@example.org'}, 'unsubscribe'
           )
       ))

   This view never fails and always pretends to be successful.



.. py:function:: handle_unsubscribe_rfc8058(self: onegov.org.models.Organisation, request: onegov.org.request.OrgRequest) -> morepath.request.Response