www.delorie.com/gnu/docs/hyperbole/hyperbole_30.html

search

	Buy GNU books!

Hyperbole User Manual

3.7.6 Buttons in Mail

Hyperbole allows the embedding of buttons within electronic mail messages that are composed in Emacs with the standard (mail) command, normally bound to {C-x m} or with other Emacs-based mail composing functions. An enhanced mail reader can then be used to activate the buttons within messages just like any other buttons.

Hyperbole automatically supports the following mail readers: Rmail, section `Rmail' in the GNU Emacs Manual, VM, section `Introduction' in the VM Manual, and PIEmail, and MH-e. Button inclusion and activation within USENET news articles is also supported in the same fashion via the GNUS news reader, section `Introduction' in the GNUS Manual, if available at your site. (The `hmail.el' file provides a generalized interface that can be used to hook in other mail or news readers if the necessary interface functions are written.)

All explicit buttons to be mailed must be created within the outgoing message buffer. There is no present support for including text from other buffers or files which contain explicit buttons, except for the ability to yank the contents of a message being replied to, together with all of its buttons, via the (mail-yank-original) command bound to {C-c C-y}. From a user's perspective, buttons are created in precisely the same way as in any other buffer. They also appear just like any other buttons to both the message sender and the reader who uses the Hyperbole enhanced readers. Button operation may be tested any time before a message is sent. A person who does not use Hyperbole enhanced mail readers can still send messages with embedded buttons since mail composing is independent of any mail reader choice.

Hyperbole buttons embedded within received mail messages act just like any other buttons. The mail does not contain any of the action type definitions used by the buttons, so the receiver must have these or she will receive an error when she activates the buttons. Buttons which appear in message Subject lines are copied to summary buffers whenever such summaries are generated. Thus, they may be activated from either the message or summary buffers.

Nothing bad will happen if a mail message with explicit buttons is sent to a non-Hyperbole user. The user will simply see the text of the message followed by a series of lines of button data at its end. Hyperbole mail users never see this data in its raw form.

In order to alert readers of your mail messages that you can utilize Hyperbole mail buttons, the system automatically inserts a comment into each mail message that you compose to announce this fact. The variable, smail:comment controls this behavior. See its documentation for technical details. By default, it produces a message of the form:

Comments: Hyperbole mail buttons accepted, vX.XX.

where the X's indicate your Hyperbole version number. You can cut this out of particular messages before you send them. If you don't want any message at all, add the following to your `~/.emacs' file before the point at which you load Hyperbole.

(setq smail:comment nil)

A final mail-related facility provided by Hyperbole is the ability to save a pointer to a received mail message by creating an explicit button with a link-to-mail action type. When prompted for the mail message to link to, if you press the Action Key on an Rmail message, the appropriate parameter will be copied to the argument prompt, as described in 6. Entering Arguments.