%NOTIFYAUTHORS%
variable is handled by the NotifyAuthorsPlugin.
%NOTIFYAUTHORS{ ... }%
Parameter | Description | Default |
---|---|---|
action="" oraction="showbutton" | Show "notify authors" button | "" |
action="notify" | Notify all authors by e-mail. The same can be achieved with URL parameter notifyauthors_action=notify . | "" |
action="getemailtemplate" | Get e-mail body from template, used in notification confirmation dialog box. Add encode="1" to entity-encode the content for an HTML textarea element. | "" |
anchor="..." | After notification, jump to named anchor (omit the # ) | "NotifyAuthorsButton" φ |
{Plugins}{NotifyAuthorsPlugin}{AnchorName}
configure setting.
%NOTIFYAUTHORS%
%SENDMAIL{}%
variable is handled by the SendMailPlugin.
%SENDMAIL{ action="send" ... }%
Parameter | Description | Default |
---|---|---|
action="" | Only action="send" is supported, it will send an e-mail | "" (no action) |
excludetopic="MyTemplate" | Exclude action for named topic. Typically used in a template topic containing the SENDMAL variable to disable the action when viewing the topic. | "" (no exclude) |
from="admin@example.com" | E-mail address or WikiName of sender. If a WikiName is specified, the registered e-mail of that person is used. Supported tokens: • $webmastername - name of TWiki administrator. • $webmasteremail - e-mail of TWiki administrator. • $username - WikiName of logged in user. • $useremail - e-mail address of the logged in user. Defaults to TWiki administrator. See note on open mail relay. | "$webmastername <$webmasteremail>" |
to="jom@example.com" | To list: Comma-space delimited list of e-mail addresses or WikiNames of adressees. Same tokens supported as in from="" . Defaults to TWiki administrator. | "$webmastername <$webmasteremail>" |
cc="jimmy@example.com" | CC list: Comma-space delimited list of e-mails or WikiNames. Same tokens supported as in from="" . | "" |
bcc="boss@example.com" | BCC list: Comma-space delimited list of e-mails or WikiNames. Same tokens supported as in from="" . | "" |
subject="Any text" | E-mail subject. Text may include TWikiVariables such as %URLPARAM{subject}% , and format tokens such as $n and $percnt . | (help message) |
text="Any text" orplaintext="Any text" | E-mail body in plain text format. Text may include TWikiVariables and format tokens. | (help message) |
htmltext="Any HTML" | E-mail body in HTML format, optional. Text may include TWikiVariables and format tokens. Double quotes need to be escaped, such as <a href=\"http://twiki.org/\">TWiki.org<a> . A MIME Multi-Part message is sent if both, plaintext and htmltext are specified. | "" |
onsuccess="..." | Text shown in place of the SENDMAIL variable on success, default is empty. Text may include TWikiVariables and format tokens. | "" |
onerror="| $error ||" | Error message shown in place of the SENDMAIL variable on error, if any. Text may include TWikiVariables and format tokens. Token $error expands to the error message. | "$error" |
%SENDMAIL{ action="send" to="$username <$useremail>" subject="Status change" text="Status changed to %FORMFIELD{Status}%" }%
%SUBSCRIBE{...}%
variable is handled by the SubscribePlugin
%SUBSCRIBE{...}%
or simply %SUBSCRIBE%
Parameter | Default | Meaning |
---|---|---|
who | Logged-in user | Who to subscribe (wikiname, no web) |
topic | Current topic | Topic to subscribe to. Wildcards may be used e.g. topic="Item*" will subscribe to all topics starting with Item . Use topic="Main.*" to subscribe to the WebNotify for that web. |
unsubscribe | Not set | If set to "on", will unsubscribe the user |
format | Simple HTML Link with an action anchor "Subscribe" or "Unsubscribe" | Defines custom look-and-feel for subscribe link using the following format variables: $topics , $url , $wikiname , $action |
formatunsubscribe | format | Serves same function as format , but allows the user to define a different format than subscribe . |