<?xml version="1.0"?> <!-- Copyright (C) 2017 Red Hat, Inc. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library. If not, see <http://www.gnu.org/licenses/>. Author: Matthias Clasen <mclasen@redhat.com> --> <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"> <!-- org.freedesktop.portal.Email: @short_description: Portal for sending email This simple portal lets sandboxed applications request to send an email, optionally providing an address, subject, body and attachments. This documentation describes version 3 of this interface. --> <interface name="org.freedesktop.portal.Email"> <!-- ComposeEmail: @parent_window: Identifier for the application window, see <link linkend="parent_window">Common Conventions</link> @options: Vardict with optional further information @handle: Object path for the #org.freedesktop.portal.Request object representing this call Presents a window that lets the user compose an email. Note that the default email client for the host will need to support mailto: URIs following <ulink url="https://tools.ietf.org/html/rfc2368">RFC 2368</ulink>, with "cc", "bcc", "subject" and "body" query keys each corresponding to the email header of the same name, and with each attachment being passed as a "file://" URI as a value in an "attachment" query key. For example: <programlisting> mailto:foo@bar.com,baz@bar.com?cc=ceo@bar.com&amp;subject=Test%20e-mail%20subject&amp;attachment=file://path/to/full/file.txt </programlisting> would send a mail to "foo@bar.com", "baz@bar.com", with a CC: to "ceo@bar.com", with the subject "Test e-mail subject" and the file pointed by URI "file://path/to/full/file.txt" as an attachment. Supported keys in the @options vardict include: <variablelist> <varlistentry> <term>handle_token s</term> <listitem><para> A string that will be used as the last element of the @handle. Must be a valid object path element. See the #org.freedesktop.portal.Request documentation for more information about the @handle. </para></listitem> </varlistentry> <varlistentry> <term>address s</term> <listitem><para> The email address to send to. </para></listitem> </varlistentry> <varlistentry> <term>addresses as</term> <listitem><para> Email addresses to send to. This will be used in addition to address. </para><para> This option was added in version 3. </para></listitem> </varlistentry> <varlistentry> <term>cc as</term> <listitem><para> Email addresses to cc. </para><para> This option was added in version 3. </para></listitem> </varlistentry> <varlistentry> <term>bcc as</term> <listitem><para> Email addresses to bcc. </para><para> This option was added in version 3. </para></listitem> </varlistentry> <varlistentry> <term>subject s</term> <listitem><para> The subject for the email. </para></listitem> </varlistentry> <varlistentry> <term>body s</term> <listitem><para> The body for the email. </para></listitem> </varlistentry> <varlistentry> <term>attachment_fds ah</term> <listitem><para> File descriptors for files to attach. </para></listitem> </varlistentry> </variablelist> All the keys in the options are are optional. --> <method name="ComposeEmail"> <annotation name="org.gtk.GDBus.C.UnixFD" value="true"/> <arg type="s" name="parent_window" direction="in"/> <arg type="a{sv}" name="options" direction="in"/> <arg type="o" name="handle" direction="out"/> </method> <property name="version" type="u" access="read"/> </interface> </node>