README.md

   1 Wanderlust - Yet Another Message Interface on Emacsen
   2 =====================================================
   3
   4 Wanderlust is a mail/news management system with [IMAP4rev1][1] support for
   5 [Emacs][2]. It was originally developed by [Yuuichi Teranishi][3].
   6
   7 For documentation, see also: [bundled document][16] and [Wanderlust on EmacsWiki][4]
   8
   9
  10 Features
  11 ========
  12
  13   * Implementation in elisp only.
  14
  15   * Support of [IMAP4rev1][5], [NNTP][6], POP([POP3][7]/APOP), MH and Maildir.
  16
  17   * Integrated access to messages based on Folder Specifications like [Mew][8].
  18
  19   * Key bindings and mark processing like Mew.
  20
  21   * Management of threads and unread messages.
  22
  23   * Folder mode to select and edit subscribed folders.
  24
  25   * Message cache, Disconnected Operation.
  26
  27   * MH-like Fcc (Fcc: %Backup is possible).
  28
  29   * Full support of MIME (by SEMI).
  30
  31   * Draft editing of mail and news as a same interface.
  32
  33   * Icon based interface for the list of Folder.
  34
  35   * Skip fetching of a large message part of MIME(IMAP4).
  36
  37   * Server side searching (IMAP4), internationalized searching is available.
  38
  39   * Virtual folder.
  40
  41   * Compressed folder.
  42
  43   * Automatic expiration of old messages.
  44
  45   * Automatic refiling.
  46
  47   * Draft templates.
  48
  49
  50 Installation
  51 ============
  52
  53 See: `INSTALL'
  54
  55
  56 Mailing List
  57 ============
  58
  59 You can get information and help via the mailing list at:
  60
  61   * English: [wl-en@ml.gentei.org][9] (news://news.gmane.io/gmane.mail.wanderlust.general for archives)
  62
  63   * Japanese: [wl@ml.gentei.org][11] (news://news.gmane.io/gmane.mail.wanderlust.general.japanese for archives)
  64
  65 Emails to the English list are forwarded to the Japanese list.
  66
  67 To subscribe, send an email to [wl-ctl@ml.gentei.org][13] (Japanese) or
  68 [wl-en-ctl@ml.gentei.org][14] (English). Use `subscribe YOUR NAME` as subject
  69 and body. To unsubscribe, use `unsubscribe` as body. To get help, use `# guide`
  70 as body.
  71
  72
  73 Development
  74 ===========
  75
  76 The source code repository is available at [Github][15]. Patches that
  77 fix bugs and improve Wanderlust are welcome and can be sent to the
  78 Wanderlust mailing list.
  79
  80
  81 [1]: http://en.wikipedia.org/wiki/Internet_Message_Access_Protocol
  82
  83 [2]: http://www.gnu.org/software/emacs/
  84
  85 [3]: mailto:teranisi@gohome.org
  86
  87 [4]: http://www.emacswiki.org/emacs/WanderLust
  88
  89 [5]: http://tools.ietf.org/html/rfc3501 "M. Crispin, 'INTERNET MESSAGE ACCESS PROTOCOL - VERSION 4rev1', RFC 3501, 2003"
  90
  91 [6]: http://tools.ietf.org/html/rfc977 "B. Kantor and P. Lapsley, 'Network News Transfer Protocol: A Proposed Standard for the Stream-Based Transmission of News', RFC 977, 1986"
  92
  93 [7]: http://tools.ietf.org/html/rfc1939 "J. Myers, M. Rose, 'Post Office Protocol - Version 3', RFC 1939, 1996"
  94
  95 [8]: http://www.mew.org/ "'Mew - Messaging in the Emacs World', (Copyright �¢í 1994-2018 Kazuhiko Yamamoto)"
  96
  97 [9]: mailto:wl-en@ml.gentei.org
  98
  99 [11]: wl@ml.gentei.org
 100
 101 [13]: mailto:wl-ctl@ml.gentei.org
 102
 103 [14]: mailto:wl-en-ctl@ml.gentei.org
 104
 105 [15]: https://github.com/wanderlust/wanderlust
 106
 107 [16]: http://wanderlust.github.io/wl-docs/