git.fiddlerwoaroof.com
Browse code

Moving readme to a markdown format.

Elliott Johnson authored on 05/06/2009 23:27:51
Showing 2 changed files
1 1
deleted file mode 100644
... ...
@@ -1,117 +0,0 @@
1
-imap: A common lisp library for sending and receiving email.
2
-
3
-**********************************************************************
4
-
5
-Table of contents:
6
-
7
-   1. Description
8
-   2. Author
9
-   3. Author comments
10
-   4. Documentation
11
-   5. Platforms
12
-   6. Dependencies
13
-   7. Installation
14
-   8. Configuration
15
-   9. Licence
16
-  10. Notes
17
-  11. Examples
18
-  12. Open Source 
19
-
20
-**********************************************************************
21
-
22
-   1. Description:
23
-
24
-      A client library for sending and receiving email.
25
-
26
-   2. Author:
27
-
28
-      John Foderaro
29
-
30
-   3. Author comments:
31
-
32
-      The most popular protocol for accessing a mailbox was the Post
33
-      Office Protocol (POP) defined in rfc1939.  While it is popular
34
-      pop has very few features. It doesn't allow you to manage the
35
-      mail on the server itself, instead you usually just download all
36
-      mail to your local machine. A much more powerful protocol called
37
-      the Internet Message Access Protocol (IMAP) was defined in the
38
-      1996 document rfc2060. With imap you can work with your mail
39
-      while it's on the server and can create folders on the server in
40
-      which to archive your mail. Thus the server itself can be the
41
-      message store which is useful if you want to access your mail
42
-      from more than one machine. You are not required to use the
43
-      server to archive your mail with imap, you can use it like pop
44
-      and download all the mail to your local machine.
45
-
46
-      Sending email is done via the Simple Mail Transfer Protocol
47
-      (SMTP). You can use smtp to send mail directly to the
48
-      destination but typically this is not done because the
49
-      destination machine may be down or unreachable at the time you
50
-      wish to send the mail. Most organizations have a local mail
51
-      server that is up and reachable all of the time. You can use
52
-      smtp to send your letter to that local mail server and it will
53
-      then take over the job of getting the mail to the destination
54
-      (which may involve queueing the message and retrying to send it
55
-      over a period of days).
56
-
57
-   4. Platforms:
58
-          
59
-      Allegro Common Lisp 7.0 and newer on all platforms.
60
-
61
-   5. Dependencies:
62
-
63
-      None, but for the test suite, tester is required and can be
64
-      found on http://opensource.franz.com
65
-
66
-   6. Installation:
67
-
68
-      a. Start acl
69
-
70
-      b. load the load.cl file
71
-
72
-        :ld /path/to/load.cl
73
-
74
-   7. Configuration:
75
-
76
-      The net.post-office::*debug-imap* and net.post-office::*smtp-debug*  
77
-      variables, when set to true will produce extra debug information.
78
- 
79
-   8. Documentation:
80
-
81
-      For pop and imap interfaces see:
82
-
83
-        http://franz.com/support/documentation/current/doc/imap.htm
84
-
85
-      For the smtp interface see:
86
-
87
-        http://franz.com/support/documentation/current/doc/imap.htm#smtp-1
88
-
89
-      Also see the imap.html file that is included with this source
90
-      code.
91
-
92
-   9. License:
93
-
94
-      The aserve source code is licensed under the terms of the Lisp
95
-      Lesser GNU Public License, known as the LLGPL. The LLGPL
96
-      consists of a preamble and the LGPL. Where these conflict, the
97
-      preamble takes precedence. imap is referenced in the preamble as
98
-      the LIBRARY. (http://opensource.franz.com/preamble.html)
99
- 
100
-  10. Notes:
101
-
102
-      For reference please see rfc1939 (pop) and rfc2060 (imap).
103
- 
104
-  11. Examples and Information:
105
-
106
-      See the first link in the documenation section (#8) above for
107
-      examples.  
108
-
109
-  12. Open Source:
110
-
111
-      This project is hosted on the http://opensource.franz.com
112
-      site. There is an informal community support and development
113
-      mailing list (opensource@franz.com) for these open source
114
-      projects. We encourage you to take advantage by subscribing to
115
-      the list by visiting http://opensource.franz.com/mailinglist.html.
116
-      Once you're subscribed, send email to opensource@franz.com with
117
-      your questions, comments, suggestions, and patches. 
118 0
new file mode 100644
... ...
@@ -0,0 +1,118 @@
1
+imap: A common lisp library for sending and receiving email.
2
+============================================================
3
+
4
+Table of contents
5
+-----------------
6
+
7
+ * Description
8
+ * Author
9
+ * Author comments
10
+ * Documentation
11
+ * Platforms
12
+ * Dependencies
13
+ * Installation
14
+ * Configuration
15
+ * Licence
16
+ * Notes
17
+ * Examples
18
+ * Open Source 
19
+
20
+Description
21
+-----------
22
+
23
+A client library for sending and receiving email.
24
+
25
+Author
26
+------
27
+
28
+John Foderaro, Franz Inc.
29
+
30
+Author comments
31
+---------------
32
+
33
+The most popular protocol for accessing a mailbox was the Post Office
34
+Protocol (POP) defined in rfc1939.  While it is popular, pop has very
35
+few features. It doesn't allow you to manage the mail on the server
36
+itself, instead you usually just download all mail to your local
37
+machine. A much more powerful protocol called the Internet Message
38
+Access Protocol (IMAP) was defined in the 1996 document rfc2060. With
39
+imap you can work with your mail while it's on the server and can
40
+create folders on the server in which to archive your mail. Thus the
41
+server itself can be the message store which is useful if you want to
42
+access your mail from more than one machine. You are not required to
43
+use the server to archive your mail with imap, you can use it like pop
44
+and download all the mail to your local machine.
45
+
46
+Sending email is done via the Simple Mail Transfer Protocol
47
+(SMTP). You can use smtp to send mail directly to the destination but
48
+typically this is not done because the destination machine may be down
49
+or unreachable at the time you wish to send the mail. Most
50
+organizations have a local mail server that is up and reachable all of
51
+the time. You can use smtp to send your letter to that local mail
52
+server and it will then take over the job of getting the mail to the
53
+destination (which may involve queueing the message and retrying to
54
+send it over a period of days).
55
+
56
+Platforms
57
+---------
58
+
59
+Allegro Common Lisp 7.0 and newer on all platforms.
60
+
61
+Dependencies
62
+------------
63
+
64
+None, but for the test suite, [tester](http://opensource.franz.com)
65
+is required.
66
+
67
+Installation
68
+------------
69
+
70
+Start Allegro Common Lisp and load the load.cl file
71
+    :ld /path/to/load.cl
72
+
73
+Configuration
74
+-------------
75
+
76
+Set the following variables to true for extra debugging information:
77
+
78
+    (setq net.post-office::*debug-imap* t 
79
+          net.post-office::*smtp-debug* t)
80
+ 
81
+Documentation
82
+-------------
83
+
84
+ * [pop and imap interfaces]
85
+   (http://franz.com/support/documentation/current/doc/imap.htm)
86
+ * [smtp interface]
87
+   (http://franz.com/support/documentation/current/doc/imap.htm#smtp-1)
88
+ * Also see the imap.html file that is included with this source code.
89
+
90
+License
91
+-------
92
+
93
+The aserve source code is licensed under the terms of the 
94
+[Lisp Lesser GNU Public License](http://opensource.franz.com/preamble.html), 
95
+known as the LLGPL. The LLGPL consists of a preamble and the LGPL. Where these 
96
+conflict, the preamble takes precedence.  This project is referenced in the 
97
+preamble as the LIBRARY.
98
+ 
99
+Notes
100
+-----
101
+
102
+For reference please see rfc1939 (pop) and rfc2060 (imap).
103
+ 
104
+Examples and Information
105
+------------------------
106
+
107
+See the first link in the documenation section above for examples.  
108
+
109
+Franz Inc. Open Source Info
110
+---------------------------
111
+
112
+This project's homepage is <http://opensource.franz.com>. There is an 
113
+informal community support and development mailing list 
114
+[opensource@franz.com](http://opensource.franz.com/mailinglist.html) 
115
+for these open source projects. We encourage you to take advantage by 
116
+subscribing to the list.  Once you're subscribed, email to 
117
+<opensource@franz.com> with your questions, comments, suggestions, 
118
+and patches.