Sylius/docs/components_and_bundles/components/Mailer/models.rst
2019-01-15 12:49:41 +01:00

47 lines
2.3 KiB
ReStructuredText

.. rst-class:: outdated
Models
======
.. danger::
We're sorry but **this documentation section is outdated**. Please have that in mind when trying to use it.
You can help us making documentation up to date via Sylius Github. Thank you!
.. _component_mailer_model_email:
Email
-----
**Email** object represents an email.
Email has the following properties:
+---------------+-------------------------------------------------------+
| Property | Description |
+===============+=======================================================+
| id | Unique id of the email |
+---------------+-------------------------------------------------------+
| code | Code of the email |
+---------------+-------------------------------------------------------+
| enabled | Indicates whether email is available |
+---------------+-------------------------------------------------------+
| subject | Subject of the email message |
+---------------+-------------------------------------------------------+
| content | Content of the email message |
+---------------+-------------------------------------------------------+
| template | Template of the email |
+---------------+-------------------------------------------------------+
| senderName | Name of a sender |
+---------------+-------------------------------------------------------+
| senderAddress | Address of a sender |
+---------------+-------------------------------------------------------+
| createdAt | Date when the email was created |
+---------------+-------------------------------------------------------+
| updatedAt | Date of last change |
+---------------+-------------------------------------------------------+
.. note::
This model implements the :ref:`component_mailer_model_email-interface`
For more detailed information go to `Sylius API Email`_.
.. _Sylius API Email: http://api.sylius.com/Sylius/Component/Mailer/Model/Email.html