NewsRog Reference: Display Filters: EMail

Reference: Display Filters: EMail

Contents:	Filter Overview	User Interface & Options
Contents:	Example	Variables

Filter Overview

This display filter searches for email addresses and creates clickable objects that may be used to send mail to the listed email address. It can also generate clickable Message-IDs that may be used to display the indiciated message if it is available.

The format <string@host.name> is frequently used both for message-IDs and for email addresses. However, NewsRog has a sophisticated algorithm for detecting the difference when such a string appears in an article body with over 99% accuracy.

User Interface

The user interface for this filter looks like this:

The available configuration options are:

Multimedia Action - This is an action from the Multimedia Actions list that will be invoked when an email address is clicked. The multimedia type is application/X-email (case sensitive!) The multimedia action may be any user defined action; for example, to send the article text to an email program such as YAM.
Require Dots - If selected, then a string is detected as an email address or a Message-ID only if the hostname component contains a dot (.). For example, "user@myhost.com" would be matched, but not "user@myhost". This can prevent false positives when parsing certain types of data.
Double Click - If selected, then a doubleclick is needed to trigger the default action for this email address or Message-ID. Otherwise, a single click is sufficient.
Use PopMenus - If selected, then a popup menu is created for email addresses and message-IDs allowing the address to be copied to the clipboard, or any multimedia action defined for the indiciated type to be executed. Email address have a multimedia type of application/X-email, and message-IDs have a multimedia type of application/X-MsgID. Both are case sensitive. More than one multimedia action may be defined, for example, to send an article to different email programs.
email Font - If non-null, this font is used to display the email addresses.
email Color - If selected, this color is used to display email addresses.
email Style - The text style for displayed email addresses.
email Selected Col - This color is used to display email addresses when they are pressed using the mouse.
Message-ID Font - If non-null, this font is used to display message-IDs.
Message-ID Color - If selected, this color is used to display message-IDs.
Message-ID Style - The text style for displayed message-IDs.
Message-ID Selected Col - This color is used to display message-IDs when they are pressed using the mouse.

Example

Here is an example of a clickable email address.

When pressed, the text will change to the selected color and the associated multimedia action will be executed. Email addresses in the article body are also clickable.

Variables

The following variables, in addition to the standard group, article, and project variables, are available to multimedia actions using this filter:

Variable Name

Description

File

When used in a multimedia action for a clickable email address, this variable will be set to a filename which contains the article text. By default this is the full header and body of the article, but the following suffixies can be used:

:Head - The file will contain only the header information.
:Body - The file will contain only the body, but no headers.
:HdBd - The file will contain both the header and the body of the article. This is the default.
:Q - The body of the article will be quoted.

For example, referencing the variable ${File:Body:Q} would specify a file containing the quoted body of the article, with no header. This is useful for passing the indicated text to an external program.

Used in a multimedia action for the type application/X-email, the email variable contains the email address that was clicked on.

MsgID

Used in a multimedia action for the type application/X-MsgID, the MsgID variable contains the message-ID string that was clicked on.