File: userprocs

package info (click to toggle)
postilion 0.9.2-3
  • links: PTS
  • area: main
  • in suites: potato
  • size: 12,200 kB
  • ctags: 6,009
  • sloc: ansic: 66,879; tcl: 12,863; makefile: 1,054; sh: 242
file content (58 lines) | stat: -rw-r--r-- 2,424 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

			User defined procedures


   TkRat software and its included text is Copyright 1996,1997,1998
   by Martin Forssn.

   The full text of the legal notices is contained in the file called
   COPYRIGHT, included with this distribution.

User defined procedures is a way for the user to have more control over
certain features. The procedures are ordinary tcl procedures (i.e. they are
written in tcl7.5). None of the procedures must exist, they will be used
only if they exists.

The user may define procedures in the ~/.ratatosk/userproc file (or
whatever the userproc option is set to). If the procedures need any global
varaibles these must start with "ratUP_". The following procedures may
be defined:

RatUP_IsMe mailbox domain personal adl
	mailbox  -	Mailbox name
	domain   -	The domain part
	personal -	The personal name phrase (if any)
	adl      -	At-domain-list source route
    This procedure should determine if the address is pointing to me or not.
    It should return a boolean value, which should be true if the address
    is pointing at me.

RatUP_Translate mailbox domain personal adl
	mailbox  -	Mailbox name
	domain   -	The domain part
	personal -	The personal name phrase (if any)
	adl      -	At-domain-list source route (probably empty)
    When we are replying to a message all addresses we are sending it to
    are run through this procedure. It is expected to return a list with
    four elements {mailbox domain personal adl}.

RatUP_Signature message
	message -	The handler for the message the signature will be
			appended to
    This function should return a text string which will later be
    appended to the first text part of the message. The message argument is
    an handler which can be used to get information about the message (see
    the interface file for more information). Note that this routine gets
    called before the user has had any chance to edit the message so there
    will not be any interesting information available at all for new messages.
    It only contains interesting things for replies and forwards.

RatUP_Bell
    This function should notify the user that new mail has arrived. If
    this function does not exist then the terminal bell is rung.

RatUP_ShowURL url
	url -	An URL to show
    This function may get called when the user presses the left mousebutton
    over an URL in a message. It is expected to invoke a browser (in the
    background).