== DESCRIPTION
This program allows to make a two-way gateway between your WhatsApp account
and your email address.

This means that this program:
 (1) Will receive your WhatsApp messages and forward them to your email address
     AND
 (2) It will listen for incoming emails and forward them to WhatsApp.

== INSTALL
You will need to install yowsup and the dependencies:
    pip install yowsup2 python-axolotl parse

Then to configure this app, copy and edit the config file in YAML:
    cp config.yaml.example config.yaml
    edit whatsapp_config

Small descriptions of the parts are provided below:

    reply: The email address template that's used to reply to WhatsApp messages
        forwarded by email, eg: myaccount+{}@gmail.com . Note that the {} is
        replaced by the destination phone number.

    whatsapp: Section containing WhatsApp credentials
        phone: Your phone number using the international format (2 numbers),
            then your local number without the leading zero, eg: 41791234567
        password: Your WhatsApp password, you should have it already or you
            need to register, read:
                tgalal/yowsup#195 (comment)

    outgoing: Section to configure forwarding of WhatsApp messages by email,
        the program will connect to the SMTP server with the provided
        information.
        with: SMTP # single possible value for now
        host: SMTP server address
        port: SMTP server port
        user: SMTP username to auth (can be empty)
        pass: SMTP password to auth (can be empty)
        sendto: Address which receives the WhatsApp messages
        ssl: 1 or 0 to toggle to connect with SSL
        force_starttls: 1 or 0 to toggle force STARTSSL at connection time

    ingoing: Section to configure listening for emails to forward them
        with: SMTP or LMTP (look at the example configuration)

        host: Socket is bind for this address (eg: localhost). SMTP only.
        host: Socket is bind for this port (eg: 2500). SMTP only.
        socket: File path of the unix domain socket that listen for incoming
            email that will be forwarded on WhatsApp. LMTP only.