source: trunk/j/doc/mail.html @ 2

Last change on this file since 2 was 2, checked in by piso, 18 years ago

Initial checkin.

File size: 7.9 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2
3<html>
4
5<head>
6<title>J User's Guide - Mail</title>
7<LINK REL="stylesheet" HREF="j.css" TYPE="text/css">
8</head>
9
10<body>
11
12<a href="contents.html">Top</a>
13
14<hr>
15
16<h1>Mail</h1>
17
18<hr>
19
20<p>
21  J provides support for IMAP, POP and SMTP. (By coincidence, it's also
22  possible to use the <a href="commands.html#openMailbox">openMailbox</a>
23  command to open a read-only view of a Unix mbox-style mailbox, but that's
24  not officially sanctioned yet.)
25  <br><br>
26  To set up mail, you need to add a few lines to your
27  <a href="preferences.html">preferences</a> file:
28
29  <pre>
30    enableExperimentalFeatures = true
31    enableMail = true
32
33    # Default "From" address information.
34    userFullName = Peter Graves
35    userMailAddress = peter@armedbear.org
36
37    # The SMTP server to be used for sending mail.
38    smtp = annie</pre>
39
40  (Your name, mail address and SMTP server may be different. On a Unix system,
41  setting smtp to "localhost" might work.)
42  <br><br>
43  You might also want to specify a default mailbox for the
44  <a href="commands.html#inbox">inbox</a> command:
45
46  <pre>
47    inbox = {peter@annie}inbox</pre>
48
49  You can also get j to send automatic blind copies of outgoing messages:
50  <pre>
51    bcc = peter@armedbear.org</pre>
52
53  To read mail, use the <a href="commands.html#openMailbox">openMailbox</a>
54  command. For IMAP, mailbox URLs should look like this:
55
56  <pre>
57    {user@host}folder</pre>
58
59  For example:
60
61  <pre>
62    {peter@annie}inbox
63    {peter@annie}/var/spool/mail/peter
64    {peter@annie}mail/j</pre>
65
66  For POP, mailbox URLs should look like this:
67
68  <pre>
69    pop://user@host</pre>
70
71  For example:
72
73  <pre>
74    pop://peter@annie
75    pop://pgraves@vipmail.com</pre>
76
77  Once you're in your mailbox, you can use
78  <a href="commands.html#mailboxReadMessage">mailboxReadMessage</a>, mapped by
79  default to Enter, to read the message at the current location of the caret.
80  <br><br>
81  To compose mail, use the <a href="commands.html#compose">compose</a>
82  command. You can also use
83  <a href="commands.html#messageReplyToSender">messageReplyToSender</a>
84  or <a href="commands.html#messageReplyToGroup">messageReplyToGroup</a> to
85  reply to a message you're reading.
86  <br><br>
87  In a message composition buffer, the header lines at the top of the buffer
88  will be sent verbatim with your message, with the exception of lines listing
89  attachments. You can edit the default header lines or add additional ones.
90  You should leave the message separator line ("--text follows this line--")
91  alone; j uses it to mark the end of the message headers, and it will be
92  removed automatically before the message is actually sent.
93  <br><br>
94  Automatic word wrap is on by default in mail composition buffers (except for
95  the header lines). You can use
96  <a href="commands.html#toggleWrap">toggleWrap</a> to turn it off. By
97  default, <a href="preferences.html#wrapCol">wrapCol</a> is 72 in mail
98  composition buffers. To change this, add a line like this to your
99  <a href="preferences.html">preferences</a> file:
100  <pre>
101    SendMailMode.wrapCol = 80</pre>
102  You can use the command <a href="commands.html#attachFile">attachFile</a> to
103  attach one or more files to your outgoing message.
104  <br><br>
105  When you're ready, use the <a href="commands.html#send">send</a> command to
106  send your message.
107  <br><br>
108  By default, j never deletes any messages in your POP mailbox on the server.
109  You can configure j to delete messages on the server after they have been
110  successfully retrieved by adding this line to your
111  <a href="preferences.html">preferences</a> file:
112
113  <pre>
114    popKeepMessagesOnServer = false</pre>
115
116  If you prefer, you can configure j to keep messages on the server when they
117  are first retrieved, but delete them on the server when you have deleted and
118  expunged them locally. To do so, add these two lines to your
119  <a href="preferences.html">preferences</a> file:
120
121  <pre>
122    popKeepMessagesOnServer = true
123    popExpungeDeletedMessagesOnServer = true</pre>
124
125  The
126  <a href="preferences.html#popKeepMessagesOnServer">popKeepMessagesOnServer
127  </a> and <a href="preferences.html#popExpungeDeletedMessagesOnServer">popExpungeDeletedMessagesOnServer</a>
128  properties only apply to POP mailboxes.
129  <br><br>
130  Until you invoke <a href="commands.html#mailboxExpunge">mailboxExpunge</a>,
131  you can use the command
132  <a href="commands.html#mailboxUndelete">mailboxUndelete</a> to undelete any
133  message that is marked for deletion. This applies to both POP and IMAP
134  mailboxes.
135  <br><br>
136  The following commands are specifically relevant to mail:
137  <ul>
138    <li><a href="commands.html#addGroup">addGroup</a></li>
139    <li><a href="commands.html#attachFile">attachFile</a></li>
140    <li><a href="commands.html#bounceMessage">bounceMessage</a></li>
141    <li><a href="commands.html#compose">compose</a></li>
142    <li><a href="commands.html#expandMailAddress">expandMailAddress</a></li>
143    <li><a href="commands.html#inbox">inbox</a></li>
144    <li><a href="commands.html#mailboxCreateFolder">mailboxCreateFolder</a></li>
145    <li><a href="commands.html#mailboxDelete">mailboxDelete</a></li>
146    <li><a href="commands.html#mailboxDeleteFolder">mailboxDeleteFolder</a></li>
147    <li><a href="commands.html#mailboxExpunge">mailboxExpunge</a></li>
148    <li><a href="commands.html#mailboxFlag">mailboxFlag</a></li>
149    <li><a href="commands.html#mailboxGetNewMessages">mailboxGetNewMessages</a></li>
150    <li><a href="commands.html#mailboxLastMessage">mailboxLastMessage</a></li>
151    <li><a href="commands.html#mailboxLimit">mailboxLimit</a></li>
152    <li><a href="commands.html#mailboxMarkRead">mailboxMarkRead</a></li>
153    <li><a href="commands.html#mailboxMarkUnread">mailboxMarkUnread</a></li>
154    <li><a href="commands.html#mailboxMoveToFolder">mailboxMoveToFolder</a></li>
155    <li><a href="commands.html#mailboxReadMessage">mailboxReadMessage</a></li>
156    <li><a href="commands.html#mailboxSaveToFolder">mailboxSaveToFolder</a></li>
157    <li><a href="commands.html#mailboxStop">mailboxStop</a></li>
158    <li><a href="commands.html#mailboxTag">mailboxTag</a></li>
159    <li><a href="commands.html#mailboxTagPattern">mailboxTagPattern</a></li>
160    <li><a href="commands.html#mailboxToggleRaw">mailboxToggleRaw</a></li>
161    <li><a href="commands.html#mailboxUndelete">mailboxUndelete</a></li>
162    <li><a href="commands.html#mailboxUnlimit">mailboxUnlimit</a></li>
163    <li><a href="commands.html#mailboxUntagAll">mailboxUntagAll</a></li>
164    <li><a href="commands.html#messageDelete">messageDelete</a></li>
165    <li><a href="commands.html#messageFlag">messageFlag</a></li>
166    <li><a href="commands.html#messageForward">messageForward</a></li>
167    <li><a href="commands.html#messageIndex">messageIndex</a></li>
168    <li><a href="commands.html#messageMoveToFolder">messageMoveToFolder</a></li>
169    <li><a href="commands.html#messageNext">messageNext</a></li>
170    <li><a href="commands.html#messageNextInThread">messageNextInThread</a></li>
171    <li><a href="commands.html#messagePrevious">messagePrevious</a></li>
172    <li><a href="commands.html#messagePreviousInThread">messagePreviousInThread</a></li>
173    <li><a href="commands.html#messageReplyToGroup">messageReplyToGroup</a></li>
174    <li><a href="commands.html#messageReplyToSender">messageReplyToSender</a></li>
175    <li><a href="commands.html#messageSaveAttachment">messageSaveAttachment</a></li>
176    <li><a href="commands.html#messageToggleHeaders">messageToggleHeaders</a></li>
177    <li><a href="commands.html#messageToggleRaw">messageToggleRaw</a></li>
178    <li><a href="commands.html#messageViewAttachment">messageViewAttachment</a></li>
179    <li><a href="commands.html#openMailbox">openMailbox</a></li>
180    <li><a href="commands.html#send">send</a></li>
181    <li><a href="commands.html#sendMailBackTab">sendMailBackTab</a></li>
182    <li><a href="commands.html#sendMailTab">sendMailTab</a></li>
183    <li><a href="commands.html#sortByDateSent">sortByDateSent</a></li>
184    <li><a href="commands.html#sortByThread">sortByThread</a></li>
185  </ul>
186</body>
187</html>
Note: See TracBrowser for help on using the repository browser.