Subversion Repositories Applications.papyrus

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
831 florian 1
Customizing your Phorum mail messages
2
=====================================
3
 
4
This document describes the way you can customize the mail messages
5
that are sent out by Phorum.
6
 
7
Table of contents:
8
 
9
1. General information
10
2. User-notifications about new messages in followed threads
11
3. Moderator-notifications about new messages
12
4. User-notifications about new private messages
13
 
14
 
15
1. General information
16
-------------------------------------------------------------------------------
17
 
18
   All messages and subjects for the mail messages are defined as language
19
   strings in the language-files. So to customize mail messages, you can
20
   change the definition of these strings.
21
 
22
   For some mail messages, you can use a couple of special tags in the
23
   message and mailsubject, which are automatically replaced by relevant
24
   data.
25
 
26
   Below you'll find a list of the language strings that you can update for
27
   each type of mail message and the special tags that you can use in them.
28
 
29
 
30
2. User-notifications about new messages in followed threads
31
-------------------------------------------------------------------------------
32
 
33
   Related language strings:
34
 
35
   - NewReplySubject
36
   - NewReplyMessage
37
 
38
   Replacement tags:
39
 
40
   - %forumname%     The name of the current forum.
41
   - %author%        The name of the author of the message.
42
   - %subject%       The subject of the message.
43
   - %full_body%     The full body of the message including all HTML/BBCode
44
                     tags, use with care!
45
   - %plain_body%    The body of the message which is stripped from all
46
                     HTML/BBCode tags.
47
   - %read_url%      The url where this message can be read.
48
   - %remove_url%    The url to unsubscribe from the followed thread.
49
   - %noemail_url%   The url to set the subscription to "no email", so
50
                     the thread is only followed from the user's profile.
51
   - %followed_threads_url% The url to the controlcenter-page where the
52
                     user can look at all the followed threads.
53
 
54
 
55
3. Moderator-notifications about new messages
56
-------------------------------------------------------------------------------
57
 
58
   Related language strings for messages that need to be moderated:
59
 
60
   - NewModeratedSubject
61
   - NewModeratedMessage
62
 
63
   Related language strings for messages that do not need to be moderated:
64
 
65
   - NewUnModeratedMessage
66
 
67
   Replacement tags:
68
 
69
   - %forumname%     The name of the current forum.
70
   - %author%        The name of the author of the message.
71
   - %subject%       The subject of the message.
72
   - %full_body%     The full body of the message including all HTML/BBCode
73
                     tags, use with care!
74
   - %plain_body%    The body of the message which is stripped from all
75
                     HTML/BBCode tags.
76
   - %read_url%      The url where this message can be read.
77
   - %approve_url%   The url where this message can be approve (if it's a
78
                     moderated forum and messages need approval)
79
 
80
 
81
4. User-notifications about new private messages
82
-------------------------------------------------------------------------------
83
 
84
   Related language strings:
85
 
86
   - PMNotifySubject
87
   - PMNotifyMessage
88
 
89
   Replacement tags:
90
 
91
   - %author%        The name of the author of the message.
92
   - %subject%       The subject of the message.
93
   - %full_body%     The full body of the message including all HTML/BBCode
94
                     tags, use with care!
95
   - %plain_body%    The body of the message which is stripped from all
96
                     HTML/BBCode tags.
97
   - %read_url%      The url where this message can be read.
98
 
99