Mercurial > emacs
view etc/schema/dbhier.rnc @ 91817:f0b22bbb77fb
;;; smtpmail.el --- simple SMTP protocol (RFC 821) for sending mail
;; Copyright (C) 1995, 1996, 2001, 2002, 2003, 2004, 2005,
;; 2006, 2007, 2008 Free Software Foundation, Inc.
;; Author: Tomoji Kagatani <kagatani@rbc.ncl.omron.co.jp>
;; Maintainer: Simon Josefsson <simon@josefsson.org>
;; w32 Maintainer: Brian D. Carlstrom <bdc@ai.mit.edu>
;; ESMTP support: Simon Leinen <simon@switch.ch>
;; Hacked by Mike Taylor, 11th October 1999 to add support for
;; automatically appending a domain to RCPT TO: addresses.
;; AUTH=LOGIN support: Stephen Cranefield <scranefield@infoscience.otago.ac.nz>
;; Keywords: mail
;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;; Commentary:
;; Send Mail to smtp host from smtpmail temp buffer.
;; Please add these lines in your .emacs(_emacs) or use customize.
;;
;;(setq send-mail-function 'smtpmail-send-it) ; if you use `mail'
;;(setq message-send-mail-function 'smtpmail-send-it) ; if you use message/Gnus
;;(setq smtpmail-default-smtp-server "YOUR SMTP HOST")
;;(setq smtpmail-local-domain "YOUR DOMAIN NAME")
;;(setq smtpmail-sendto-domain "YOUR DOMAIN NAME")
;;(setq smtpmail-debug-info t) ; only to debug problems
;;(setq smtpmail-auth-credentials ; or use ~/.authinfo
;; '(("YOUR SMTP HOST" 25 "username" "password")))
;;(setq smtpmail-starttls-credentials
;; '(("YOUR SMTP HOST" 25 "~/.my_smtp_tls.key" "~/.my_smtp_tls.cert")))
;; Where the 25 equals the value of `smtpmail-smtp-service', it can be an
;; integer or a string, just as long as they match (eq).
;; To queue mail, set smtpmail-queue-mail to t and use
;; smtpmail-send-queued-mail to send.
;; Modified by Stephen Cranefield <scranefield@infoscience.otago.ac.nz>,
;; 22/6/99, to support SMTP Authentication by the AUTH=LOGIN mechanism.
;; See http://help.netscape.com/products/server/messaging/3x/info/smtpauth.html
;; Rewritten by Simon Josefsson to use same credential variable as AUTH
;; support below.
;; Modified by Simon Josefsson <jas@pdc.kth.se>, 22/2/99, to support SMTP
;; Authentication by the AUTH mechanism.
;; See http://www.ietf.org/rfc/rfc2554.txt
;; Modified by Simon Josefsson <simon@josefsson.org>, 2000-10-07, to support
;; STARTTLS. Requires external program
;; ftp://ftp.opaopa.org/pub/elisp/starttls-*.tar.gz.
;; See http://www.ietf.org/rfc/rfc2246.txt, http://www.ietf.org/rfc/rfc2487.txt
;;; Code:
(require 'sendmail)
(autoload 'starttls-open-stream "starttls")
(autoload 'starttls-negotiate "starttls")
(autoload 'mail-strip-quoted-names "mail-utils")
(autoload 'message-make-date "message")
(autoload 'message-make-message-id "message")
(autoload 'rfc2104-hash "rfc2104")
(autoload 'netrc-parse "netrc")
(autoload 'netrc-machine "netrc")
(autoload 'netrc-get "netrc")
;;;
(defgroup smtpmail nil
"SMTP protocol for sending mail."
:group 'mail)
(defcustom smtpmail-default-smtp-server nil
"*Specify default SMTP server.
This only has effect if you specify it before loading the smtpmail library."
:type '(choice (const nil) string)
:group 'smtpmail)
(defcustom smtpmail-smtp-server
(or (getenv "SMTPSERVER") smtpmail-default-smtp-server)
"*The name of the host running SMTP server."
:type '(choice (const nil) string)
:group 'smtpmail)
(defcustom smtpmail-smtp-service 25
"*SMTP service port number.
The default value would be \"smtp\" or 25."
:type '(choice (integer :tag "Port") (string :tag "Service"))
:group 'smtpmail)
(defcustom smtpmail-local-domain nil
"*Local domain name without a host name.
If the function `system-name' returns the full internet address,
don't define this value."
:type '(choice (const nil) string)
:group 'smtpmail)
(defcustom smtpmail-sendto-domain nil
"*Local domain name without a host name.
This is appended (with an @-sign) to any specified recipients which do
not include an @-sign, so that each RCPT TO address is fully qualified.
\(Some configurations of sendmail require this.)
Don't bother to set this unless you have get an error like:
Sending failed; SMTP protocol error
when sending mail, and the *trace of SMTP session to <somewhere>*
buffer includes an exchange like:
RCPT TO: <someone>
501 <someone>: recipient address must contain a domain
"
:type '(choice (const nil) string)
:group 'smtpmail)
(defcustom smtpmail-debug-info nil
"Whether to print info in buffer *trace of SMTP session to <somewhere>*.
See also `smtpmail-debug-verb' which determines if the SMTP protocol should
be verbose as well."
:type 'boolean
:group 'smtpmail)
(defcustom smtpmail-debug-verb nil
"Whether this library sends the SMTP VERB command or not.
The commands enables verbose information from the SMTP server."
:type 'boolean
:group 'smtpmail)
(defcustom smtpmail-code-conv-from nil ;; *junet*
"*smtpmail code convert from this code to *internal*..for tiny-mime.."
:type 'boolean
:group 'smtpmail)
(defcustom smtpmail-queue-mail nil
"*If set, mail is queued; otherwise it is sent immediately.
If queued, it is stored in the directory `smtpmail-queue-dir'
and sent with `smtpmail-send-queued-mail'."
:type 'boolean
:group 'smtpmail)
(defcustom smtpmail-queue-dir "~/Mail/queued-mail/"
"*Directory where `smtpmail.el' stores queued mail."
:type 'directory
:group 'smtpmail)
(defcustom smtpmail-auth-credentials "~/.authinfo"
"Specify username and password for servers, directly or via .netrc file.
This variable can either be a filename pointing to a file in netrc(5)
format, or list of four-element lists that contain, in order,
`servername' (a string), `port' (an integer), `user' (a string) and
`password' (a string, or nil to query the user when needed). If you
need to enter a `realm' too, add it to the user string, so that it
looks like `user@realm'."
:type '(choice file
(repeat (list (string :tag "Server")
(integer :tag "Port")
(string :tag "Username")
(choice (const :tag "Query when needed" nil)
(string :tag "Password")))))
:version "22.1"
:group 'smtpmail)
(defcustom smtpmail-starttls-credentials '(("" 25 "" ""))
"Specify STARTTLS keys and certificates for servers.
This is a list of four-element list with `servername' (a string),
`port' (an integer), `key' (a filename) and `certificate' (a
filename).
If you do not have a certificate/key pair, leave the `key' and
`certificate' fields as `nil'. A key/certificate pair is only
needed if you want to use X.509 client authenticated
connections."
:type '(repeat (list (string :tag "Server")
(integer :tag "Port")
(file :tag "Key")
(file :tag "Certificate")))
:version "21.1"
:group 'smtpmail)
(defcustom smtpmail-warn-about-unknown-extensions nil
"*If set, print warnings about unknown SMTP extensions.
This is mainly useful for development purposes, to learn about
new SMTP extensions that might be useful to support."
:type 'boolean
:version "21.1"
:group 'smtpmail)
(defvar smtpmail-queue-index-file "index"
"File name of queued mail index.
This is relative to `smtpmail-queue-dir'.")
(defvar smtpmail-address-buffer)
(defvar smtpmail-recipient-address-list)
(defvar smtpmail-queue-counter 0)
;; Buffer-local variable.
(defvar smtpmail-read-point)
(defvar smtpmail-queue-index (concat smtpmail-queue-dir
smtpmail-queue-index-file))
(defconst smtpmail-auth-supported '(cram-md5 plain login)
"List of supported SMTP AUTH mechanisms.")
;;;
;;;
;;;
(defvar smtpmail-mail-address nil
"Value to use for envelope-from address for mail from ambient buffer.")
;;;###autoload
(defun smtpmail-send-it ()
(let ((errbuf (if mail-interactive
(generate-new-buffer " smtpmail errors")
0))
(tembuf (generate-new-buffer " smtpmail temp"))
(case-fold-search nil)
delimline
(mailbuf (current-buffer))
;; Examine this variable now, so that
;; local binding in the mail buffer will take effect.
(smtpmail-mail-address
(or (and mail-specify-envelope-from (mail-envelope-from))
user-mail-address))
(smtpmail-code-conv-from
(if enable-multibyte-characters
(let ((sendmail-coding-system smtpmail-code-conv-from))
(select-message-coding-system)))))
(unwind-protect
(save-excursion
(set-buffer tembuf)
(erase-buffer)
;; Use the same buffer-file-coding-system as in the mail
;; buffer, otherwise any write-region invocations (e.g., in
;; mail-do-fcc below) will annoy with asking for a suitable
;; encoding.
(set-buffer-file-coding-system smtpmail-code-conv-from nil t)
(insert-buffer-substring mailbuf)
(goto-char (point-max))
;; require one newline at the end.
(or (= (preceding-char) ?\n)
(insert ?\n))
;; Change header-delimiter to be what sendmail expects.
(mail-sendmail-undelimit-header)
(setq delimline (point-marker))
;; (sendmail-synch-aliases)
(if mail-aliases
(expand-mail-aliases (point-min) delimline))
(goto-char (point-min))
;; ignore any blank lines in the header
(while (and (re-search-forward "\n\n\n*" delimline t)
(< (point) delimline))
(replace-match "\n"))
(let ((case-fold-search t))
;; We used to process Resent-... headers here,
;; but it was not done properly, and the job
;; is done correctly in smtpmail-deduce-address-list.
;; Don't send out a blank subject line
(goto-char (point-min))
(if (re-search-forward "^Subject:\\([ \t]*\n\\)+\\b" delimline t)
(replace-match "")
;; This one matches a Subject just before the header delimiter.
(if (and (re-search-forward "^Subject:\\([ \t]*\n\\)+" delimline t)
(= (match-end 0) delimline))
(replace-match "")))
;; Put the "From:" field in unless for some odd reason
;; they put one in themselves.
(goto-char (point-min))
(if (not (re-search-forward "^From:" delimline t))
(let* ((login smtpmail-mail-address)
(fullname (user-full-name)))
(cond ((eq mail-from-style 'angles)
(insert "From: " fullname)
(let ((fullname-start (+ (point-min) 6))
(fullname-end (point-marker)))
(goto-char fullname-start)
;; Look for a character that cannot appear unquoted
;; according to RFC 822.
(if (re-search-forward "[^- !#-'*+/-9=?A-Z^-~]"
fullname-end 1)
(progn
;; Quote fullname, escaping specials.
(goto-char fullname-start)
(insert "\"")
(while (re-search-forward "[\"\\]"
fullname-end 1)
(replace-match "\\\\\\&" t))
(insert "\""))))
(insert " <" login ">\n"))
((eq mail-from-style 'parens)
(insert "From: " login " (")
(let ((fullname-start (point)))
(insert fullname)
(let ((fullname-end (point-marker)))
(goto-char fullname-start)
;; RFC 822 says \ and nonmatching parentheses
;; must be escaped in comments.
;; Escape every instance of ()\ ...
(while (re-search-forward "[()\\]" fullname-end 1)
(replace-match "\\\\\\&" t))
;; ... then undo escaping of matching parentheses,
;; including matching nested parentheses.
(goto-char fullname-start)
(while (re-search-forward
"\\(\\=\\|[^\\]\\(\\\\\\\\\\)*\\)\\\\(\\(\\([^\\]\\|\\\\\\\\\\)*\\)\\\\)"
fullname-end 1)
(replace-match "\\1(\\3)" t)
(goto-char fullname-start))))
(insert ")\n"))
((null mail-from-style)
(insert "From: " login "\n")))))
;; Insert a `Message-Id:' field if there isn't one yet.
(goto-char (point-min))
(unless (re-search-forward "^Message-Id:" delimline t)
(insert "Message-Id: " (message-make-message-id) "\n"))
;; Insert a `Date:' field if there isn't one yet.
(goto-char (point-min))
(unless (re-search-forward "^Date:" delimline t)
(insert "Date: " (message-make-date) "\n"))
;; Possibly add a MIME header for the current coding system
(let (charset)
(goto-char (point-min))
(and (eq mail-send-nonascii 'mime)
(not (re-search-forward "^MIME-version:" delimline t))
(progn (skip-chars-forward "\0-\177")
(/= (point) (point-max)))
smtpmail-code-conv-from
(setq charset
(coding-system-get smtpmail-code-conv-from
'mime-charset))
(goto-char delimline)
(insert "MIME-version: 1.0\n"
"Content-type: text/plain; charset="
(symbol-name charset)
"\nContent-Transfer-Encoding: 8bit\n")))
;; Insert an extra newline if we need it to work around
;; Sun's bug that swallows newlines.
(goto-char (1+ delimline))
(if (eval mail-mailer-swallows-blank-line)
(newline))
;; Find and handle any FCC fields.
(goto-char (point-min))
(if (re-search-forward "^FCC:" delimline t)
;; Force mail-do-fcc to use the encoding of the mail
;; buffer to encode outgoing messages on FCC files.
(let ((coding-system-for-write smtpmail-code-conv-from))
(mail-do-fcc delimline)))
(if mail-interactive
(with-current-buffer errbuf
(erase-buffer))))
;;
;;
;;
(setq smtpmail-address-buffer (generate-new-buffer "*smtp-mail*"))
(setq smtpmail-recipient-address-list
(smtpmail-deduce-address-list tembuf (point-min) delimline))
(kill-buffer smtpmail-address-buffer)
(smtpmail-do-bcc delimline)
; Send or queue
(if (not smtpmail-queue-mail)
(if (not (null smtpmail-recipient-address-list))
(if (not (smtpmail-via-smtp
smtpmail-recipient-address-list tembuf))
(error "Sending failed; SMTP protocol error"))
(error "Sending failed; no recipients"))
(let* ((file-data
(expand-file-name
(format "%s_%i"
(format-time-string "%Y-%m-%d_%H:%M:%S")
(setq smtpmail-queue-counter
(1+ smtpmail-queue-counter)))
smtpmail-queue-dir))
(file-data (convert-standard-filename file-data))
(file-elisp (concat file-data ".el"))
(buffer-data (create-file-buffer file-data))
(buffer-elisp (create-file-buffer file-elisp))
(buffer-scratch "*queue-mail*"))
(unless (file-exists-p smtpmail-queue-dir)
(make-directory smtpmail-queue-dir t))
(with-current-buffer buffer-data
(erase-buffer)
(set-buffer-file-coding-system smtpmail-code-conv-from nil t)
(insert-buffer-substring tembuf)
(write-file file-data)
(set-buffer buffer-elisp)
(erase-buffer)
(insert (concat
"(setq smtpmail-recipient-address-list '"
(prin1-to-string smtpmail-recipient-address-list)
")\n"))
(write-file file-elisp)
(set-buffer (generate-new-buffer buffer-scratch))
(insert (concat file-data "\n"))
(append-to-file (point-min)
(point-max)
smtpmail-queue-index)
)
(kill-buffer buffer-scratch)
(kill-buffer buffer-data)
(kill-buffer buffer-elisp))))
(kill-buffer tembuf)
(if (bufferp errbuf)
(kill-buffer errbuf)))))
;;;###autoload
(defun smtpmail-send-queued-mail ()
"Send mail that was queued as a result of setting `smtpmail-queue-mail'."
(interactive)
(with-temp-buffer
;;; Get index, get first mail, send it, update index, get second
;;; mail, send it, etc...
(let ((file-msg ""))
(insert-file-contents smtpmail-queue-index)
(goto-char (point-min))
(while (not (eobp))
(setq file-msg (buffer-substring (point) (line-end-position)))
(load file-msg)
;; Insert the message literally: it is already encoded as per
;; the MIME headers, and code conversions might guess the
;; encoding wrongly.
(with-temp-buffer
(let ((coding-system-for-read 'no-conversion))
(insert-file-contents file-msg))
(let ((smtpmail-mail-address
(or (and mail-specify-envelope-from (mail-envelope-from))
user-mail-address)))
(if (not (null smtpmail-recipient-address-list))
(if (not (smtpmail-via-smtp smtpmail-recipient-address-list
(current-buffer)))
(error "Sending failed; SMTP protocol error"))
(error "Sending failed; no recipients"))))
(delete-file file-msg)
(delete-file (concat file-msg ".el"))
(delete-region (point-at-bol) (point-at-bol 2)))
(write-region (point-min) (point-max) smtpmail-queue-index))))
;(defun smtpmail-via-smtp (host,port,sender,destination,smtpmail-text-buffer)
(defun smtpmail-fqdn ()
(if smtpmail-local-domain
(concat (system-name) "." smtpmail-local-domain)
(system-name)))
(defsubst smtpmail-cred-server (cred)
(nth 0 cred))
(defsubst smtpmail-cred-port (cred)
(nth 1 cred))
(defsubst smtpmail-cred-key (cred)
(nth 2 cred))
(defsubst smtpmail-cred-user (cred)
(nth 2 cred))
(defsubst smtpmail-cred-cert (cred)
(nth 3 cred))
(defsubst smtpmail-cred-passwd (cred)
(nth 3 cred))
(defun smtpmail-find-credentials (cred server port)
(catch 'done
(let ((l cred) el)
(while (setq el (pop l))
(when (and (equal server (smtpmail-cred-server el))
(equal port (smtpmail-cred-port el)))
(throw 'done el))))))
(defun smtpmail-maybe-append-domain (recipient)
(if (or (not smtpmail-sendto-domain)
(string-match "@" recipient))
recipient
(concat recipient "@" smtpmail-sendto-domain)))
(defun smtpmail-intersection (list1 list2)
(let ((result nil))
(dolist (el2 list2)
(when (memq el2 list1)
(push el2 result)))
(nreverse result)))
(defvar starttls-extra-args)
(defvar starttls-extra-arguments)
(defun smtpmail-open-stream (process-buffer host port)
(let ((cred (smtpmail-find-credentials
smtpmail-starttls-credentials host port)))
(if (null (and cred (condition-case ()
(with-no-warnings
(require 'starttls)
(call-process (if starttls-use-gnutls
starttls-gnutls-program
starttls-program)))
(error nil))))
;; The normal case.
(open-network-stream "SMTP" process-buffer host port)
(let* ((cred-key (smtpmail-cred-key cred))
(cred-cert (smtpmail-cred-cert cred))
(starttls-extra-args
(append
starttls-extra-args
(when (and (stringp cred-key) (stringp cred-cert)
(file-regular-p
(setq cred-key (expand-file-name cred-key)))
(file-regular-p
(setq cred-cert (expand-file-name cred-cert))))
(list "--key-file" cred-key "--cert-file" cred-cert))))
(starttls-extra-arguments
(append
starttls-extra-arguments
(when (and (stringp cred-key) (stringp cred-cert)
(file-regular-p
(setq cred-key (expand-file-name cred-key)))
(file-regular-p
(setq cred-cert (expand-file-name cred-cert))))
(list "--x509keyfile" cred-key "--x509certfile" cred-cert)))))
(starttls-open-stream "SMTP" process-buffer host port)))))
(defun smtpmail-try-auth-methods (process supported-extensions host port)
(let* ((mechs (cdr-safe (assoc 'auth supported-extensions)))
(mech (car (smtpmail-intersection smtpmail-auth-supported mechs)))
(cred (if (stringp smtpmail-auth-credentials)
(let* ((netrc (netrc-parse smtpmail-auth-credentials))
(port-name (format "%s" (or port "smtp")))
(hostentry (netrc-machine netrc host port-name
port-name)))
(when hostentry
(list host port
(netrc-get hostentry "login")
(netrc-get hostentry "password"))))
(smtpmail-find-credentials
smtpmail-auth-credentials host port)))
(passwd (when cred
(or (smtpmail-cred-passwd cred)
(read-passwd
(format "SMTP password for %s:%s: "
(smtpmail-cred-server cred)
(smtpmail-cred-port cred))))))
ret)
(when (and cred mech)
(cond
((eq mech 'cram-md5)
(smtpmail-send-command process (upcase (format "AUTH %s" mech)))
(if (or (null (car (setq ret (smtpmail-read-response process))))
(not (integerp (car ret)))
(>= (car ret) 400))
(throw 'done nil))
(when (eq (car ret) 334)
(let* ((challenge (substring (cadr ret) 4))
(decoded (base64-decode-string challenge))
(hash (rfc2104-hash 'md5 64 16 passwd decoded))
(response (concat (smtpmail-cred-user cred) " " hash))
;; Osamu Yamane <yamane@green.ocn.ne.jp>:
;; SMTP auth fails because the SMTP server identifies
;; only the first part of the string (delimited by
;; new line characters) as a response from the
;; client, and the rest as distinct commands.
;; In my case, the response string is 80 characters
;; long. Without the no-line-break option for
;; base64-encode-sting, only the first 76 characters
;; are taken as a response to the server, and the
;; authentication fails.
(encoded (base64-encode-string response t)))
(smtpmail-send-command process (format "%s" encoded))
(if (or (null (car (setq ret (smtpmail-read-response process))))
(not (integerp (car ret)))
(>= (car ret) 400))
(throw 'done nil)))))
((eq mech 'login)
(smtpmail-send-command process "AUTH LOGIN")
(if (or (null (car (setq ret (smtpmail-read-response process))))
(not (integerp (car ret)))
(>= (car ret) 400))
(throw 'done nil))
(smtpmail-send-command
process (base64-encode-string (smtpmail-cred-user cred) t))
(if (or (null (car (setq ret (smtpmail-read-response process))))
(not (integerp (car ret)))
(>= (car ret) 400))
(throw 'done nil))
(smtpmail-send-command process (base64-encode-string passwd t))
(if (or (null (car (setq ret (smtpmail-read-response process))))
(not (integerp (car ret)))
(>= (car ret) 400))
(throw 'done nil)))
((eq mech 'plain)
;; We used to send an empty initial request, and wait for an
;; empty response, and then send the password, but this
;; violate a SHOULD in RFC 2222 paragraph 5.1. Note that this
;; is not sent if the server did not advertise AUTH PLAIN in
;; the EHLO response. See RFC 2554 for more info.
(smtpmail-send-command process
(concat "AUTH PLAIN "
(base64-encode-string
(concat "\0"
(smtpmail-cred-user cred)
"\0"
passwd) t)))
(if (or (null (car (setq ret (smtpmail-read-response process))))
(not (integerp (car ret)))
(not (equal (car ret) 235)))
(throw 'done nil)))
(t
(error "Mechanism %s not implemented" mech)))
;; Remember the password.
(when (and (not (stringp smtpmail-auth-credentials))
(null (smtpmail-cred-passwd cred)))
(setcar (cdr (cdr (cdr cred))) passwd)))))
(defun smtpmail-via-smtp (recipient smtpmail-text-buffer)
(let ((process nil)
(host (or smtpmail-smtp-server
(error "`smtpmail-smtp-server' not defined")))
(port smtpmail-smtp-service)
;; smtpmail-mail-address should be set to the appropriate
;; buffer-local value by the caller, but in case not:
(envelope-from (or smtpmail-mail-address
(and mail-specify-envelope-from
(mail-envelope-from))
user-mail-address))
response-code
greeting
process-buffer
(supported-extensions '()))
(unwind-protect
(catch 'done
;; get or create the trace buffer
(setq process-buffer
(get-buffer-create (format "*trace of SMTP session to %s*" host)))
;; clear the trace buffer of old output
(with-current-buffer process-buffer
(setq buffer-undo-list t)
(erase-buffer))
;; open the connection to the server
(setq process (smtpmail-open-stream process-buffer host port))
(and (null process) (throw 'done nil))
;; set the send-filter
(set-process-filter process 'smtpmail-process-filter)
(with-current-buffer process-buffer
(set-buffer-process-coding-system 'raw-text-unix 'raw-text-unix)
(make-local-variable 'smtpmail-read-point)
(setq smtpmail-read-point (point-min))
(if (or (null (car (setq greeting (smtpmail-read-response process))))
(not (integerp (car greeting)))
(>= (car greeting) 400))
(throw 'done nil)
)
(let ((do-ehlo t)
(do-starttls t))
(while do-ehlo
;; EHLO
(smtpmail-send-command process (format "EHLO %s" (smtpmail-fqdn)))
(if (or (null (car (setq response-code
(smtpmail-read-response process))))
(not (integerp (car response-code)))
(>= (car response-code) 400))
(progn
;; HELO
(smtpmail-send-command
process (format "HELO %s" (smtpmail-fqdn)))
(if (or (null (car (setq response-code
(smtpmail-read-response process))))
(not (integerp (car response-code)))
(>= (car response-code) 400))
(throw 'done nil)))
(dolist (line (cdr (cdr response-code)))
(let ((name
(with-case-table ascii-case-table
(mapcar (lambda (s) (intern (downcase s)))
(split-string (substring line 4) "[ ]")))))
(and (eq (length name) 1)
(setq name (car name)))
(and name
(cond ((memq (if (consp name) (car name) name)
'(verb xvrb 8bitmime onex xone
expn size dsn etrn
enhancedstatuscodes
help xusr
auth=login auth starttls))
(setq supported-extensions
(cons name supported-extensions)))
(smtpmail-warn-about-unknown-extensions
(message "Unknown extension %s" name)))))))
(if (and do-starttls
(smtpmail-find-credentials smtpmail-starttls-credentials host port)
(member 'starttls supported-extensions)
(numberp (process-id process)))
(progn
(smtpmail-send-command process (format "STARTTLS"))
(if (or (null (car (setq response-code (smtpmail-read-response process))))
(not (integerp (car response-code)))
(>= (car response-code) 400))
(throw 'done nil))
(starttls-negotiate process)
(setq do-starttls nil))
(setq do-ehlo nil))))
(smtpmail-try-auth-methods process supported-extensions host port)
(if (or (member 'onex supported-extensions)
(member 'xone supported-extensions))
(progn
(smtpmail-send-command process (format "ONEX"))
(if (or (null (car (setq response-code (smtpmail-read-response process))))
(not (integerp (car response-code)))
(>= (car response-code) 400))
(throw 'done nil))))
(if (and smtpmail-debug-verb
(or (member 'verb supported-extensions)
(member 'xvrb supported-extensions)))
(progn
(smtpmail-send-command process (format "VERB"))
(if (or (null (car (setq response-code (smtpmail-read-response process))))
(not (integerp (car response-code)))
(>= (car response-code) 400))
(throw 'done nil))))
(if (member 'xusr supported-extensions)
(progn
(smtpmail-send-command process (format "XUSR"))
(if (or (null (car (setq response-code (smtpmail-read-response process))))
(not (integerp (car response-code)))
(>= (car response-code) 400))
(throw 'done nil))))
;; MAIL FROM:<sender>
(let ((size-part
(if (or (member 'size supported-extensions)
(assoc 'size supported-extensions))
(format " SIZE=%d"
(with-current-buffer smtpmail-text-buffer
;; size estimate:
(+ (- (point-max) (point-min))
;; Add one byte for each change-of-line
;; because of CR-LF representation:
(count-lines (point-min) (point-max)))))
""))
(body-part
(if (member '8bitmime supported-extensions)
;; FIXME:
;; Code should be added here that transforms
;; the contents of the message buffer into
;; something the receiving SMTP can handle.
;; For a receiver that supports 8BITMIME, this
;; may mean converting BINARY to BASE64, or
;; adding Content-Transfer-Encoding and the
;; other MIME headers. The code should also
;; return an indication of what encoding the
;; message buffer is now, i.e. ASCII or
;; 8BITMIME.
(if nil
" BODY=8BITMIME"
"")
"")))
; (smtpmail-send-command process (format "MAIL FROM:%s@%s" (user-login-name) (smtpmail-fqdn)))
(smtpmail-send-command process (format "MAIL FROM:<%s>%s%s"
envelope-from
size-part
body-part))
(if (or (null (car (setq response-code (smtpmail-read-response process))))
(not (integerp (car response-code)))
(>= (car response-code) 400))
(throw 'done nil)
))
;; RCPT TO:<recipient>
(let ((n 0))
(while (not (null (nth n recipient)))
(smtpmail-send-command process (format "RCPT TO:<%s>" (smtpmail-maybe-append-domain (nth n recipient))))
(setq n (1+ n))
(setq response-code (smtpmail-read-response process))
(if (or (null (car response-code))
(not (integerp (car response-code)))
(>= (car response-code) 400))
(throw 'done nil)
)
))
;; DATA
(smtpmail-send-command process "DATA")
(if (or (null (car (setq response-code (smtpmail-read-response process))))
(not (integerp (car response-code)))
(>= (car response-code) 400))
(throw 'done nil)
)
;; Mail contents
(smtpmail-send-data process smtpmail-text-buffer)
;;DATA end "."
(smtpmail-send-command process ".")
(if (or (null (car (setq response-code (smtpmail-read-response process))))
(not (integerp (car response-code)))
(>= (car response-code) 400))
(throw 'done nil)
)
;;QUIT
; (smtpmail-send-command process "QUIT")
; (and (null (car (smtpmail-read-response process)))
; (throw 'done nil))
t ))
(if process
(with-current-buffer (process-buffer process)
(smtpmail-send-command process "QUIT")
(smtpmail-read-response process)
; (if (or (null (car (setq response-code (smtpmail-read-response process))))
; (not (integerp (car response-code)))
; (>= (car response-code) 400))
; (throw 'done nil)
; )
(delete-process process)
(unless smtpmail-debug-info
(kill-buffer process-buffer)))))))
(defun smtpmail-process-filter (process output)
(with-current-buffer (process-buffer process)
(goto-char (point-max))
(insert output)))
(defun smtpmail-read-response (process)
(let ((case-fold-search nil)
(response-strings nil)
(response-continue t)
(return-value '(nil ()))
match-end)
(catch 'done
(while response-continue
(goto-char smtpmail-read-point)
(while (not (search-forward "\r\n" nil t))
(unless (memq (process-status process) '(open run))
(throw 'done nil))
(accept-process-output process)
(goto-char smtpmail-read-point))
(setq match-end (point))
(setq response-strings
(cons (buffer-substring smtpmail-read-point (- match-end 2))
response-strings))
(goto-char smtpmail-read-point)
(if (looking-at "[0-9]+ ")
(let ((begin (match-beginning 0))
(end (match-end 0)))
(if smtpmail-debug-info
(message "%s" (car response-strings)))
(setq smtpmail-read-point match-end)
;; ignore lines that start with "0"
(if (looking-at "0[0-9]+ ")
nil
(setq response-continue nil)
(setq return-value
(cons (string-to-number
(buffer-substring begin end))
(nreverse response-strings)))))
(if (looking-at "[0-9]+-")
(progn (if smtpmail-debug-info
(message "%s" (car response-strings)))
(setq smtpmail-read-point match-end)
(setq response-continue t))
(progn
(setq smtpmail-read-point match-end)
(setq response-continue nil)
(setq return-value
(cons nil (nreverse response-strings)))))))
(setq smtpmail-read-point match-end))
return-value))
(defun smtpmail-send-command (process command)
(goto-char (point-max))
(if (= (aref command 0) ?P)
(insert "PASS <omitted>\r\n")
(insert command "\r\n"))
(setq smtpmail-read-point (point))
(process-send-string process command)
(process-send-string process "\r\n"))
(defun smtpmail-send-data-1 (process data)
(goto-char (point-max))
(if (and (multibyte-string-p data)
smtpmail-code-conv-from)
(setq data (string-as-multibyte
(encode-coding-string data smtpmail-code-conv-from))))
(if smtpmail-debug-info
(insert data "\r\n"))
(setq smtpmail-read-point (point))
;; Escape "." at start of a line
(if (eq (string-to-char data) ?.)
(process-send-string process "."))
(process-send-string process data)
(process-send-string process "\r\n")
)
(defun smtpmail-send-data (process buffer)
(let ((data-continue t) sending-data)
(with-current-buffer buffer
(goto-char (point-min)))
(while data-continue
(with-current-buffer buffer
(setq sending-data (buffer-substring (point-at-bol) (point-at-eol)))
(end-of-line 2)
(setq data-continue (not (eobp))))
(smtpmail-send-data-1 process sending-data))))
(defun smtpmail-deduce-address-list (smtpmail-text-buffer header-start header-end)
"Get address list suitable for smtp RCPT TO: <address>."
(unwind-protect
(with-current-buffer smtpmail-address-buffer
(erase-buffer)
(let
((case-fold-search t)
(simple-address-list "")
this-line
this-line-end
addr-regexp)
(insert-buffer-substring smtpmail-text-buffer header-start header-end)
(goto-char (point-min))
;; RESENT-* fields should stop processing of regular fields.
(save-excursion
(setq addr-regexp
(if (re-search-forward "^Resent-\\(to\\|cc\\|bcc\\):"
header-end t)
"^Resent-\\(to\\|cc\\|bcc\\):"
"^\\(To:\\|Cc:\\|Bcc:\\)")))
(while (re-search-forward addr-regexp header-end t)
(replace-match "")
(setq this-line (match-beginning 0))
(forward-line 1)
;; get any continuation lines
(while (and (looking-at "^[ \t]+") (< (point) header-end))
(forward-line 1))
(setq this-line-end (point-marker))
(setq simple-address-list
(concat simple-address-list " "
(mail-strip-quoted-names (buffer-substring this-line this-line-end))))
)
(erase-buffer)
(insert " " simple-address-list "\n")
(subst-char-in-region (point-min) (point-max) 10 ? t);; newline --> blank
(subst-char-in-region (point-min) (point-max) ?, ? t);; comma --> blank
(subst-char-in-region (point-min) (point-max) 9 ? t);; tab --> blank
(goto-char (point-min))
;; tidyness in case hook is not robust when it looks at this
(while (re-search-forward "[ \t]+" header-end t) (replace-match " "))
(goto-char (point-min))
(let (recipient-address-list)
(while (re-search-forward " \\([^ ]+\\) " (point-max) t)
(backward-char 1)
(setq recipient-address-list (cons (buffer-substring (match-beginning 1) (match-end 1))
recipient-address-list))
)
(setq smtpmail-recipient-address-list recipient-address-list))
)
)
)
)
(defun smtpmail-do-bcc (header-end)
"Delete [Resent-]BCC: and their continuation lines from the header area.
There may be multiple BCC: lines, and each may have arbitrarily
many continuation lines."
(let ((case-fold-search t))
(save-excursion
(goto-char (point-min))
;; iterate over all BCC: lines
(while (re-search-forward "^\\(RESENT-\\)?BCC:" header-end t)
(delete-region (match-beginning 0)
(progn (forward-line 1) (point)))
;; get rid of any continuation lines
(while (and (looking-at "^[ \t].*\n") (< (point) header-end))
(replace-match ""))))))
(provide 'smtpmail)
;;; arch-tag: a76992df-6d71-43b7-9e72-4bacc6c05466
;;; smtpmail.el ends here
author | Bastien Guerry <bzg@altern.org> |
---|---|
date | Wed, 13 Feb 2008 20:58:26 +0000 |
parents | 38f93f3d00a2 |
children | 53108e6cea98 |
line wrap: on
line source
# ...................................................................... # DocBook document hierarchy module V4.2 ............................... # File dbhierx.mod ..................................................... # Copyright 1992-2002 HaL Computer Systems, Inc., # O'Reilly & Associates, Inc., ArborText, Inc., Fujitsu Software # Corporation, Norman Walsh, Sun Microsystems, Inc., and the # Organization for the Advancement of Structured Information # Standards (OASIS). # # $Id: dbhier.rnc,v 1.1 2003/08/30 04:19:27 jjc Exp $ # # Permission to use, copy, modify and distribute the DocBook DTD # and its accompanying documentation for any purpose and without fee # is hereby granted in perpetuity, provided that the above copyright # notice and this paragraph appear in all copies. The copyright # holders make no representation about the suitability of the DTD for # any purpose. It is provided "as is" without expressed or implied # warranty. # # If you modify the DocBook DTD in any way, except for declaring and # referencing additional sets of general entities and declaring # additional notations, label your DTD as a variant of DocBook. See # the maintenance documentation for more information. # # Please direct all questions, bug reports, or suggestions for # changes to the docbook@lists.oasis-open.org mailing list. For more # information, see http://www.oasis-open.org/docbook/. # ...................................................................... # This module contains the definitions for the overall document # hierarchies of DocBook documents. It covers computer documentation # manuals and manual fragments, as well as reference entries (such as # man pages) and technical journals or anthologies containing # articles. # # This module depends on the DocBook information pool module. All # elements and entities referenced but not defined here are assumed # to be defined in the information pool module. # # In DTD driver files referring to this module, please use an entity # declaration that uses the public identifier shown below: # # <!ENTITY % dbhier PUBLIC # "-//OASIS//ELEMENTS DocBook Document Hierarchy V4.2//EN" # "dbhierx.mod"> # %dbhier; # # See the documentation for detailed information on the parameter # entity and module scheme used in DocBook, customizing DocBook and # planning for interchange, and changes made since the last release # of DocBook. # ...................................................................... # Entities for module inclusions ....................................... # ...................................................................... # Entities for element classes ......................................... local.appendix.class = notAllowed appendix.class = appendix | local.appendix.class local.article.class = notAllowed article.class = article | local.article.class local.book.class = notAllowed book.class = book | local.book.class local.chapter.class = notAllowed chapter.class = chapter | local.chapter.class local.index.class = notAllowed index.class = index | setindex | local.index.class local.refentry.class = notAllowed refentry.class = refentry | local.refentry.class local.section.class = notAllowed section.class = section | local.section.class local.nav.class = notAllowed nav.class = toc | lot | index | glossary | bibliography | local.nav.class # Redeclaration placeholder ............................................ # For redeclaring entities that are declared after this point while # retaining their references to the entities that are declared before # this point # ...................................................................... # Entities for element mixtures ........................................ # The DocBook TC may produce an official forms module for DocBook. # This PE provides the hook by which it can be inserted into the DTD. forms.hook = notAllowed local.divcomponent.mix = notAllowed divcomponent.mix = list.class | admon.class | linespecific.class | synop.class | para.class | informal.class | formal.class | compound.class | genobj.class | descobj.class | ndxterm.class | beginpage | forms.hook | local.divcomponent.mix local.refcomponent.mix = notAllowed refcomponent.mix = list.class | admon.class | linespecific.class | synop.class | para.class | informal.class | formal.class | compound.class | genobj.class | descobj.class | ndxterm.class | beginpage | local.refcomponent.mix local.indexdivcomponent.mix = notAllowed indexdivcomponent.mix = itemizedlist | orderedlist | variablelist | simplelist | linespecific.class | synop.class | para.class | informal.class | anchor | remark | link.char.class | beginpage | local.indexdivcomponent.mix local.refname.char.mix = notAllowed refname.char.mix = text | tech.char.class | local.refname.char.mix local.partcontent.mix = notAllowed partcontent.mix = appendix.class | chapter.class | nav.class | article.class | preface | refentry.class | reference | local.partcontent.mix local.refinline.char.mix = notAllowed refinline.char.mix = text | xref.char.class | gen.char.class | link.char.class | tech.char.class | base.char.class | docinfo.char.class | other.char.class | ndxterm.class | beginpage | local.refinline.char.mix local.refclass.char.mix = notAllowed refclass.char.mix = text | application | local.refclass.char.mix # Redeclaration placeholder 2 .......................................... # For redeclaring entities that are declared after this point while # retaining their references to the entities that are declared before # this point # ...................................................................... # Entities for content models .......................................... div.title.content = title, subtitle?, titleabbrev? bookcomponent.title.content = title, subtitle?, titleabbrev? sect.title.content = title, subtitle?, titleabbrev? refsect.title.content = title, subtitle?, titleabbrev? bookcomponent.content = (divcomponent.mix+, (sect1* | refentry.class* | simplesect* | section.class*)) | (sect1+ | refentry.class+ | simplesect+ | section.class+) # ...................................................................... # Set and SetInfo ...................................................... local.set.attrib = empty set.role.attrib = role.attrib set = element set { set.attlist, div.title.content?, setinfo?, toc?, book.class+, setindex? } # end of set.element # FPI: SGML formal public identifier set.attlist &= attribute fpi { text }?, status.attrib, common.attrib, set.role.attrib, local.set.attrib # end of set.attlist # end of set.module local.setinfo.attrib = empty setinfo.role.attrib = role.attrib setinfo = element setinfo { setinfo.attlist, info.class+ } # end of setinfo.element # Contents: IDs of the ToC, Books, and SetIndex that comprise # the set, in the order of their appearance setinfo.attlist &= attribute contents { xsd:IDREFS }?, common.attrib, setinfo.role.attrib, local.setinfo.attrib # end of setinfo.attlist # end of setinfo.module # end of set.content.module # ...................................................................... # Book and BookInfo .................................................... local.book.attrib = empty book.role.attrib = role.attrib book = element book { book.attlist, div.title.content?, bookinfo?, (dedication | toc | lot | glossary | bibliography | preface | chapter.class | reference | part | article.class | appendix.class | index.class | colophon)* } # end of book.element # FPI: SGML formal public identifier book.attlist &= attribute fpi { text }?, label.attrib, status.attrib, common.attrib, book.role.attrib, local.book.attrib # end of book.attlist # end of book.module local.bookinfo.attrib = empty bookinfo.role.attrib = role.attrib bookinfo = element bookinfo { bookinfo.attlist, info.class+ } # end of bookinfo.element # Contents: IDs of the ToC, LoTs, Prefaces, Parts, Chapters, # Appendixes, References, GLossary, Bibliography, and indexes # comprising the Book, in the order of their appearance bookinfo.attlist &= attribute contents { xsd:IDREFS }?, common.attrib, bookinfo.role.attrib, local.bookinfo.attrib # end of bookinfo.attlist # end of bookinfo.module # end of book.content.module # ...................................................................... # Dedication, ToC, and LoT ............................................. local.dedication.attrib = empty dedication.role.attrib = role.attrib dedication = element dedication { dedication.attlist, sect.title.content?, legalnotice.mix+ } # end of dedication.element dedication.attlist &= status.attrib, common.attrib, dedication.role.attrib, local.dedication.attrib # end of dedication.attlist # end of dedication.module local.colophon.attrib = empty colophon.role.attrib = role.attrib colophon = element colophon { colophon.attlist, sect.title.content?, textobject.mix+ } # end of colophon.element colophon.attlist &= status.attrib, common.attrib, colophon.role.attrib, local.colophon.attrib # end of colophon.attlist # end of colophon.module local.toc.attrib = empty toc.role.attrib = role.attrib toc = element toc { toc.attlist, beginpage?, bookcomponent.title.content?, tocfront*, (tocpart | tocchap)*, tocback* } # end of toc.element toc.attlist &= pagenum.attrib, common.attrib, toc.role.attrib, local.toc.attrib # end of toc.attlist # end of toc.module local.tocfront.attrib = empty tocfront.role.attrib = role.attrib tocfront = element tocfront { tocfront.attlist, para.char.mix* } # end of tocfront.element # to element that this entry represents tocfront.attlist &= label.attrib, linkend.attrib, pagenum.attrib, common.attrib, tocfront.role.attrib, local.tocfront.attrib # end of tocfront.attlist # end of tocfront.module local.tocentry.attrib = empty tocentry.role.attrib = role.attrib tocentry = element tocentry { tocentry.attlist, para.char.mix* } # end of tocentry.element # to element that this entry represents tocentry.attlist &= linkend.attrib, pagenum.attrib, common.attrib, tocentry.role.attrib, local.tocentry.attrib # end of tocentry.attlist # end of tocentry.module local.tocpart.attrib = empty tocpart.role.attrib = role.attrib tocpart = element tocpart { tocpart.attlist, tocentry+, tocchap* } # end of tocpart.element tocpart.attlist &= common.attrib, tocpart.role.attrib, local.tocpart.attrib # end of tocpart.attlist # end of tocpart.module local.tocchap.attrib = empty tocchap.role.attrib = role.attrib tocchap = element tocchap { tocchap.attlist, tocentry+, toclevel1* } # end of tocchap.element tocchap.attlist &= label.attrib, common.attrib, tocchap.role.attrib, local.tocchap.attrib # end of tocchap.attlist # end of tocchap.module local.toclevel1.attrib = empty toclevel1.role.attrib = role.attrib toclevel1 = element toclevel1 { toclevel1.attlist, tocentry+, toclevel2* } # end of toclevel1.element toclevel1.attlist &= common.attrib, toclevel1.role.attrib, local.toclevel1.attrib # end of toclevel1.attlist # end of toclevel1.module local.toclevel2.attrib = empty toclevel2.role.attrib = role.attrib toclevel2 = element toclevel2 { toclevel2.attlist, tocentry+, toclevel3* } # end of toclevel2.element toclevel2.attlist &= common.attrib, toclevel2.role.attrib, local.toclevel2.attrib # end of toclevel2.attlist # end of toclevel2.module local.toclevel3.attrib = empty toclevel3.role.attrib = role.attrib toclevel3 = element toclevel3 { toclevel3.attlist, tocentry+, toclevel4* } # end of toclevel3.element toclevel3.attlist &= common.attrib, toclevel3.role.attrib, local.toclevel3.attrib # end of toclevel3.attlist # end of toclevel3.module local.toclevel4.attrib = empty toclevel4.role.attrib = role.attrib toclevel4 = element toclevel4 { toclevel4.attlist, tocentry+, toclevel5* } # end of toclevel4.element toclevel4.attlist &= common.attrib, toclevel4.role.attrib, local.toclevel4.attrib # end of toclevel4.attlist # end of toclevel4.module local.toclevel5.attrib = empty toclevel5.role.attrib = role.attrib toclevel5 = element toclevel5 { toclevel5.attlist, tocentry+ } # end of toclevel5.element toclevel5.attlist &= common.attrib, toclevel5.role.attrib, local.toclevel5.attrib # end of toclevel5.attlist # end of toclevel5.module local.tocback.attrib = empty tocback.role.attrib = role.attrib tocback = element tocback { tocback.attlist, para.char.mix* } # end of tocback.element # to element that this entry represents tocback.attlist &= label.attrib, linkend.attrib, pagenum.attrib, common.attrib, tocback.role.attrib, local.tocback.attrib # end of tocback.attlist # end of tocback.module # end of toc.content.module local.lot.attrib = empty lot.role.attrib = role.attrib lot = element lot { lot.attlist, beginpage?, bookcomponent.title.content?, lotentry* } # end of lot.element lot.attlist &= label.attrib, common.attrib, lot.role.attrib, local.lot.attrib # end of lot.attlist # end of lot.module local.lotentry.attrib = empty lotentry.role.attrib = role.attrib lotentry = element lotentry { lotentry.attlist, para.char.mix* } # end of lotentry.element # SrcCredit: Information about the source of the entry, # as for a list of illustrations # linkend: to element that this entry represents lotentry.attlist &= linkend.attrib, pagenum.attrib, attribute srccredit { text }?, common.attrib, lotentry.role.attrib, local.lotentry.attrib # end of lotentry.attlist # end of lotentry.module # end of lot.content.module # ...................................................................... # Appendix, Chapter, Part, Preface, Reference, PartIntro ............... local.appendix.attrib = empty appendix.role.attrib = role.attrib appendix = element appendix { appendix.attlist, beginpage?, appendixinfo?, bookcomponent.title.content, nav.class*, tocchap?, bookcomponent.content, nav.class* } # end of appendix.element appendix.attlist &= label.attrib, status.attrib, common.attrib, appendix.role.attrib, local.appendix.attrib # end of appendix.attlist # end of appendix.module local.chapter.attrib = empty chapter.role.attrib = role.attrib chapter = element chapter { chapter.attlist, beginpage?, chapterinfo?, bookcomponent.title.content, nav.class*, tocchap?, bookcomponent.content, nav.class* } # end of chapter.element chapter.attlist &= label.attrib, status.attrib, common.attrib, chapter.role.attrib, local.chapter.attrib # end of chapter.attlist # end of chapter.module # Note that Part was to have its content model reduced in V4.2. This # change will not be made after all. local.part.attrib = empty part.role.attrib = role.attrib part = element part { part.attlist, beginpage?, partinfo?, bookcomponent.title.content, partintro?, partcontent.mix+ } # end of part.element part.attlist &= label.attrib, status.attrib, common.attrib, part.role.attrib, local.part.attrib # end of part.attlist # ELEMENT PartIntro (defined below) # end of part.module local.preface.attrib = empty preface.role.attrib = role.attrib preface = element preface { preface.attlist, beginpage?, prefaceinfo?, bookcomponent.title.content, nav.class*, tocchap?, bookcomponent.content, nav.class* } # end of preface.element preface.attlist &= status.attrib, common.attrib, preface.role.attrib, local.preface.attrib # end of preface.attlist # end of preface.module local.reference.attrib = empty reference.role.attrib = role.attrib reference = element reference { reference.attlist, beginpage?, referenceinfo?, bookcomponent.title.content, partintro?, refentry.class+ } # end of reference.element reference.attlist &= label.attrib, status.attrib, common.attrib, reference.role.attrib, local.reference.attrib # end of reference.attlist # ELEMENT PartIntro (defined below) # end of reference.module local.partintro.attrib = empty partintro.role.attrib = role.attrib partintro = element partintro { partintro.attlist, div.title.content?, bookcomponent.content } # end of partintro.element partintro.attlist &= label.attrib, common.attrib, partintro.role.attrib, local.partintro.attrib # end of partintro.attlist # end of partintro.module # ...................................................................... # Other Info elements .................................................. local.appendixinfo.attrib = empty appendixinfo.role.attrib = role.attrib appendixinfo = element appendixinfo { appendixinfo.attlist, info.class+ } # end of appendixinfo.element appendixinfo.attlist &= common.attrib, appendixinfo.role.attrib, local.appendixinfo.attrib # end of appendixinfo.attlist # end of appendixinfo.module local.bibliographyinfo.attrib = empty bibliographyinfo.role.attrib = role.attrib bibliographyinfo = element bibliographyinfo { bibliographyinfo.attlist, info.class+ } # end of bibliographyinfo.element bibliographyinfo.attlist &= common.attrib, bibliographyinfo.role.attrib, local.bibliographyinfo.attrib # end of bibliographyinfo.attlist # end of bibliographyinfo.module local.chapterinfo.attrib = empty chapterinfo.role.attrib = role.attrib chapterinfo = element chapterinfo { chapterinfo.attlist, info.class+ } # end of chapterinfo.element chapterinfo.attlist &= common.attrib, chapterinfo.role.attrib, local.chapterinfo.attrib # end of chapterinfo.attlist # end of chapterinfo.module local.glossaryinfo.attrib = empty glossaryinfo.role.attrib = role.attrib glossaryinfo = element glossaryinfo { glossaryinfo.attlist, info.class+ } # end of glossaryinfo.element glossaryinfo.attlist &= common.attrib, glossaryinfo.role.attrib, local.glossaryinfo.attrib # end of glossaryinfo.attlist # end of glossaryinfo.module local.indexinfo.attrib = empty indexinfo.role.attrib = role.attrib indexinfo = element indexinfo { indexinfo.attlist, info.class+ } # end of indexinfo.element indexinfo.attlist &= common.attrib, indexinfo.role.attrib, local.indexinfo.attrib # end of indexinfo.attlist # end of indexinfo.module local.setindexinfo.attrib = empty setindexinfo.role.attrib = role.attrib setindexinfo = element setindexinfo { setindexinfo.attlist, info.class+ } # end of setindexinfo.element setindexinfo.attlist &= common.attrib, setindexinfo.role.attrib, local.setindexinfo.attrib # end of setindexinfo.attlist # end of setindexinfo.module local.partinfo.attrib = empty partinfo.role.attrib = role.attrib partinfo = element partinfo { partinfo.attlist, info.class+ } # end of partinfo.element partinfo.attlist &= common.attrib, partinfo.role.attrib, local.partinfo.attrib # end of partinfo.attlist # end of partinfo.module local.prefaceinfo.attrib = empty prefaceinfo.role.attrib = role.attrib prefaceinfo = element prefaceinfo { prefaceinfo.attlist, info.class+ } # end of prefaceinfo.element prefaceinfo.attlist &= common.attrib, prefaceinfo.role.attrib, local.prefaceinfo.attrib # end of prefaceinfo.attlist # end of prefaceinfo.module local.refentryinfo.attrib = empty refentryinfo.role.attrib = role.attrib refentryinfo = element refentryinfo { refentryinfo.attlist, info.class+ } # end of refentryinfo.element refentryinfo.attlist &= common.attrib, refentryinfo.role.attrib, local.refentryinfo.attrib # end of refentryinfo.attlist # end of refentryinfo.module local.refsectioninfo.attrib = empty refsectioninfo.role.attrib = role.attrib refsectioninfo = element refsectioninfo { refsectioninfo.attlist, info.class+ } # end of refsectioninfo.element refsectioninfo.attlist &= common.attrib, refsectioninfo.role.attrib, local.refsectioninfo.attrib # end of refsectioninfo.attlist # end of refsectioninfo.module local.refsect1info.attrib = empty refsect1info.role.attrib = role.attrib refsect1info = element refsect1info { refsect1info.attlist, info.class+ } # end of refsect1info.element refsect1info.attlist &= common.attrib, refsect1info.role.attrib, local.refsect1info.attrib # end of refsect1info.attlist # end of refsect1info.module local.refsect2info.attrib = empty refsect2info.role.attrib = role.attrib refsect2info = element refsect2info { refsect2info.attlist, info.class+ } # end of refsect2info.element refsect2info.attlist &= common.attrib, refsect2info.role.attrib, local.refsect2info.attrib # end of refsect2info.attlist # end of refsect2info.module local.refsect3info.attrib = empty refsect3info.role.attrib = role.attrib refsect3info = element refsect3info { refsect3info.attlist, info.class+ } # end of refsect3info.element refsect3info.attlist &= common.attrib, refsect3info.role.attrib, local.refsect3info.attrib # end of refsect3info.attlist # end of refsect3info.module local.refsynopsisdivinfo.attrib = empty refsynopsisdivinfo.role.attrib = role.attrib refsynopsisdivinfo = element refsynopsisdivinfo { refsynopsisdivinfo.attlist, info.class+ } # end of refsynopsisdivinfo.element refsynopsisdivinfo.attlist &= common.attrib, refsynopsisdivinfo.role.attrib, local.refsynopsisdivinfo.attrib # end of refsynopsisdivinfo.attlist # end of refsynopsisdivinfo.module local.referenceinfo.attrib = empty referenceinfo.role.attrib = role.attrib referenceinfo = element referenceinfo { referenceinfo.attlist, info.class+ } # end of referenceinfo.element referenceinfo.attlist &= common.attrib, referenceinfo.role.attrib, local.referenceinfo.attrib # end of referenceinfo.attlist # end of referenceinfo.module local.sect1info.attrib = empty sect1info.role.attrib = role.attrib sect1info = element sect1info { sect1info.attlist, info.class+ } # end of sect1info.element sect1info.attlist &= common.attrib, sect1info.role.attrib, local.sect1info.attrib # end of sect1info.attlist local.sect2info.attrib = empty sect2info.role.attrib = role.attrib sect2info = element sect2info { sect2info.attlist, info.class+ } # end of sect2info.element sect2info.attlist &= common.attrib, sect2info.role.attrib, local.sect2info.attrib # end of sect2info.attlist local.sect3info.attrib = empty sect3info.role.attrib = role.attrib sect3info = element sect3info { sect3info.attlist, info.class+ } # end of sect3info.element sect3info.attlist &= common.attrib, sect3info.role.attrib, local.sect3info.attrib # end of sect3info.attlist local.sect4info.attrib = empty sect4info.role.attrib = role.attrib sect4info = element sect4info { sect4info.attlist, info.class+ } # end of sect4info.element sect4info.attlist &= common.attrib, sect4info.role.attrib, local.sect4info.attrib # end of sect4info.attlist local.sect5info.attrib = empty sect5info.role.attrib = role.attrib sect5info = element sect5info { sect5info.attlist, info.class+ } # end of sect5info.element sect5info.attlist &= common.attrib, sect5info.role.attrib, local.sect5info.attrib # end of sect5info.attlist # ...................................................................... # Section (parallel to Sect*) ......................................... local.section.attrib = empty section.role.attrib = role.attrib section = element section { section.attlist, sectioninfo?, sect.title.content, nav.class*, ((divcomponent.mix+, (refentry.class* | section.class* | simplesect*)) | refentry.class+ | section.class+ | simplesect+), nav.class* } # end of section.element section.attlist &= label.attrib, status.attrib, common.attrib, section.role.attrib, local.section.attrib # end of section.attlist # end of section.module sectioninfo.role.attrib = role.attrib local.sectioninfo.attrib = empty sectioninfo = element sectioninfo { sectioninfo.attlist, info.class+ } # end of sectioninfo.element sectioninfo.attlist &= common.attrib, sectioninfo.role.attrib, local.sectioninfo.attrib # end of sectioninfo.attlist # end of sectioninfo.module # end of section.content.module # ...................................................................... # Sect1, Sect2, Sect3, Sect4, Sect5 .................................... local.sect1.attrib = empty sect1.role.attrib = role.attrib sect1 = element sect1 { sect1.attlist, sect1info?, sect.title.content, nav.class*, ((divcomponent.mix+, (refentry.class* | sect2* | simplesect*)) | refentry.class+ | sect2+ | simplesect+), nav.class* } # end of sect1.element # Renderas: Indicates the format in which the heading should # appear sect1.attlist &= attribute renderas { "sect2" | "sect3" | "sect4" | "sect5" }?, label.attrib, status.attrib, common.attrib, sect1.role.attrib, local.sect1.attrib # end of sect1.attlist # end of sect1.module local.sect2.attrib = empty sect2.role.attrib = role.attrib sect2 = element sect2 { sect2.attlist, sect2info?, sect.title.content, nav.class*, ((divcomponent.mix+, (refentry.class* | sect3* | simplesect*)) | refentry.class+ | sect3+ | simplesect+), nav.class* } # end of sect2.element # Renderas: Indicates the format in which the heading should # appear sect2.attlist &= attribute renderas { "sect1" | "sect3" | "sect4" | "sect5" }?, label.attrib, status.attrib, common.attrib, sect2.role.attrib, local.sect2.attrib # end of sect2.attlist # end of sect2.module local.sect3.attrib = empty sect3.role.attrib = role.attrib sect3 = element sect3 { sect3.attlist, sect3info?, sect.title.content, nav.class*, ((divcomponent.mix+, (refentry.class* | sect4* | simplesect*)) | refentry.class+ | sect4+ | simplesect+), nav.class* } # end of sect3.element # Renderas: Indicates the format in which the heading should # appear sect3.attlist &= attribute renderas { "sect1" | "sect2" | "sect4" | "sect5" }?, label.attrib, status.attrib, common.attrib, sect3.role.attrib, local.sect3.attrib # end of sect3.attlist # end of sect3.module local.sect4.attrib = empty sect4.role.attrib = role.attrib sect4 = element sect4 { sect4.attlist, sect4info?, sect.title.content, nav.class*, ((divcomponent.mix+, (refentry.class* | sect5* | simplesect*)) | refentry.class+ | sect5+ | simplesect+), nav.class* } # end of sect4.element # Renderas: Indicates the format in which the heading should # appear sect4.attlist &= attribute renderas { "sect1" | "sect2" | "sect3" | "sect5" }?, label.attrib, status.attrib, common.attrib, sect4.role.attrib, local.sect4.attrib # end of sect4.attlist # end of sect4.module local.sect5.attrib = empty sect5.role.attrib = role.attrib sect5 = element sect5 { sect5.attlist, sect5info?, sect.title.content, nav.class*, ((divcomponent.mix+, (refentry.class* | simplesect*)) | refentry.class+ | simplesect+), nav.class* } # end of sect5.element # Renderas: Indicates the format in which the heading should # appear sect5.attlist &= attribute renderas { "sect1" | "sect2" | "sect3" | "sect4" }?, label.attrib, status.attrib, common.attrib, sect5.role.attrib, local.sect5.attrib # end of sect5.attlist # end of sect5.module local.simplesect.attrib = empty simplesect.role.attrib = role.attrib simplesect = element simplesect { simplesect.attlist, sect.title.content, divcomponent.mix+ } # end of simplesect.element simplesect.attlist &= common.attrib, simplesect.role.attrib, local.simplesect.attrib # end of simplesect.attlist # end of simplesect.module # ...................................................................... # Bibliography ......................................................... local.bibliography.attrib = empty bibliography.role.attrib = role.attrib bibliography = element bibliography { bibliography.attlist, bibliographyinfo?, bookcomponent.title.content?, component.mix*, (bibliodiv+ | (biblioentry | bibliomixed)+) } # end of bibliography.element bibliography.attlist &= status.attrib, common.attrib, bibliography.role.attrib, local.bibliography.attrib # end of bibliography.attlist # end of bibliography.module local.bibliodiv.attrib = empty bibliodiv.role.attrib = role.attrib bibliodiv = element bibliodiv { bibliodiv.attlist, sect.title.content?, component.mix*, (biblioentry | bibliomixed)+ } # end of bibliodiv.element bibliodiv.attlist &= status.attrib, common.attrib, bibliodiv.role.attrib, local.bibliodiv.attrib # end of bibliodiv.attlist # end of bibliodiv.module # end of bibliography.content.module # ...................................................................... # Glossary ............................................................. local.glossary.attrib = empty glossary.role.attrib = role.attrib glossary = element glossary { glossary.attlist, glossaryinfo?, bookcomponent.title.content?, component.mix*, (glossdiv+ | glossentry+), bibliography? } # end of glossary.element glossary.attlist &= status.attrib, common.attrib, glossary.role.attrib, local.glossary.attrib # end of glossary.attlist # end of glossary.module local.glossdiv.attrib = empty glossdiv.role.attrib = role.attrib glossdiv = element glossdiv { glossdiv.attlist, sect.title.content, component.mix*, glossentry+ } # end of glossdiv.element glossdiv.attlist &= status.attrib, common.attrib, glossdiv.role.attrib, local.glossdiv.attrib # end of glossdiv.attlist # end of glossdiv.module # end of glossary.content.module # ...................................................................... # Index and SetIndex ................................................... local.indexes.attrib = empty indexes.role.attrib = role.attrib index = element index { index.attlist, indexinfo?, bookcomponent.title.content?, component.mix*, (indexdiv* | indexentry*) } # end of index.element index.attlist &= common.attrib, indexes.role.attrib, local.indexes.attrib # end of index.attlist setindex = element setindex { setindex.attlist, setindexinfo?, bookcomponent.title.content?, component.mix*, (indexdiv* | indexentry*) } # end of setindex.element setindex.attlist &= common.attrib, indexes.role.attrib, local.indexes.attrib # end of setindex.attlist # end of indexes.module # SegmentedList in this content is useful for marking up permuted # indices. local.indexdiv.attrib = empty indexdiv.role.attrib = role.attrib indexdiv = element indexdiv { indexdiv.attlist, sect.title.content?, (indexdivcomponent.mix*, (indexentry+ | segmentedlist)) } # end of indexdiv.element indexdiv.attlist &= common.attrib, indexdiv.role.attrib, local.indexdiv.attrib # end of indexdiv.attlist # end of indexdiv.module # Index entries appear in the index, not the text. local.indexentry.attrib = empty indexentry.role.attrib = role.attrib indexentry = element indexentry { indexentry.attlist, primaryie, (seeie | seealsoie)*, (secondaryie, (seeie | seealsoie | tertiaryie)*)* } # end of indexentry.element indexentry.attlist &= common.attrib, indexentry.role.attrib, local.indexentry.attrib # end of indexentry.attlist # end of indexentry.module local.primsecterie.attrib = empty primsecterie.role.attrib = role.attrib primaryie = element primaryie { primaryie.attlist, ndxterm.char.mix* } # end of primaryie.element # to IndexTerms that these entries represent primaryie.attlist &= linkends.attrib, common.attrib, primsecterie.role.attrib, local.primsecterie.attrib # end of primaryie.attlist secondaryie = element secondaryie { secondaryie.attlist, ndxterm.char.mix* } # end of secondaryie.element # to IndexTerms that these entries represent secondaryie.attlist &= linkends.attrib, common.attrib, primsecterie.role.attrib, local.primsecterie.attrib # end of secondaryie.attlist tertiaryie = element tertiaryie { tertiaryie.attlist, ndxterm.char.mix* } # end of tertiaryie.element # to IndexTerms that these entries represent tertiaryie.attlist &= linkends.attrib, common.attrib, primsecterie.role.attrib, local.primsecterie.attrib # end of tertiaryie.attlist # end of primsecterie.module local.seeie.attrib = empty seeie.role.attrib = role.attrib seeie = element seeie { seeie.attlist, ndxterm.char.mix* } # end of seeie.element # to IndexEntry to look up seeie.attlist &= linkend.attrib, common.attrib, seeie.role.attrib, local.seeie.attrib # end of seeie.attlist # end of seeie.module local.seealsoie.attrib = empty seealsoie.role.attrib = role.attrib seealsoie = element seealsoie { seealsoie.attlist, ndxterm.char.mix* } # end of seealsoie.element # to related IndexEntries seealsoie.attlist &= linkends.attrib, common.attrib, seealsoie.role.attrib, local.seealsoie.attrib # end of seealsoie.attlist # end of seealsoie.module # end of index.content.module # ...................................................................... # RefEntry ............................................................. local.refentry.attrib = empty refentry.role.attrib = role.attrib refentry = element refentry { refentry.attlist, beginpage?, ndxterm.class*, refentryinfo?, refmeta?, (remark | link.char.class)*, refnamediv, refsynopsisdiv?, (refsect1+ | refsection+) } # end of refentry.element refentry.attlist &= status.attrib, common.attrib, refentry.role.attrib, local.refentry.attrib # end of refentry.attlist # end of refentry.module local.refmeta.attrib = empty refmeta.role.attrib = role.attrib refmeta = element refmeta { refmeta.attlist, ndxterm.class*, refentrytitle, manvolnum?, refmiscinfo*, ndxterm.class* } # end of refmeta.element refmeta.attlist &= common.attrib, refmeta.role.attrib, local.refmeta.attrib # end of refmeta.attlist # end of refmeta.module local.refmiscinfo.attrib = empty refmiscinfo.role.attrib = role.attrib refmiscinfo = element refmiscinfo { refmiscinfo.attlist, docinfo.char.mix* } # end of refmiscinfo.element # Class: Freely assignable parameter; no default refmiscinfo.attlist &= attribute class { text }?, common.attrib, refmiscinfo.role.attrib, local.refmiscinfo.attrib # end of refmiscinfo.attlist # end of refmiscinfo.module local.refnamediv.attrib = empty refnamediv.role.attrib = role.attrib refnamediv = element refnamediv { refnamediv.attlist, refdescriptor?, refname+, refpurpose, refclass*, (remark | link.char.class)* } # end of refnamediv.element refnamediv.attlist &= common.attrib, refnamediv.role.attrib, local.refnamediv.attrib # end of refnamediv.attlist # end of refnamediv.module local.refdescriptor.attrib = empty refdescriptor.role.attrib = role.attrib refdescriptor = element refdescriptor { refdescriptor.attlist, refname.char.mix* } # end of refdescriptor.element refdescriptor.attlist &= common.attrib, refdescriptor.role.attrib, local.refdescriptor.attrib # end of refdescriptor.attlist # end of refdescriptor.module local.refname.attrib = empty refname.role.attrib = role.attrib refname = element refname { refname.attlist, refname.char.mix* } # end of refname.element refname.attlist &= common.attrib, refname.role.attrib, local.refname.attrib # end of refname.attlist # end of refname.module local.refpurpose.attrib = empty refpurpose.role.attrib = role.attrib refpurpose = element refpurpose { refpurpose.attlist, refinline.char.mix* } # end of refpurpose.element refpurpose.attlist &= common.attrib, refpurpose.role.attrib, local.refpurpose.attrib # end of refpurpose.attlist # end of refpurpose.module local.refclass.attrib = empty refclass.role.attrib = role.attrib refclass = element refclass { refclass.attlist, refclass.char.mix* } # end of refclass.element refclass.attlist &= common.attrib, refclass.role.attrib, local.refclass.attrib # end of refclass.attlist # end of refclass.module local.refsynopsisdiv.attrib = empty refsynopsisdiv.role.attrib = role.attrib refsynopsisdiv = element refsynopsisdiv { refsynopsisdiv.attlist, refsynopsisdivinfo?, refsect.title.content?, ((refcomponent.mix+, refsect2*) | refsect2+) } # end of refsynopsisdiv.element refsynopsisdiv.attlist &= common.attrib, refsynopsisdiv.role.attrib, local.refsynopsisdiv.attrib # end of refsynopsisdiv.attlist # end of refsynopsisdiv.module local.refsection.attrib = empty refsection.role.attrib = role.attrib refsection = element refsection { refsection.attlist, refsectioninfo?, refsect.title.content, ((refcomponent.mix+, refsection*) | refsection+) } # end of refsection.element refsection.attlist &= status.attrib, common.attrib, refsection.role.attrib, local.refsection.attrib # end of refsection.attlist # end of refsection.module local.refsect1.attrib = empty refsect1.role.attrib = role.attrib refsect1 = element refsect1 { refsect1.attlist, refsect1info?, refsect.title.content, ((refcomponent.mix+, refsect2*) | refsect2+) } # end of refsect1.element refsect1.attlist &= status.attrib, common.attrib, refsect1.role.attrib, local.refsect1.attrib # end of refsect1.attlist # end of refsect1.module local.refsect2.attrib = empty refsect2.role.attrib = role.attrib refsect2 = element refsect2 { refsect2.attlist, refsect2info?, refsect.title.content, ((refcomponent.mix+, refsect3*) | refsect3+) } # end of refsect2.element refsect2.attlist &= status.attrib, common.attrib, refsect2.role.attrib, local.refsect2.attrib # end of refsect2.attlist # end of refsect2.module local.refsect3.attrib = empty refsect3.role.attrib = role.attrib refsect3 = element refsect3 { refsect3.attlist, refsect3info?, refsect.title.content, refcomponent.mix+ } # end of refsect3.element refsect3.attlist &= status.attrib, common.attrib, refsect3.role.attrib, local.refsect3.attrib # end of refsect3.attlist # end of refsect3.module # end of refentry.content.module # ...................................................................... # Article .............................................................. # An Article is a chapter-level, stand-alone document that is often, # but need not be, collected into a Book. local.article.attrib = empty article.role.attrib = role.attrib article = element article { article.attlist, div.title.content?, articleinfo?, tocchap?, lot*, bookcomponent.content, (nav.class | appendix.class | ackno)* } # end of article.element # Class: Indicates the type of a particular article; # all articles have the same structure and general purpose. # No default. # ParentBook: ID of the enclosing Book article.attlist &= attribute class { "journalarticle" | "productsheet" | "whitepaper" | "techreport" | "specification" | "faq" }?, attribute parentbook { xsd:IDREF }?, status.attrib, common.attrib, article.role.attrib, local.article.attrib # end of article.attlist # end of article.module # End of DocBook document hierarchy module V4.2 ........................ # ......................................................................