# Mastomail

## Overview

Mastomail is a Python script that fetches replies from your Mastodon 
account and emails them to you. Each email includes the reply, the 
time it was posted, a URL to view the reply on Mastodon, and the toot 
being replied to.

## Requirements

    Python 3.x
    Mastodon.py (A Python wrapper for the Mastodon API)
    Access to an SMTP server for sending emails

## Installation

1. Clone the Repository:

    git clone https://jxself.org/git/?p=mastomail.git 
    cd mastomail

2. Install Mastodon.py

3. Configuration

    First Run Configuration for Mastodon Credentials:
        Uncomment the register_app() and authenticate_user() functions 
        on your first run, then comment them out for subsequent runs.
        This will register a new application on your Mastodon instance 
        to otain your Mastodon access tokens.

    Email Settings:
        Configure the sender and receiver email addresses.
        Set up SMTP server details.

## Usage

    First Run Configuration:
        Uncomment the register_app() and authenticate_user() functions 
        on your first run, then comment them out for subsequent runs.
        This will register a new application on your Mastodon instance
        to otain your Mastodon access tokens.

    Running the Script:
        Run the script using Python:

        python3 mastomail.py

    Scheduling:
        Optionally, you can schedule the script to run at regular 
        intervals using cron jobs.

## Features

    Fetches new replies from your Mastodon account.
    Emails the replies with detailed information.
    Preserves URL links in the email content.
    Avoids sending duplicate emails for already fetched replies.

## Security Notes

    Ensure your Mastodon access token and email passwords are 
    securely stored.
    Do not share your tokens and passwords in the script when 
    distributing or version controlling.

## Contributing

Contributions, bug reports, and feature requests are welcome.

## License

Mastomail is free software: you can redistribute it and/or modify it 
under the terms of the GNU General Public License as published by the 
Free Software Foundation, either version 3 of the License, or (at your 
option) any later version.

## Contact

Jason Self - j@jxself.org

## Project Link

<https://jxself.org/git/mastomail.git>

--
This file is Copyright (C) 2024 Jason Self <j@jxself.org>.

You can redistribute and/or modify this file under the terms of the 
GNU General Public License as published by the Free Software 
Foundation, either version 3 of the License, or (at your option) any 
later version.

This file 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 General Public License 
along with this file. If not, see <https://www.gnu.org/licenses/>.