/
wl.texi
9356 lines (7469 loc) · 289 KB
/
wl.texi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
\input texinfo @c -*-texinfo -*- coding: us-ascii -*-
@c %**start of header
@setfilename wl.info
@settitle Wanderlust -- Yet Another Message Interface On Emacsen --
@c %**end of header
@documentlanguage en
@include version.texi
@synindex pg cp
@finalout
@dircategory GNU Emacs Lisp
@direntry
* Wanderlust: (wl). Yet Another Message Interface On Emacsen
@end direntry
@c permissions text appears in an Info file before the first node.
@ifinfo
This file documents Wanderlust, Yet another message interface on
Emacsen.
Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
@w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
@w{Kaoru Takahashi}, @w{Bun Mizuhara} and @w{Masayuki Osada},
@w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
This edition is for Wanderlust version @value{VERSION}.
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
@ignore
Permission is granted to process this file through TeX and print the
results, provided the printed document carries copying permission notice
identical to this one except for the removal of this paragraph (this
paragraph not being relevant to the printed manual).
@end ignore
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions.
@end ifinfo
@titlepage
@sp 10
@title Wanderlust User's Manual
@subtitle Yet another message interface on Emacsen
@subtitle for Wanderlust version @value{VERSION}
@author Yuuichi Teranishi
@author Fujikazu Okunishi
@author Masahiro Murata
@author Kenichi Okada
@author Kaoru Takahashi
@author Bun Mizuhara
@author Masayuki Osada
@author Katsumi Yamaoka
@author Hiroya Murata
@author Yoichi Nakayama
@page
@vskip 0pt plus 1filll
Copyright @copyright{} 1998, 1999, 2000, 2001, 2002 @w{Yuuichi Teranishi},
@w{Fujikazu Okunishi}, @w{Masahiro Murata}, @w{Kenichi Okada},
@w{Kaoru Takahashi}, @w{Bun Mizuhara}, @w{Masayuki Osada},
@w{Katsumi Yamaoka}, @w{Hiroya Murata} and @w{Yoichi Nakayama}.
This manual is for Wanderlust version @value{VERSION}.
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions.
@end titlepage
@ifinfo
@node Top, Introduction, (dir), (dir)
@top Wanderlust User's Manual
@flushright
Yuuichi Teranishi
Fujikazu Okunishi
Masahiro Murata
Kenichi Okada
Kaoru Takahashi
Bun Mizuhara
Masayuki Osada
Katsumi Yamaoka
Hiroya Murata
Yoichi Nakayama
@end flushright
This manual is for Wanderlust @value{VERSION}.
@end ifinfo
@menu
* Introduction:: Read this first
* Start Me Up:: Invoking Wanderlust
* Folders:: How to specify folders
* Folder:: Selecting and editing folders
* Summary:: Reading and refiling messages
* Message:: Saving and playing MIME multipart entities
* Draft:: Draft buffer, sending mail and news
* Disconnected Operations:: Off-Line management
* Expire and Archive:: Automatic expiration and archiving of messages
* Scoring:: Score of the messages
* Address Book:: Management of Address Book
* Quick Search:: Quickly search your mail archive
* Spam Filter:: Spam filtering
* Advanced Issues:: Advanced Issues
* Migration:: Switch from older version of Wanderlust
* Terminology:: Terminologies
* Mailing List:: Wanderlust mailing list
* Addition:: Additional Information
* Index:: Key index
@end menu
@node Introduction, Start Me Up, Top, Top
@chapter Introduction of Wanderlust
@cindex Introduction
Wanderlust is an mail/news management system on Emacsen.
It supports IMAP4rev1(RFC2060), NNTP, POP and local message files.
The main features of Wanderlust:
@itemize @minus
@item Pure elisp implementation.
@item Supports IMAP4rev1, NNTP, POP(POP3/APOP), MH and Maildir format.
@item Unified access method to messages based on Mew-like Folder Specification.
@item Mew-like Key-bind and mark handling.
@item Manages unread messages.
@item Interactive thread display.
@item Folder Mode shows the list of subscribed folders.
@item Message Cache, Disconnected Operation.
@item MH-like FCC. (Fcc: %Backup and Fcc: $Backup is allowed).
@item MIME compliant (by SEMI).
@item Transmission of news and mail are unified by Message transmitting draft.
@item Graphical list of folders (XEmacs and Emacs 21).
@item View a part of message without retrieving the whole message (IMAP4).
@item Server-side message look up (IMAP4). Multi-byte characters are allowed.
@item Virtual Folders.
@item Supports compressed folder using common archiving utilities.
@item Old articles in folders are automatically removed/archived (Expiration).
@item Automatic re-file.
@item Template function makes it convenient to send fixed form messages.
@end itemize
@section Environment
We confirm Wanderlust works on following Emacsen:
@itemize @bullet
@item Mule 2.3 based on Emacs 19.34
@item Emacs 20.2 or later
@item XEmacs 20.4 or later
@item Meadow 1.00 or later
@item NTEmacs 20.4 or later
@item PMMule
@end itemize
IMAP4 connectivity with following imapd are confirmed to work with
Wanderlust:
@itemize @bullet
@item UW imapd 4.1--4.7, 4.7a, 4.7b, 4.7c, 2000 or later
@item Cyrus imapd 1.4, 1.5.19, 1.6.22--1.6.24, 2.0.5 or later
@item Courier-IMAP 1.3.2 or later
@item AIR MAIL (AIRC imapd release 2.00)
@item Express Mail
@item Microsoft Exchange Server 5.5
@item Sun Internet Mail Server 3.5, 3.5.alpha, 4.0
@end itemize
LDAP connectivity with following LDAPd are confirmed to work with
Wanderlust:
@itemize @bullet
@item OpenLDAP 2.0.6 or later
@end itemize
@node Start Me Up, Folders, Introduction, Top
@chapter Start up Wanderlust
@cindex Start up
The necessary procedure for starting Wanderlust is explained in steps
here.
(Of course, you need a mail/news readable environment in advance)
@menu
* MIME Modules:: Installing the MIME modules
* Download:: Download and extract the packages
* Install:: Byte-compile and install
* Minimal Settings:: @file{.emacs} setup
* Folder Definition:: Folder definition
* Start Wanderlust:: Starting Wanderlust
* Overview:: Basic components of Wanderlust
@end menu
@node MIME Modules, Download, Start Me Up, Start Me Up
@section Installing MIME modules
@cindex MIME modules
@pindex APEL
@pindex FLIM
@pindex SEMI
You must install packages named APEL, FLIM and SEMI beforehand to use
Wanderlust.
For Emacs 23 or later, downloading from below URLs is highly
recommended.
SEMI-EPG is corresponding package to SEMI.
@example
@group
APEL: @uref{https://github.com/wanderlust/apel}
FLIM: @uref{https://github.com/wanderlust/flim}
SEMI-EPG: @uref{https://github.com/wanderlust/semi}
@end group
@end example
You can download original APEL, FLIM and SEMI from following URLs:
@example
@group
APEL: @uref{http://git.chise.org/elisp/dist/semi/}
FLIM: @uref{http://git.chise.org/elisp/dist/apel/}
SEMI: @uref{http://git.chise.org/elisp/dist/semi/}
@end group
@end example
You have to install APEL, FLIM and SEMI[-EPG] in this order. Generally,
@samp{make install} will do the job. (In XEmacs 21, @samp{make
install-package}.)
Refer to the documents of each package for detailed installation
procedure @footnote{If you want to use SEMI on Emacs 19.34. @*
@uref{http://www.jpl.org/ftp/attic/INSTALL-SEMI-ja.html} (In Japanese)
may help you.}.
Recommended combination of APEL, FLIM and SEMI are following:
@itemize @minus
@item APEL 10.8, FLIM 1.14.9, SEMI-EPG 1.14.7
@end itemize
You can also use many other FLIM/SEMI variants. Combination of the
latest versions should work. For example, the following combination are
confirmed to work.
@itemize @minus
@item APEL 10.6, SLIM 1.14.9, SEMI 1.14.5
@item APEL 10.6, CLIME 1.14.5, EMIKO 1.14.1
@end itemize
You have to re-install Wanderlust if you upgraded APEL, FLIM or SEMI.
@node Download, Install, MIME Modules, Start Me Up
@section Download and Extract the Package
@cindex Download
You can download Wanderlust package from following sites:
Original site:
@example
@uref{https://github.com/wanderlust/wanderlust}
@end example
Mirrored ftp/http sites:
@example
@group
@uref{http://www.jpl.org/ftp/pub/github-snapshots/}
@end group
@end example
Extract the obtained package to your working directory:
@example
@group
% cd ~/work
% tar zxvf wl-@var{version}.tar.gz
% cd wl-@var{version}
@end group
@end example
@subsection To use SSL (Secure Socket Layer)
@cindex SSL
@pindex OpenSSL
@pindex starttls
SSL (Secure Socket Layer) can be used for
SMTP, IMAP, NNTP and POP connections in Wanderlust.
There are two ways to use SSL. One is to start SSL negotiation just
after the connection establishment (generic way). The other one is to
start SSL negotiation by invoking STARTTLS command in the each session.
For the formal SSL (generic SSL), Emacs 24 or later uses built-in GnuTLS
if available. if not available, Emacs try to use @file{tls.el}. In this
case, GnuTLS's @command{gnutls-cli} is needed. if neither avialable,
@file{ssl.el} of @file{utils} directory and OpenSSL's @command{openssl}.
For the latter SSL (STARTTLS), you need @file{starttls.el}. Moreover,
GnuTLS or starttls package is needed according to
@code{starttls-use-gnutls} variable's value. If your Emacs doesn't have
@file{starttls.el} neither @file{starttls.el} doesn't have the
defninition of @code{starttls-use-gnutls}, you need starttls package.
You can download starttls package from the following site.
@example
@uref{ftp://opaopa.org/pub/elisp/}
@end example
@node Install, Minimal Settings, Download, Start Me Up
@section Byte-compile and install
@cindex Byte-compile
@cindex Compile
@cindex Install
@cindex Makefile
@cindex Make
@subsection Installation
Edit @code{LISPDIR} and @code{EMACS} in @file{Makefile}.
Set the Emacs's command name to @code{EMACS}.
Set package installation directory to @code{LISPDIR}.
Then, please execute following commands.
@example
@group
% make
% make install
@end group
@end example
Destination directory is auto-probed if you leave @code{LISPDIR}
in @file{Makefile} as is. (That is, leave it as @samp{NONE})
If you are using an Emacs variant which does not merge specified directory
to @code{load-path} (e.g. Mule 2.3 based on Emacs 19.28),
then you will see the error message:
@example
Cannot open load file: mime-setup
@end example
@noindent
In this case, either add destination directories of custom, APEL, FLIM
and SEMI to environmental variable @env{EMACSLOADPATH}, or define
@code{load-path} in @file{WL-CFG} in extracted directory.
If you want to handle shimbun folders or to use BBDB, add directory
where emacs-w3m or BBDB is installed to @code{load-path}. Then necessary
modules will be byte-compiled and installed.
@xref{Shimbun Folder}, @xref{BBDB}.
@subsection @file{WL-CFG}
Contents of the file @file{WL-CFG} is loaded under installation if a file
with that name exists in extracted directory. You can use @file{WL-CFG} to
configure @code{load-path} to extra packages such as SEMI if needed.
If you want to specify the install directory of Wanderlust related
files, then set following variables in @file{WL-CFG}
@table @code
@item WL_PREFIX
A directory to install WL modules.
This directory is relative directory from @code{LISPDIR}.
WL modules include @file{wl*.el}, @file{wl*.elc} files.
@c Modules under the directory @file{util/} are also installed if
@c it detected as necessary.
@item ELMO_PREFIX
A directory to install ELMO modules.
This directory is relative directory from @code{LISPDIR}.
ELMO modules include @file{elmo*.el}, @file{elmo*.elc} files.
@c @file{utf7.el}, @file{utf7.elc} are also included in the ELMO.
@end table
@noindent
Default value of @code{WL_PREFIX} and @code{ELMO_PREFIX} are @file{wl}.
If you want to install ELMO related files under a sub-directory
such as "elmo" then add following to @file{WL-CFG}:
@lisp
(setq ELMO_PREFIX "elmo")
@end lisp
@subsection Install as a XEmacs package
@cindex XEmacs package
@cindex XEmacs package install
@cindex Package, XEmacs
@cindex Package install, XEmacs
@c @cindex install-package
It is possible to install Wanderlust as one of packages of XEmacs (21.0
or later). Configuration for autoload and icon-path in local
@file{~/.emacs} files are no longer necessary, if you install Wanderlust
as a package.
Follow the next example to install Wanderlust as an XEmacs package.
@example
@group
% vi Makefile
% make package
% make install-package
@end group
@end example
package directory is auto-probed, if SEMI is installed.
(you can also specify it with @code{PACKAGEDIR} in @file{Makefile})
@subsection Run in place
If wl and elmo directories are defined in @code{load-path}, then
byte-compilation and installation are not necessary to start Wanderlust.
For example, if package is extracted in @file{~/work}, Wanderlust can be
invoked with following setting in @file{~/.emacs}.
@lisp
@group
(add-to-list 'load-path "~/work/wl-@var{version}/wl")
(add-to-list 'load-path "~/work/wl-@var{version}/elmo")
@end group
@end lisp
@subsection Manual
Manual is described in Info format. Please do following.
@example
@group
% make info
% make install-info
@end group
@end example
If you install Wanderlust as a XEmacs package, Info file is already
installed too, so there are no need of these commands.
Manual directory is automatically detected. Of course, it can be
configured by @code{INFODIR} in @file{Makefile}.
You can read manual at the following URL:
@example
@uref{http://wanderlust.github.io/wl-docs/wl.html}
@end example
@node Minimal Settings, Folder Definition, Install, Start Me Up
@section Set up .emacs
@cindex Minimal Settings
@cindex Settings
@cindex Configuration
@cindex .emacs
@cindex .wl
The Wanderlust package contains two module groups.
@table @samp
@item ELMO (elmo-*.el)
These modules show everything as folders. This is the back-end for WL.
@item WL (wl-*.el)
These modules controls the behavior of main body of Wanderlust.
They are also the front-end for ELMO.
@end table
You can customize the behavior of Wanderlust by changing the value
of environmental variables which begins with @code{elmo-} and @code{wl-}.
The minimal requirement for settings is as the following.
@lisp
@group
;; @r{autoload configuration}
;; @r{(Not required if you have installed Wanderlust as XEmacs package)}
(autoload 'wl "wl" "Wanderlust" t)
(autoload 'wl-other-frame "wl" "Wanderlust on new frame." t)
(autoload 'wl-draft "wl-draft" "Write draft with Wanderlust." t)
;; @r{Directory where icons are placed.}
;; @r{Default: the peculiar value to the running version of Emacs.}
;; @r{(Not required if the default value points properly)}
(setq wl-icon-directory "~/work/wl/etc")
;; @r{SMTP server for mail posting. Default: @code{nil}}
(setq wl-smtp-posting-server "your.smtp.example.com")
;; @r{NNTP server for news posting. Default: @code{nil}}
(setq wl-nntp-posting-server "your.nntp.example.com")
@end group
@end lisp
@file{~/.wl} is automatically loaded when Wanderlust starts up (if such a
file exists). So it is convenient to gather Wanderlust specific settings
in @file{~/.wl}. Settings for "face" must be written in @file{~/.wl},
because you can't write them in @file{.emacs}
(if you write it to @file{.emacs}, you'll get an error).
@xref{Highlights}.
All above described settings except autoload configuration can be written
in @file{~/.wl}).
@subsection @code{mail-user-agent}
@cindex Default Mailer
@cindex Mailer, Default
@vindex mail-user-agent
@findex compose-mail
If you write following setting in your @file{~/.emacs}, you can
start Wanderlust draft mode by typing @kbd{C-x m} (@code{compose-mail}).
This means it enables you to run Wanderlust as a default mail composer
of Emacsen.
It is effective only when your Emacs can define @code{mail-user-agent}.
@xref{Mail Methods, , ,emacs, The Emacs Editor}.
@lisp
@group
(autoload 'wl-user-agent-compose "wl-draft" nil t)
(if (boundp 'mail-user-agent)
(setq mail-user-agent 'wl-user-agent))
(if (fboundp 'define-mail-user-agent)
(define-mail-user-agent
'wl-user-agent
'wl-user-agent-compose
'wl-draft-send
'wl-draft-kill
'mail-send-hook))
@end group
@end lisp
@node Folder Definition, Start Wanderlust, Minimal Settings, Start Me Up
@section Folder Definition
@cindex Folder Definition
@cindex .folders
You can skip this section because it is possible to add/edit the
subscribe folders from the buffer for list of folders.
@xref{Folder Manager}.
Define the folders you want to subscribe in file @file{~/.folders}. The
contents written in @file{~/.folders} become the folders which you
subscribe to as it is.
Format for @file{~/.folders} is very simple. Here is an example:
@example
@group
#
# @r{Lines begin with @samp{#} are comment.}
# @r{Empty lines are ignored}
#
# @var{folder name} "@var{folder nickname}"
# @r{(nicknames are not necessary)}
#
%inbox "Inbox"
+trash "Trash"
+draft "Drafts"
%#mh/Backup@@my.imap.example.com "Sent"
# Folder Group
Emacsen@{
%#mh/spool/wl "Wanderlust ML"
%#mh/spool/elips "ELIPS ML"
%#mh/spool/apel-ja "APEL Japanese ML"
%#mh/spool/xemacs-beta "XEmacs beta"
-fj.news.reader.gnus@@other.nntp.example.com "Gnus Net news"
*-fj.editor.xemacs,-fj.editor.mule,-fj.editor.emacs "fj's Emacsen"
@}
#
# @r{If folder name ends with @samp{/}, that means an `access group',}
# @r{all subfolders automatically included in one folder group.}
#
%#mh/expire@@localhost /
# @r{All MH folders are included in one folder group.}
+ /
@end group
@end example
Each line contains one folder you want to read. The definition of
folders will be explained in detail in the next section.
The part surrounded by @samp{@var{group name}@{} and @samp{@}} will
become one folder group. One folder group is treated as a directory
which can be opened and closed in folder mode. It is convenient for
collecting some folders and putting them in order.
Please note that @samp{@var{group name}@{} and @samp{@}} occupies one
line and you have to write it that way (It is because the parser sucks).
There are two types of groups. One is like @samp{Emacsen} from above
example which the user chooses his favorite folders as a group.
The other one is @dfn{access group} like @samp{+ /} from above example.
It collects all sub-folders in the folder to make a group. (Its
behavior differs by the type of the folder. For example, @samp{+}
followed by @samp{/} makes entire MH sub-directories to one group)
This behavior is better understood if you try it and confirmed the
function first. You can write and try a small folder definition, so you
will know the idea of the folder function before writing the real one.
@node Start Wanderlust, Overview, Folder Definition, Start Me Up
@section Start Wanderlust
@cindex Start Wanderlust
If installation and configuration worked well, you can invoke Wanderlust by
typing following command in Emacs.
@example
M-x wl
@end example
@noindent
After initialization, Folder Mode which shows the list of folders will
appear. That means the folders you defined in the @file{~/.folders} are
listed.
If you start Wanderlust with prefix argument like @kbd{C-u M-x wl}, you
can skip folder checking.
@node Overview, , Start Wanderlust, Start Me Up
@section Overview
@cindex Overview
Basically, you will handle messages in wanderlust while you come and go
from/to each of the following buffers. Details of each ones are
explained in following chapters.
@table @samp
@item Folder Buffer
You can see the list of folders. You can select some folder and go into the summary
of it. You can subscribe new folder or edit subscription list.
@item Summary Buffer
You can see the list of messages in the folder. You can select message
and view its contents, and reply to some message. You can delete ones or
move ones to another folder.
@item Message Buffer
You can see the contents of the message. You can save part to disk or
open in external programs.
@item Draft Buffer
You can edit message.
@end table
@node Folders, Folder, Start Me Up, Top
@chapter Wanderlust's folders
@cindex Folder Type
This chapter describes the folder types which Wanderlust is able to handle.
Wanderlust uses ELMO as it's interface, so you can use every folder types
supported by ELMO.
As of version @value{VERSION}, 15 types of folders are predefined. These
are IMAP, NNTP, LocalDir(MH), Maildir, News Spool, Archive, POP,
Shimbun, Search, Multi, Filter, Pipe, File, Access and Internal folder
types.
@menu
* IMAP Folder:: @samp{%} -- IMAP folder
* NNTP Folder:: @samp{-} -- NNTP folder
* MH Folder:: @samp{+} -- MH folder
* Maildir Folder:: @samp{.} -- Maildir folder
* News Spool Folder:: @samp{=} -- News spool folder
* Archive Folder:: @samp{$} -- Archive folder
* POP Folder:: @samp{&} -- POP folder
* Shimbun Folder:: @samp{@@} -- Shimbun Folder
* RSS Folder:: @samp{rss} -- RSS folder
* Search Folder:: @samp{[} -- Search Folder
* Multi Folder:: @samp{*} -- Multi folder
* Filter Folder:: @samp{/} -- Filter folder
* Pipe Folder:: @samp{|} -- Pipe folder
* Internal Folder:: @samp{'} -- Internal folder
* File Folder:: -- File folder
* Access Folder:: -- Access folder
@end menu
@node IMAP Folder, NNTP Folder, Folders, Folders
@section IMAP Folder
@cindex @samp{%}
@cindex IMAP Folder
@cindex Folder, IMAP
@cindex RFC 2060
@cindex IMAP4rev1
A folder to access e-mails via IMAP4rev1 protocol (RFC 2060).
Format:
@example
@group
@samp{%} @var{mailbox} [@samp{:} @var{username} [@samp{/} @var{authenticate-type}]][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
@end group
@end example
You can specify @code{login} (encoded password transmission),
@code{cram-md5} (CRAM-MD5 authentication), @code{digest-md5} (DIGEST-MD5
authentication) or @code{clear} (or @code{nil}, plain password
transmission) as @var{authenticate-type}.
default:
@example
@var{username} -> The value of @code{elmo-imap4-default-user}.
Initial setting is @env{USER} environment variable or
@env{LOGNAME} environment variable or return value of
@code{(user-login-name)}.
@var{authenticate-type} -> The value of @code{elmo-imap4-default-authenticate-type}.
Initial setting is "auth".
@var{hostname} -> The value of @code{elmo-imap4-default-server}.
Initial setting is "localhost".
@var{port} -> The value of @code{elmo-imap4-default-port}.
Initial setting is 143.
@end example
You can omit the @var{hostname} from folder names if you set
@code{elmo-imap4-default-server} as your main IMAP server.
For example, you can specify a folder as @samp{foo%imap@@gateway} even
if you have to go through a firewall.
@lisp
@group
;; @r{Example: imap4.exaple.org as main IMAP server}
(setq elmo-imap4-default-server "imap4.example.org")
@end group
@end lisp
SSL (Secure Socket Layer) connection will be used if a folder name ends
with @samp{!}. If a folder name ends with @samp{!!}, STARTTLS
connection will be established.
If the value of @code{elmo-imap4-default-stream-type} is @code{ssl},
SSL will be the default connection, i.e. you can omit @samp{!}. If it
is is @code{starttls}, STARTTLS will be the default connection. To use
normal connection in these cases, add @samp{!direct} at the end of
folder name.
@lisp
@group
;; @r{Example: Use SSL connection}
(setq elmo-imap4-default-stream-type 'ssl)
@end group
@end lisp
If you specify @code{login}, @code{cram-md5} or @code{digest-md5} as
authentication method, the password is sent in encoded form. But, if
your server is unable to receive an encoded password, authentication
will fall back to @code{clear} (that is, sending password in raw format)
after confirmation to user. If @code{elmo-imap4-force-login} is non-nil,
authentication will fall back to @code{clear} without confirmation
(default value is @code{nil}).
@lisp
@group
;; @r{Example: password in raw format}
(setq elmo-imap4-default-authenticate-type 'clear)
@end group
@end lisp
Example:
@example
@group
%inbox -> IMAP mailbox "inbox"
%#mh/inbox -> IMAP mailbox "#mh/inbox"
%inbox:hoge -> IMAP mailbox "inbox" of user "hoge".
%inbox:hoge/clear@@server1
-> server1's IMAP mailbox "inbox"
of user "hoge", with plain password authentication
('clear).
@end group
@end example
@subsection International mailbox names (Modified UTF7)
@cindex Modified UTF7
@cindex UTF7
@cindex UTF8
@cindex Unicode
@pindex Mule-UCS
@pindex ucs-conv
You can use international mailbox names in @var{mailbox} part, if you
are using Emacs with UTF-7 support and
@code{elmo-imap4-use-modified-utf7} is set to non-nil value (default
value is @code{t} on Emacs 23 or later and @code{nil} on other
Emacsen).
Emacs 23 or later doesn't need additional package.
Other Emacsen needs Mule-UCS package to use UTF-7.
Mule-UCS works on following Emacsen.
@itemize @bullet
@item Emacs 20.3 or later
@item XEmacs 21.2.37 or later
@end itemize
You can obtain Mule-UCS package (snapshot of 2004) from following URL.
@example
@uref{http://www.jpl.org/ftp/pub/tmp/}
@end example
@node NNTP Folder, MH Folder, IMAP Folder, Folders
@section NNTP Folder
@cindex @samp{-}
@cindex NNTP Folder
@cindex Folder, NNTP
@cindex Folder, News
@cindex NetNews
@cindex News
@cindex Newsgroup
@cindex RFC 977
A folder to access USENET news via NNTP protocol (RFC 977).
One newsgroup is treated as a folder.
Format:
@example
@group
@samp{-} @var{newsgroup} [@samp{:} @var{username}][@samp{@@} @var{hostname}][@samp{:} @var{port}][@samp{!}]
@end group
@end example
default:
@example
@var{hostname} -> The value of @code{elmo-nntp-default-server}.
Initial setting is @samp{localhost}.
@var{username} -> The value of @code{elmo-nntp-default-user}.
Initial setting is @code{nil}.
@var{port} -> The value of @code{elmo-nntp-default-port}.
Initial setting is 119.
@end example
AUTHINFO is used as authentication method if the @var{username} is
non-nil. SSL connection will be used if a folder name ends with @samp{!}.
If a folder name ends with @samp{!!}, STARTTLS connection will be
established.
If the value of @code{elmo-nntp-default-stream-type} is @code{ssl},
SSL will be the default connection, i.e. you can omit @samp{!}. If it
is is @code{starttls}, STARTTLS will be the default connection. To use
normal connection in these cases, add @samp{!direct} at the end of
folder name.
Example:
@example
@group
-fj.rec.tv -> Newsgroup @samp{fj.rec.tv}.
-fj.rec.tv@@newsserver -> Newsgroup @samp{fj.rec.tv} on @samp{newsserver}.
@end group
@end example
@node MH Folder, Maildir Folder, NNTP Folder, Folders
@section MH Folder
@cindex @samp{+}
@cindex MH Folder
@cindex Folder, MH
@pindex MH
A folder to access MH format mail (1 file is 1 mail).
Format:
@example
@samp{+} @var{directory-name}
@end example
Normally, @var{directory-name} is an relative path to the variable
@code{elmo-localdir-folder-path} (default is @file{~/Mail}), but if it
starts with @samp{/} or @samp{~}, then it is treated as an absolute path
(this is also true for drive-letters).
Message number is used for the name of the message file.
Example:
@example
@group
+inbox -> @file{~/Mail/inbox}
+from/teranisi -> @file{~/Mail/from/teranisi}
+~/test -> @file{~/test}
@end group
@end example
@node Maildir Folder, News Spool Folder, MH Folder, Folders
@section Maildir Folder
@cindex @samp{.}
@cindex Maildir Folder
@pindex Maildir
@pindex qmail
A folder to access Maildir format (1 file is 1 mail).
Format:
@example
@samp{.} [@var{directory-name}]
@end example
Normally, @var{directory-name} is a relative path to the variable
@code{elmo-maildir-folder-path} (default is @file{~/Maildir}), but if it
starts with @samp{/} or @samp{~}, then it is treated as an absolute path
(this is also true for drive-letters).
Maildir contains @file{cur}, @file{new} and @file{tmp} subdirectories.
Messages are contained in the @file{cur} directory. All message files
in the @file{new} directory are moved to @file{cur} directory when you
access the folder. All message files contained in the @file{tmp}
directory and not accessed for 36 hours are deleted.
This behavior conforms to the @uref{http://cr.yp.to/proto/maildir.html}.
Example:
@example
@group
. -> @file{~/Maildir}
.inbox -> @file{~/Maildir/inbox}
.from/teranisi -> @file{~/Maildir/from/teranisi}
.~/test -> @file{~/test}
@end group
@end example
@node News Spool Folder, Archive Folder, Maildir Folder, Folders
@section News Spool Folder
@cindex @samp{=}
@cindex News spool Folder
@pindex gnspool
This folder handles locally saved news articles which are proposed by
Mew/IM. You can also read articles directly from a spool-file which is
retrieved by an utility like @command{gnspool}.
Format:
@example
@samp{=} @var{directory-name}
@end example
@var{directory-name} is a sub-directory to the directory defined by
variable @code{elmo-localnews-folder-path} (default is @file{~/News})
You can use @samp{.} as directory delimiter as well as @samp{/}.
Example:
@example
@group
=fj/os/os2 -> @file{~/News/fj/os/os2}
=fj.os.bsd.freebsd -> @file{~/News/fj/os/bsd/freebsd}
@end group
@end example
@node Archive Folder, POP Folder, News Spool Folder, Folders
@section Archive Folder
@cindex @samp{$}
@cindex Archive Folder
@c @pindex ange-ftp
This method can handle archive files, which are compressed by utilities
such as Info-ZIP or LHA, as one folder.
Format: