.. image:: https://img.shields.io/pypi/v/efb-fb-messenger-slave.svg :alt: PyPI release :target: https://pypi.org/project/efb-fb-messenger-slave/ .. image:: https://pepy.tech/badge/efb-fb-messenger-slave/month :alt: Downloads per month :target: https://pepy.tech/project/efb-fb-messenger-slave .. image:: https://d322cqt584bo4o.cloudfront.net/ehforwarderbot/localized.svg :alt: Translate this project :target: https://crowdin.com/project/ehforwarderbot/
.. image:: https://github.com/ehForwarderBot/efb-fb-messenger-slave/raw/master/banner.png :alt: Banner
README in other languages_.
.. TRANSLATORS: change the URL on previous line as "." (without quotations). .. _README in other languages: ./readme_translations
Channel ID: blueset.fbmessenger
EFMS is a channel that connects to Facebook Messenger for EH Forwarder
Bot, based on simulation of Facebook Messenger Web, and
fbchat <https://github.com/carpedm20/fbchat>_.
Install required binary dependencies
Install
.. code:: shell
pip3 install efb-fb-messenger-slave
Enable and configure EFMS using the EFB configuration wizard, or enable
it manually in the profile’s config.yaml.
The path to the current profile may vary depends on your configuration.
(In EFB 2, the default profile path is
~/.ehforwarderbot/profiles/default )
Sign in (only if setting up manually)
.. code:: shell
$ efms-auth
And follow the instructions.
MARKETPLACE type (i.e. messages from interested
buyers on Facebook Marketplace) cannot be processed.EFMS allows user to enable or disable experimental features with the
configuration file. It is located at
<Path to current profile>/blueset.fbmessenger/config.yaml.
Example
.. code:: yaml
# Experimental flags
# This section can be used to enable experimental functionality.
# However, those features may be changed or removed at any time.
# Options in this section is explained afterward.
flags:
option_one: 10
option_two: false
option_three: "foobar"
Tips and tricks
---------------
- To send large emoji, send the emoji as text following by ``S``,
``M``, or ``L`` as small, medium and large emoji accordingly.
For example, to send a large smile emoji, send ``😆L``.
Experimental flags
------------------
The following flags are experimental features, may change, break, or
disappear at any time. Use at your own risk.
- ``proxy_links_by_facebook`` *(bool)* [Default: ``false``]
Deliver links (including links in share entities and thumbnails)
using Facebook’s proxy. Disable this option to show the source
directly.
- ``send_link_with_description`` *(bool)* [Default: ``false``]
When processing link message from the Master Channel, attach the
title and description besides the link when the option is enabled.
.. note::
Regardless of this option, link messages are sent as text, and
Facebook Messenger may or may not attach its own link preview per its
system configuration.*
- ``show_pending_threads`` *(bool)* [Default: ``false``]
When showing the threads list, include threads pending approval.
- ``show_archived_threads`` *(bool)* [Default: ``false``]
When showing the threads list, include archived threads.
Vendor-specifics
----------------
EFMS’s chats provides the following vendor specific options:
* ``'chat_type'`` *(str)*: Type of the thread: ``'User'``, ``'Page'``, or
``'Group'``.
* ``'profile_picture_url'`` *(str)*: URL to the thread’s
profile picture.
License
-------
EFMS is licensed under `GNU Affero General Public License 3.0`_ or later versions::
EFB Facebook Messenger Slave Channel: A slave channel for EH Forwarder Bot.
Copyright (C) 2016 - 2020 Eana Hufwe, and the EFB Facebook Messenger Slave Channel contributors
All rights reserved.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
.. _GNU Affero General Public License 3.0: https://www.gnu.org/licenses/agpl-3.0.txt
Translations support
--------------------
EFMS supports translated user interface prompts,
by setting the locale environmental variable (``LANGUAGE``,
``LC_ALL``, ``LC_MESSAGES`` or ``LANG``) to one of our
`supported languages`_. Meanwhile, you can help to translate
this project into your languages on `our Crowdin page`_.
.. _supported languages: https://crowdin.com/project/ehforwarderbot/
.. _our Crowdin page: https://crowdin.com/project/ehforwarderbot/
.. note::
If your are installing from source code, you will not get translations
of the user interface without manual compile of message catalogs (``.mo``)
prior to installation.