core.modules.formmailer
=======================

.. py:module:: core.modules.formmailer


Classes
-------

.. autoapisummary::

   core.modules.formmailer.MailSkel
   core.modules.formmailer.Formmailer


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

.. py:class:: MailSkel

   Bases: :py:obj:`viur.core.skeleton.RelSkel`


   This is a Skeleton-like class that acts as a container for Skeletons used as a
   additional information data skeleton for :class:`~viur.core.bones.relational.RelationalBone`.

   It needs to be sub-classed where information about the kindName and its attributes
   (bones) are specified.

   The Skeleton stores its bones in an :class:`OrderedDict`-Instance, so the definition order of the
   contained bones remains constant.


   .. py:attribute:: changedate
      :value: None



.. py:class:: Formmailer(moduleName, modulePath, *args, **kwargs)

   Bases: :py:obj:`viur.core.module.Module`


   Formmailer is the standard module to implement a form mailer for contact request or similar forms.


   .. py:attribute:: mailTemplate
      :value: None



   .. py:method:: index(*args, **kwargs)


   .. py:method:: add(*args, **kwargs)


   .. py:method:: canUse()


   .. py:method:: mailSkel()
      :abstractmethod:



   .. py:method:: getRcpts(skel)
      :abstractmethod:



   .. py:method:: getOptions(skel)


   .. py:method:: onAdded(skel)