.. _org.freedesktop.impl.portal.Email:

=================================
 Email
=================================

-----------
Description
-----------

.. _org.freedesktop.impl.portal.Email Description:

Email portal backend interface

This Email portal lets sandboxed applications request sending an email.



.. _org.freedesktop.impl.portal.Email Methods:

-------
Methods
-------

.. _org.freedesktop.impl.portal.Email.ComposeEmail:

org.freedesktop.impl.portal.Email.ComposeEmail
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

::

    ComposeEmail (
      IN handle o,
      IN app_id s,
      IN parent_window s,
      IN options a{sv},
      OUT response u,
      OUT results a{sv}
    )



Lets the user compose an email.

Supported keys in the ``options`` vardict include:

* ``address`` (``s``)

  The email address to send to.

* ``addresses`` (``as``)

  Email addresses to send to.

* ``cc`` (``as``)

  Email addresses to cc.

* ``bcc`` (``as``)

  Email addresses to bcc.

* ``subject`` (``s``)

  The subject for the email.

* ``body`` (``s``)

  The body for the email.

* ``attachments`` (``as``)

  The uris for files to attach.

* ``activation_token`` (``s``)

  A token that can be used to activate the chosen application.



handle
  Object path for the :ref:`org.freedesktop.impl.portal.Request` object representing this call

app_id
  App id of the application

parent_window
  Identifier for the application window, see :doc:`window-identifiers`

options
  Vardict with optional further information

response
  Numeric response

results
  Vardict with the results of the call


