Mercurial > libervia-backend

comparison doc/components.rst @ 4304:92a886f31581 default tip @

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (components): new Email gateway documentation: fix 449
author Goffi <goffi@goffi.org>
date Fri, 06 Sep 2024 18:07:44 +0200
parents 6276242736c3
children
comparison
equal deleted inserted replaced
4303:a7ec325246fb 4304:92a886f31581
890 890
891 The component currently integrates the `Galène project`_, as it is a complete, simple, and 891 The component currently integrates the `Galène project`_, as it is a complete, simple, and
892 easy to install service. Other projects may be integrated in the future if the need 892 easy to install service. Other projects may be integrated in the future if the need
893 arises. 893 arises.
894 894
895 .. note::
896
897 This component is **work in progress** and under heavy development.
898
899 Please ensure that Galène is already installed on your device. 895 Please ensure that Galène is already installed on your device.
900 896
901 If the ``galene`` executable is not in your ``PATH`` environment variable, you can specify its 897 If the ``galene`` executable is not in your ``PATH`` environment variable, you can specify its
902 location using the ``galene_path`` option (see below). 898 location using the ``galene_path`` option (see below).
903 899
918 The port used by the Galène HTTP server. 914 The port used by the Galène HTTP server.
919 915
920 **default**: 9443 916 **default**: 9443
921 917
922 .. _Galène project: https://galene.org/ 918 .. _Galène project: https://galene.org/
919
920
921 Email Gateway
922 -------------
923
924 **entry_point:** ``email-gateway``
925
926 .. note::
927
928 This component is **work in progress** and under heavy development.
929
930 This gateway links the email network and XMPP in both directions. It allows sending and
931 receiving emails using XMPP clients.
932
933 The gateway uses an existing email account configured using IMAP4 and SMTP. IMAP4 is used
934 for reception and the server must support IMAP4 rev1 protocol with the "IDLE" extension
935 for real-time notifications. SMTP is used for sending emails.
936
937 To use the gateway, one must register through `XEP-0100 (Gateway Interaction)`_. Once
938 registered, connection to the IMAP server is started immediately, and new emails in the
939 ``INBOX`` mailbox are received as XMPP messages.
940
941 For the moment, mailboxes are used in read-only mode, meaning that the read status and
942 other attributes are not changed, and messages will appear normally in other MUA (email
943 clients).
944
945 To send a message, just write to the corresponding JID. Email addresses are mapped to JIDs
946 using `XEP-0106 (JID Escaping)`_: the email is escaped and used as the user-part of the
947 gateway JID.
948
949 .. _XEP-0100 (Gateway Interaction): https://xmpp.org/extensions/xep-0100.html
950 .. _XEP-0106 (JID Escaping): https://xmpp.org/extensions/xep-0106.html
951