Added README and license information. v0.1
authorGabriel Pérez-Cerezo <gabriel@gpcf.eu>
Mon, 6 Oct 2014 10:33:20 +0000 (12:33 +0200)
committerGabriel Pérez-Cerezo <gabriel@gpcf.eu>
Mon, 6 Oct 2014 10:33:20 +0000 (12:33 +0200)
LICENSE [new file with mode: 0644]
README [new file with mode: 0644]
getmail.sh
savemail.py
sendmail.sh

diff --git a/LICENSE b/LICENSE
new file mode 100644 (file)
index 0000000..306bd71
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+The MIT license
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..f18c636
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@
+MAIL TOOLS
+
+This set of tools provides a simple way to receive and send mail over
+SSH if the server and your computer use maildirs. 
+
+getmail.sh moves the mail from the server to your inbox, deleting the
+copy left on the server.
+
+savemail.py is a script that emulates sendmail. It saves your outgoing
+mail to your queue folder.
+
+sendmail.sh sends your mail using your server.
+
+
+CONFIGURATION
+
+To configure it, you need to copy the following lines into ~/.mail_config.sh:
+
+queue=   #The directory that will be used as the mail queue
+queuecur=$queue/cur
+inbox=   #The directory that will be used as the inbox.
+inboxnew=$inbox/new
+inboxcur=$inbox/cur
+server= # The name of the server where your mail is stored and sent.
+ccregexp= # This should match the CC header added to your outgoing mail.
+serverdir= # The directory where your mail is stored on your server.
+
+
+COPYRIGHT
+
+Copyright (C) 2014 Gabriel Pérez-Cerezo, see LICENSE file for more
+details.
\ No newline at end of file
index 9666095..081f947 100755 (executable)
@@ -1,5 +1,8 @@
 #/bin/bash 
 
+# Copyright (C) 2014 Gabriel Pérez-Cerezo <gabriel@gpcf.eu>
+# See LICENSE file for license details.
+
 # This script fetches mail over rsync and then deletes the messages
 # left on the server.
 source ~/.mail_config.sh
index 5b06980..8bc1b6f 100755 (executable)
@@ -1,7 +1,9 @@
 #!/usr/bin/python
 # This script takes email mesages from stdin and
 # saves them in a maildir.
-# Copyright (c) 2014 Gabriel Perez-Cerezo <http://gpcf.eu>
+
+# Copyright (C) 2014 Gabriel Pérez-Cerezo <gabriel@gpcf.eu>
+# See LICENSE file for license details.
 
 import sys, mailbox
 from shutil import move
index 400141c..3d1f2ab 100755 (executable)
@@ -2,19 +2,27 @@
 # This script sends the messages in the maildir using ssh
 # It stops execution if the connection fails.
 
+# Copyright (C) 2014 Gabriel Pérez-Cerezo <gabriel@gpcf.eu>
+# See LICENSE file for license details.
+
+
 source ~/.mail_config.sh
 ssh-add -l > /dev/null || ssh-add < /dev/null
 cd $queuecur
 for i in $(ls $queuecur); 
 do 
-    # if the message is cced to me, copy it directly to my inbox.
-    line=$(grep -m 1 -n -e $ccregexp < $i | cut -d : -f 1)
-    if [ -n "$line" ]
+    # if the message is cced to me, copy it directly to my inbox (read
+    # section). 
+    if [ -n "$ccregexp" ]
     then
-       cp $i $inboxcur
-       sed -i"" -e "${line}d" -i $i # and delete the CC header
+       line=$(grep -m 1 -n -e $ccregexp < $i | cut -d : -f 1)
+       if [ -n "$line" ]
+       then
+           cp $i $inboxcur
+           sed -i"" -e "${line}d" -i $i # and delete the CC header
+       fi
+       # send the message over SSH.
     fi
-    # send the message over SSH.
     echo /usr/lib/sendmail -t | cat - $i | ssh -o ConnectTimeout=10 $server || break
     rm $i
 done