README.md

   1 # response-pending
   2
   3 response-pending is a system that reminds users when selected emails receive no
   4 response in the desired amount of time.
   5
   6 ## Installation
   7
   8 * Make the user account `USERNAMEemail`, where `USERNAME` is your user name.
   9
  10         # useradd USERNAMEemail
  11
  12 * Copy this repository to that new user's home directory and continue the
  13   installation as that user.
  14
  15         $ login USERNAMEemail
  16
  17 * Initialize the `~/Mail` directory structure:
  18
  19         $ make setup
  20
  21 * Edit `~/Mail/Data/response-pending.config.example` and then remove the
  22   `.example` suffix.
  23
  24 * Edit `~/procmailrc.example`, replacing both occurrences of the word
  25   `USERNAME` with your user name. Do the same for `DOMAIN.org`. You can specify
  26 multiple domains by using the `(DOMAIN_1.org|DOMAIN_2.net)` syntax. Integrate
  27 this file with your current `.procmailrc` file, or put the file there if you
  28 don't have one yet.
  29
  30 * Edit the `/etc/aliases` file and add the following entries (replacing
  31   `USERNAME` with your user name. It's probably easiest to use your text
  32 editor's find and replace feature.):
  33
  34         USERNAME: \USERNAME, USERNAMEemail
  35         USERNAME-response-1d: USERNAMEemail
  36         USERNAME-response-2d: USERNAMEemail
  37         USERNAME-response-3d: USERNAMEemail
  38         USERNAME-response-4d: USERNAMEemail
  39         USERNAME-response-5d: USERNAMEemail
  40         USERNAME-response-6d: USERNAMEemail
  41         USERNAME-response-1w: USERNAMEemail
  42         USERNAME-response-2w: USERNAMEemail
  43         USERNAME-response-3w: USERNAMEemail
  44         USERNAME-response-4w: USERNAMEemail
  45         USERNAME-response-5w: USERNAMEemail
  46         USERNAME-response-6w: USERNAMEemail
  47         USERNAME-response-1m: USERNAMEemail
  48         USERNAME-response-2m: USERNAMEemail
  49         USERNAME-response-3m: USERNAMEemail
  50
  51     (The backslash on the first line is intended.) You may need to log in as
  52 root to make these changes.
  53
  54 * Add the following lines to your crontab:
  55
  56         $ crontab -e
  57         46 3 * * * HOMEDIR_USERNAMEemail/Mail/Programs/feed-response-pending.pl
  58         52 0 * * * find HOMEDIR_USERNAMEemail/Mail/Archives -type f -ctime +180 |grep -v reminders-sent |xargs rm -f
  59
  60     Make sure to replace `HOMEDIR_USERNAMEemail` with the proper
  61 system-dependent path. Get your home directory path like this:
  62
  63         $ echo $HOME
  64         /home/u/usernameemail/
  65
  66     You may wish to edit the time at which these scripts run. The time is
  67 specified by the first two colums in "`MM HH`" format.
  68
  69 * Send a few test emails to a secondary address that you own as described in
  70   the next section. Reply to some but not all of them and wait for the
  71 reminders to appear in your inbox.
  72
  73 ## Usage
  74
  75 When sending an email that you wish to remind yourself of if no response is
  76 given, add `USERNAME-response-1d@DOMAIN.org` to the `Bcc:` field of your email.
  77 The `1d` part means to remind in one day and can be replaced by other dates:
  78
  79 * `-1d`, `-2d`, `-3d`, `-4d`, `-5d`, `-6d`, `-1w`, `-2w`, `-3w`, `-4w`, `-5w`, `-6w`,
  80   `-1m`, `-2m` or `-3m`
  81