.. _module-gmail:

Gmail
--------------------------

* **Identifier** - GMAIL
* **Description** - Implements integration with Gmail.
* **Initialization** - Checks availability of Play Services, if not available checks availability of com.google.oauth.ClientId and com.google.oauth.ClientSecret as meta-data.
* **Destroy** - None
* **Dependencies** - :ref:`module-core`, :ref:`module-contacts`

Trigger Incoming Email
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Name         | INCOMING                                                                                               |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Description  | Executes when receiving a new email.                                                                   |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Logic        | Based on real time updates from Google. It works even without Play Services (GCM).                     |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+----------------+--------------+--------------------------------------+
|              | Type                            | Name           | Required     | Description                          |
+==============+=================================+================+==============+======================================+
| Parameters   | CONTACTS.EMAIL-ADDRESS          | SENDER         | No           | Email sender.                        |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | CORE.TEXT-FILTER                | SUBJECT-FILTER | No           | Email subject filter.                |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | CORE.TEXT-FILTER                | BODY-FILTER    | No           | Email body filter.                   |
+--------------+---------------------------------+----------------+--------------+--------------------------------------+
| Variables    | CONTACTS.EMAIL-ADDRESS          | SENDER                        | Email sender.                        |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | CORE.STRING                     | SENDER-EMAIL                  | Email sender email.                  |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | CORE.STRING                     | SENDER-NAME                   | Email sender name.                   |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | CORE.STRING                     | SUBJECT                       | Email subject.                       |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | CORE.STRING                     | BODY                          | Email body.                          |
+              +---------------------------------+----------------+--------------+--------------------------------------+
|              | CORE.URI                        | ATTACH                        | Email attachment.                    |
+--------------+---------------------------------+----------------+--------------+--------------------------------------+

Performer Send
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. cssclass:: table-bordered

+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Name         | SEND                                                                                                   |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+
| Description  | Sends an email with specified parameters.                                                              |
+--------------+-------------------+---------------+--------------+-----------------------------------------------------+

.. cssclass:: table-bordered

+--------------+---------------------------------+--------------+--------------+----------------------------------------+
|              | Type                            | Name         | Required     | Description                            |
+==============+=================================+==============+==============+========================================+
| Parameters   | CONTACTS.EMAIL-ADDRESS          | RECIPIENT    | Yes          | Email recipient.                       |
+              +---------------------------------+--------------+--------------+----------------------------------------+
|              | CORE.STRING                     | SUBJECT      | No           | Email subject.                         |
+              +---------------------------------+--------------+--------------+----------------------------------------+
|              | CORE.STRING                     | BODY         | No           | Email body.                            |
+              +---------------------------------+--------------+--------------+----------------------------------------+
|              | CORE.URI                        | ATTACH       | No           | Email attachment as Content Uri.       |
+--------------+---------------------------------+--------------+--------------+----------------------------------------+