1 ;;; org-vm.el - Support for links to VM messages in Org-mode
3 ;; Copyright (C) 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <carsten at orgmode dot org>
6 ;; Keywords: outlines, hypermedia, calendar, wp
7 ;; Homepage: http://orgmode.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 3, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
26 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
30 ;; This file implements links to VM messages and folders for Org-mode.
31 ;; Org-mode loads this module by default - if this is not what you want,
32 ;; configure the variable `org-modules'.
36 ;; Declare external functions and variables
37 (declare-function vm-beginning-of-message
"ext:vm-page" ())
38 (declare-function vm-follow-summary-cursor
"ext:vm-motion" ())
39 (declare-function vm-get-header-contents
"ext:vm-summary"
40 (message header-name-regexp
&optional clump-sep
))
41 (declare-function vm-isearch-narrow
"ext:vm-search" ())
42 (declare-function vm-isearch-update
"ext:vm-search" ())
43 (declare-function vm-select-folder-buffer
"ext:vm-macro" ())
44 (declare-function vm-su-message-id
"ext:vm-summary" (m))
45 (declare-function vm-su-subject
"ext:vm-summary" (m))
46 (declare-function vm-summarize
"ext:vm-summary" (&optional display raise
))
47 (defvar vm-message-pointer
)
48 (defvar vm-folder-directory
)
50 ;; Install the link type
51 (org-add-link-type "vm" 'org-vm-open
)
52 (add-hook 'org-store-link-functions
'org-vm-store-link
)
55 (defun org-vm-store-link ()
56 "Store a link to an VM folder or message."
57 (when (or (eq major-mode
'vm-summary-mode
)
58 (eq major-mode
'vm-presentation-mode
))
59 (and (eq major-mode
'vm-presentation-mode
) (vm-summarize))
60 (vm-follow-summary-cursor)
62 (vm-select-folder-buffer)
63 (let* ((message (car vm-message-pointer
))
64 (folder buffer-file-name
)
65 (subject (vm-su-subject message
))
66 (to (vm-get-header-contents message
"To"))
67 (from (vm-get-header-contents message
"From"))
68 (message-id (vm-su-message-id message
))
70 (org-store-link-props :type
"vm" :from from
:to to
:subject subject
71 :message-id message-id
)
72 (setq message-id
(org-remove-angle-brackets message-id
))
73 (setq folder
(abbreviate-file-name folder
))
74 (if (string-match (concat "^" (regexp-quote vm-folder-directory
))
76 (setq folder
(replace-match "" t t folder
)))
77 (setq desc
(org-email-link-description))
78 (setq link
(org-make-link "vm:" folder
"#" message-id
))
79 (org-add-link-props :link link
:description desc
)
82 (defun org-vm-open (path)
83 "Follow an VM message link."
85 (if (not (string-match "\\`\\([^#]+\\)\\(#\\(.*\\)\\)?" path
))
86 (error "Error in VM link"))
87 (setq folder
(match-string 1 path
)
88 article
(match-string 3 path
))
89 ;; The prefix arguemtn will be interpreted as read-only
90 (org-vm-follow-link folder article current-prefix-arg
)))
92 (defun org-vm-follow-link (&optional folder article readonly
)
93 "Follow a VM link to FOLDER and ARTICLE."
95 (setq article
(org-add-angle-brackets article
))
96 (if (string-match "^//\\([a-zA-Z]+@\\)?\\([^:]+\\):\\(.*\\)" folder
)
97 ;; ange-ftp or efs or tramp access
98 (let ((user (or (match-string 1 folder
) (user-login-name)))
99 (host (match-string 2 folder
))
100 (file (match-string 3 folder
)))
103 ;; use tramp to access the file
104 (if (featurep 'xemacs
)
105 (setq folder
(format "[%s@%s]%s" user host file
))
106 (setq folder
(format "/%s@%s:%s" user host file
))))
108 ;; use ange-ftp or efs
109 (require (if (featurep 'xemacs
) 'efs
'ange-ftp
))
110 (setq folder
(format "/%s@%s:%s" user host file
))))))
112 (funcall (cdr (assq 'vm org-link-frame-setup
)) folder readonly
)
115 (vm-select-folder-buffer)
117 (let ((case-fold-search t
))
118 (goto-char (point-min))
119 (if (not (re-search-forward
120 (concat "^" "message-id: *" (regexp-quote article
))))
121 (error "Could not find the specified message in this folder"))
124 (vm-beginning-of-message)
129 ;;; org-vm.el ends here