projects.mako.cc - attachcheck/blob - README.rst

   1 AttachCheck
   2 =============
   3
   4 :Author: Benjamin Mako Hill <mako@debian.org>
   5 :Date: Mon,  4 Jul 2005 04:42:03 -0400
   6 :Copyright: GNU General Public License
   7
   8 How many times have you said, "I've attached the file below," and then
   9 failed to actually attach the file? It happens to even the best of us.
  10
  11 AtttachCheck is a program that seeks to end this forever. AttachCheck
  12 looks through all outgoing mail. If it expects an attachment and doesn't
  13 see one, it refuses to send it until you confirm that you really want to
  14 send the message sans attachment.
  15
  16 AttachCheck It was written in Benjamin Mako Hill. You can find the
  17 latest version of this program, more information, and some of Mako's
  18 sometime accidentally insightful or useful ideas at his eponymous
  19 homepage at: http://mako.cc
  20
  21 Prerequisites
  22 --------------
  23
  24 * AttachCheck is written in Python. You will need to have Python
  25   installed in our system.
  26
  27 * You will need to deliver mail to locally (i.e., not over SMTP to
  28   another machine).
  29
  30 * You will need to be able to configure you mail client to deliver to a
  31   differnet location on your system.
  32
  33 If you use OutLook and Windows, I found a similar program for that
  34 setup: http://www.danevans.co.uk/vba/
  35
  36
  37 How AttachCheck Works
  38 ----------------------
  39
  40 AttachCheck monitors outgoing mail for keywords. It expects attachment
  41 if it finds a text-based attachment if it finds one of the following
  42 words:
  43
  44 * Attach
  45 * Attached
  46 * Attaching
  47 * Attachment
  48
  49 If you can think of other words (in any language) that are indicative of
  50 attachments, please contact the author of the program so others can
  51 benefit as well.
  52
  53 AttachCheck is basically just a wrapper for your mail transfer agent
  54 (MTA). It takes mail on STDIN, checks it, and then passes it on to your
  55 *real* MTA or exits with an error if there is no attachment and it
  56 expects.
  57
  58 Sometimes you may talk about attachments when you don't include any.
  59 AttachCheck will stop you in these cases but you'll need to
  60 confirm/override it by hand. This can be one in one of two ways:
  61
  62 1. Adding the word "CONFIRM" in all capital letters in the beginning of
  63    the subject line of your outgoing mail. AttachCheck will remove
  64    the word when the mail is sent.
  65
  66 2. Adding a special header that like this: ``X-AttachCheck-Override:
  67    Yes``
  68
  69
  70 Enabling AttachCheck in Mutt
  71 -----------------------------
  72
  73 AttachCheck was written for and tested with Mutt and it works great
  74 under that client. I got AttachCheck working by adding the following two
  75 lines to my muttrc file::
  76
  77  set sendmail='~/bin/attachcheck'
  78  macro compose \e0 ':set editor="~/bin/ac_add_override.pl"<enter>e:set editor=vim<enter>'
  79
  80 This will set up the sendmail wrapper so that attachcheck is used and
  81 then set up a macro bound to a key (in this case `META`-0) that will add
  82 the override line into your mail with a single keystroke.
  83
  84 You'll of course want to customize these lines to include your editor
  85 choice and to include the actual path of ``attachcheck`` and the
  86 ``add_override.pl``.
  87
  88 Copyright / Information
  89 -------------------------
  90
  91 copyright (c) 2005 Benjamin Mako Hill <mako@debian.org>
  92
  93  This package is free software; you can redistribute it and/or modify it
  94  under the terms of the GNU General Public License as published by the
  95  Free Software Foundation; either version 2 of the License, or (at your
  96  option) any later version.
  97
  98  This package is distributed in the hope that it will be useful, but
  99  WITHOUT ANY WARRANTY; without even the implied warranty of
 100  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 101  General Public License for more details.
 102
 103  You should have received a copy of the GNU General Public
 104  License along with this package; if not, write to the Free Software
 105  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 106
 107 On Debian systems, the complete text of the GNU General Public License
 108 can be found in /usr/share/common-licenses/GPL. It is also distributed
 109 in full with AttachCheck in the ``COPYING`` file.
 110
 111