ddb1ef684768360d6a227976a1a4a74070e62b95
[elisp/gnus.git-] / lisp / pop3-fma.el
1 ;; pop3-fma.el.el --- POP3 for Multiple Account for Gnus.
2 ;; Copyright (C) 1996,97,98 Free Software Foundation, Inc. , Tatsuya Ichikawa
3 ;;                                                           Yasuo Okabe
4 ;; Author: Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
5 ;;         Yasuo OKABE <okabe@kuis.kyoto-u.ac.jp>
6 ;; Version: 0.20
7 ;; Keywords: mail , gnus , pop3
8 ;;
9 ;; SPECIAL THANKS
10 ;;    Keiichi Suzuki <kei-suzu@mail.wbs.or.jp>
11 ;;    Katsumi Yamaoka <yamaoka@jpl.org>
12 ;;
13 ;; This file is not part of GNU Emacs.
14
15 ;; GNU Emacs is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; any later version.
19
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23 ;; GNU General Public License for more details.
24
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
27 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
28 ;; Boston, MA 02111-1307, USA.
29
30 ;;; Commentary:
31 ;;
32 ;; Note.
33 ;;
34 ;; This file store pop3 password in variable "pop3-fma-password".
35 ;; Please take care by yourself to treat pop3 password.
36 ;;
37 ;; How to use.
38 ;;
39 ;; add your .emacs following codes.
40 ;;
41 ;;  (require 'pop3-fma)
42 ;;  (setq pop3-fma-spool-file-alist
43 ;;        '(
44 ;;          "po:username0@mailhost0.your.domain0"
45 ;;          "po:username1@mailhost1.your.domain1"
46 ;;                         :
47 ;;                         :
48 ;;         ))
49 ;;
50 ;; Variables
51 ;;
52 ;;  pop3-fma-spool-file-alist      ... Spool file alist of POP3 protocol
53 ;;  pop3-fma-movemail-type         ... Type of movemail program.
54 ;;                                         'lisp or 'exe
55 ;;                                         'lisp use pop3.el
56 ;;                                         'exe use movemail
57 ;;  pop3-fma-movemail-arguments    ... List of options of movemail program.
58 ;;
59 ;;; Code:
60
61 (require 'cl)
62 (require 'custom)
63
64 (unless (and (condition-case ()
65                  (require 'custom)
66                (file-error nil))
67              (fboundp 'defgroup)
68              (fboundp 'defcustom))
69   (require 'backquote)
70   (defmacro defgroup (&rest args))
71   (defmacro defcustom (symbol value &optional doc &rest args)
72     (` (defvar (, symbol) (, value) (, doc))))
73   )
74
75 (unless (and (fboundp 'pop3-fma-encode-string)
76              (fboundp 'pop3-fma-decode-string))
77   (require 'mel-b)
78   (fset 'pop3-fma-encode-string 'base64-encode-string)
79   (fset 'pop3-fma-decode-string 'base64-decode-string))
80
81 (defgroup pop3-fma nil
82   "Multile POP3 account utility for Gnus."
83   :prefix "pop3-fma-"
84   :group 'mail
85   :group 'news)
86
87 (defconst pop3-fma-version-number "0.20")
88 (defconst pop3-fma-codename
89 ;;  "Feel the wind"             ; 0.10
90 ;;  "My home town"              ; 0.11
91 ;;  "On the road"               ; 0.12
92 ;;  "Rock'n Roll city"          ; 0.13
93   "Money"                       ; 0.20
94 ;;  "Midnight blue train"       ; 0.xx
95 ;;  "Still 19"                  ; 0.xx
96 ;;  "J boy"                     ; 0.xx
97 ;;  "Blood line"                ; 0.xx
98 ;;  "Star ring"                 ; 0.xx
99 ;;  "Goodbye Game"              ; 0.xx
100   )
101 (defconst pop3-fma-version (format "Multiple POP3 account utiliy for Gnus v%s - \"%s\""
102                                        pop3-fma-version-number
103                                        pop3-fma-codename))
104
105 (defcustom pop3-fma-spool-file-alist nil
106   "*Spoolfile to get mail using pop3 protocol.
107 You should specify this variable like
108  '(
109    \"po:user1@mailhost1\"
110    \"po:user2@mailhost2\"
111   )"
112   :group 'pop3-fma
113   :type 'alist)
114
115 (defcustom pop3-fma-movemail-type 'lisp
116   "*Type of movemail program.
117 Lisp means `nnmail-movemail-program' is lisp function.
118  Exe means `nnmail-movemail-program' is external program.
119  Please do not use exe if you do not use Meadow."
120   :group 'pop3-fma
121   :type '(choice (const lisp)
122                  (const exe)))
123
124 (defcustom pop3-fma-movemail-arguments '("-pf")
125   "*Options for movemail."
126   :group 'pop3-fma
127   :type '(repeat (string :tag "Argument")))
128
129 ;;; Internal variables.
130 (defvar pop3-fma-password nil
131   "*POP3 password , user , mailhost information for Gnus.")
132
133 (defvar pop3-fma-movemail-program "movemail.exe"
134   "*External program name your movemail.
135 Please do not set this valiable non-nil if you do not use Meadow.")
136
137 ;; Temporary variable
138 (defvar hdr nil)
139 (defvar passwd nil)
140 (defvar str nil)
141 (defvar pop3-fma-movemail-options pop3-fma-movemail-arguments)
142
143 (defun pop3-fma-init-message-hook ()
144   (add-hook 'message-send-hook 'pop3-fma-message-add-header))
145
146 (eval-after-load "message"
147   '(pop3-fma-init-message-hook))
148
149 (add-hook 'gnus-after-exiting-gnus-hook
150           '(lambda () (setq pop3-fma-password nil)))
151 (add-hook 'gnus-before-startup-hook 'pop3-fma-set-pop3-password)
152
153 ;;
154 ;;
155 ;; Gnus POP3 additional utility...
156 ;;
157 (defun pop3-fma-movemail (inbox crashbox)
158   "Function to move mail from INBOX on a pop3 server to file CRASHBOX."
159   (let ((pop3-maildrop
160          (substring inbox (match-end (string-match "^po:" inbox))
161                     (- (match-end (string-match "^.*@" inbox)) 1)))
162         (pop3-mailhost
163          (substring inbox (match-end (string-match "^.*@" inbox)))))
164     (let ((pop3-password
165            (pop3-fma-read-passwd pop3-mailhost)))
166       (message "Checking new mail user %s at %s..." pop3-maildrop pop3-mailhost)
167       (if (and (eq system-type 'windows-nt)
168                (eq pop3-fma-movemail-type 'exe))
169           (progn
170             (setenv "MAILHOST" pop3-mailhost)
171             (if (and (not (memq pop3-password pop3-fma-movemail-arguments))
172                      (not (memq (concat "po:" pop3-maildrop) pop3-fma-movemail-arguments)))
173                 (progn
174                   (setq pop3-fma-movemail-arguments nil)
175                   (setq pop3-fma-movemail-arguments
176                       (append pop3-fma-movemail-options
177                               (list
178                                (concat "po:" pop3-maildrop)
179                                crashbox
180                                pop3-password)))))
181             (apply 'call-process (concat
182                                   exec-directory
183                                   pop3-fma-movemail-program)
184                    nil nil nil
185                    pop3-fma-movemail-arguments))
186         (pop3-movemail crashbox)))))
187 ;;
188 ;;
189 (defun pop3-fma-read-passwd (mailhost)
190   (setq passwd (nth 2 (assoc mailhost pop3-fma-password)))
191   (pop3-fma-decode-string passwd))
192
193 (setq pop3-read-passwd 'pop3-fma-read-passwd)
194 ;;
195 ;; Set multiple pop3 server's password
196 (defun pop3-fma-store-password (passwd)
197   (interactive
198    (list (pop3-fma-read-noecho
199           (format "POP Password for %s at %s: " pop3-maildrop pop3-mailhost) t)))
200   (if (not (assoc pop3-mailhost pop3-fma-password))
201       (setq pop3-fma-password
202             (append pop3-fma-password
203                     (list
204                      (list
205                       pop3-mailhost
206                       pop3-maildrop
207                       (pop3-fma-encode-string passwd)))))                     
208     (setcar (cdr (cdr (assoc pop3-mailhost pop3-fma-password)))
209             (pop3-fma-encode-string passwd)))
210   (message "POP password registered.")
211   (pop3-fma-encode-string passwd))
212 ;;
213 ;;;###autoload
214 (defun pop3-fma-set-pop3-password()
215   (interactive)
216   (mapcar
217    (lambda (x)
218      (let ((pop3-maildrop
219             (substring x (match-end (string-match "^po:" x))
220                        (- (match-end (string-match "^.*@" x)) 1)))
221            (pop3-mailhost
222             (substring x (match-end (string-match "^.*@" x)))))
223        (call-interactively 'pop3-fma-store-password)))
224    pop3-fma-spool-file-alist)
225   (setq nnmail-movemail-program 'pop3-fma-movemail)
226   (setq nnmail-spool-file pop3-fma-spool-file-alist))
227 ;;
228 (defun pop3-fma-read-noecho (prompt &optional stars)
229   "Read a single line of text from user without echoing, and return it.
230 Argument PROMPT ."
231   (let ((ans "")
232         (c 0)
233         (echo-keystrokes 0)
234         (cursor-in-echo-area t)
235         (log-message-max-size 0)
236         message-log-max done msg truncate)
237     (while (not done)
238       (if (or (not stars) (string-equal "" ans))
239           (setq msg prompt)
240         (setq msg (concat prompt (make-string (length ans) ?*)))
241         (setq truncate
242               (1+ (- (length msg) (window-width (minibuffer-window)))))
243         (and (> truncate 0)
244              (setq msg (concat "$" (substring msg (1+ truncate))))))
245       (message msg)
246       (setq c (read-char-exclusive))
247       (cond ((= c ?\C-g)
248              (setq quit-flag t
249                    done t))
250             ((or (= c ?\r) (= c ?\n) (= c ?\e))
251              (setq done t))
252             ((= c ?\C-u)
253              (setq ans ""))
254             ((and (/= c ?\b) (/= c ?\177))
255              (setq ans (concat ans (char-to-string c))))
256             ((> (length ans) 0)
257              (setq ans (substring ans 0 -1)))))
258     (if quit-flag
259         (prog1
260             (setq quit-flag nil)
261           (message "Quit")
262           (beep t))
263       (message "")
264       ans)))
265 ;;
266 ;;
267 (defun pop3-fma-message-add-header ()
268   (if (message-mail-p)
269       (pop3-fma-add-custom-header "X-Ya-Pop3:" pop3-fma-version)))
270   
271 ;;
272 ;; Add your custom header.
273 ;;
274 (defun pop3-fma-add-custom-header (header string)
275   (let ((delimline
276          (progn (goto-char (point-min))
277                 (re-search-forward
278                  (concat "^" (regexp-quote mail-header-separator) "\n"))
279                 (point-marker))))
280     (goto-char (point-min))
281     (or (re-search-forward (concat "^" header) delimline t)
282         (progn
283           (goto-char delimline)
284           (forward-line -1)
285           (beginning-of-line)
286           (setq hdr (concat header " "))
287           (setq str (concat hdr string))
288           (setq hdr (concat str "\n"))
289           (insert-string hdr)))))
290 ;;
291 (provide 'pop3-fma)
292 ;;
293 ;; pop3-fma.el ends here.