README

   1 # Mastomail
   2
   3 ## Overview
   4
   5 Mastomail is a Python script that fetches replies from your Mastodon
   6 account and emails them to you. Each email includes the reply, the
   7 time it was posted, a URL to view the reply on Mastodon, and the toot
   8 being replied to.
   9
  10 ## Requirements
  11
  12     Python 3.x
  13     Mastodon.py (A Python wrapper for the Mastodon API)
  14     Access to an SMTP server for sending emails
  15
  16 ## Installation
  17
  18 1. Clone the Repository:
  19
  20     git clone https://jxself.org/git/?p=mastomail.git
  21     cd mastomail
  22
  23 2. Install Mastodon.py
  24
  25 3. Configuration
  26
  27     First Run Configuration for Mastodon Credentials:
  28         Uncomment the register_app() and authenticate_user() functions
  29         on your first run, then comment them out for subsequent runs.
  30         This will register a new application on your Mastodon instance
  31         to otain your Mastodon access tokens.
  32
  33     Email Settings:
  34         Configure the sender and receiver email addresses.
  35         Set up SMTP server details.
  36
  37 ## Usage
  38
  39     First Run Configuration:
  40         Uncomment the register_app() and authenticate_user() functions
  41         on your first run, then comment them out for subsequent runs.
  42         This will register a new application on your Mastodon instance
  43         to otain your Mastodon access tokens.
  44
  45     Running the Script:
  46         Run the script using Python:
  47
  48         python3 mastomail.py
  49
  50     Scheduling:
  51         Optionally, you can schedule the script to run at regular
  52         intervals using cron jobs.
  53
  54 ## Features
  55
  56     Fetches new replies from your Mastodon account.
  57     Emails the replies with detailed information.
  58     Preserves URL links in the email content.
  59     Avoids sending duplicate emails for already fetched replies.
  60
  61 ## Security Notes
  62
  63     Ensure your Mastodon access token and email passwords are
  64     securely stored.
  65     Do not share your tokens and passwords in the script when
  66     distributing or version controlling.
  67
  68 ## Contributing
  69
  70 Contributions, bug reports, and feature requests are welcome.
  71
  72 ## License
  73
  74 Mastomail is free software: you can redistribute it and/or modify it
  75 under the terms of the GNU General Public License as published by the
  76 Free Software Foundation, either version 3 of the License, or (at your
  77 option) any later version.
  78
  79 ## Contact
  80
  81 Jason Self - j@jxself.org
  82
  83 ## Project Link
  84
  85 <https://jxself.org/git/mastomail.git>
  86
  87 --
  88 This file is Copyright (C) 2024 Jason Self <j@jxself.org>.
  89
  90 You can redistribute and/or modify this file under the terms of the
  91 GNU General Public License as published by the Free Software
  92 Foundation, either version 3 of the License, or (at your option) any
  93 later version.
  94
  95 This file is distributed in the hope that it will be useful, but
  96 WITHOUT ANY WARRANTY; without even the implied warranty of
  97 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  98 General Public License for more details.
  99
 100 You should have received a copy of the GNU General Public License
 101 along with this file. If not, see <https://www.gnu.org/licenses/>.