phpdoc blocks
[squirrelmail.git] / plugins / spamcop / options.php
1 <?php
2
3 /**
4 * options.php -- SpamCop options page
5 *
6 * @copyright (c) 1999-2004 The SquirrelMail development team
7 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
8 * @version $Id$
9 * @package plugins
10 * @subpackage spamcop
11 */
12
13 /** @ignore */
14 define('SM_PATH','../../');
15 require_once(SM_PATH . 'include/validate.php');
16
17 /**
18 * Internal spamcop plugin function.
19 *
20 * It is used to display similar action links.
21 * @access private
22 */
23 function spamcop_enable_disable($option,$disable_action,$enable_action) {
24 if ($option) {
25 $ret= _("Enabled") . "(<a href=\"options.php?action=$disable_action\">" . _("Disable it") . "</a>)\n";
26 } else {
27 $ret = _("Disabled") . "(<a href=\"options.php?action=$enable_action\">" . _("Enable it") . "</a>)\n";
28 }
29 return $ret;
30 }
31
32 displayPageHeader($color, 'None');
33
34 /* globals */
35 sqgetGlobalVar('action', $action);
36 sqgetGlobalVar('meth', $meth);
37 sqgetGlobalVar('type', $type);
38 sqgetGlobalVar('ID' , $ID);
39
40 sqgetGlobalVar('username', $username, SQ_SESSION);
41 /* end of globals */
42
43 $action = (!isset($action) ? '' : $action);
44
45 switch ($action) {
46 case 'enable':
47 setPref($data_dir, $username, 'spamcop_enabled', 1);
48 break;
49 case 'disable':
50 setPref($data_dir, $username, 'spamcop_enabled', '');
51 break;
52 case 'save':
53 setPref($data_dir, $username, 'spamcop_delete', '');
54 break;
55 case 'delete':
56 setPref($data_dir, $username, 'spamcop_delete', 1);
57 break;
58 case 'meth':
59 if (isset($meth)) {
60 setPref($data_dir, $username, 'spamcop_method', $meth);
61 }
62 break;
63 case 'type':
64 if (isset($type)) {
65 setPref($data_dir, $username, 'spamcop_type', $type);
66 }
67 break;
68 case 'save_id':
69 if (isset($ID)) {
70 $ID = trim($ID);
71 $ID = preg_replace('/@.*/','',$ID);
72 $ID = preg_replace('/.*\./','',$ID);
73 setPref($data_dir, $username, 'spamcop_id', $ID);
74 }
75 break;
76 }
77
78 global $spamcop_enabled, $spamcop_delete, $spamcop_quick_report;
79 spamcop_load();
80
81 ?>
82 <br />
83 <table width="95%" align="center" border="0" cellpadding="2" cellspacing="0">
84 <tr><td bgcolor="<?php echo $color[0]; ?>">
85 <center><b>
86 <?php echo _("Options") . " - " . _("Spam reporting"); ?>
87 </b></center>
88 </td></tr></table>
89 <br />
90
91 <table align="center">
92 <tr>
93 <?php
94 echo html_tag('td',_("SpamCop link is:"),'right');
95 echo html_tag('td', spamcop_enable_disable($spamcop_enabled,'disable','enable') );
96 ?>
97 </tr>
98 <tr>
99 <?php
100 echo html_tag('td',_("Delete spam when reported:") . "<br />\n" .
101 '<small>(' . _("Only works with email-based reporting") . ')</small>',
102 'right','','valign="top"');
103 echo html_tag('td', spamcop_enable_disable($spamcop_delete,'save','delete'),'','','valign="top"');
104 ?>
105 </tr>
106 <tr>
107 <?php
108 echo html_tag('td',_("Spam Reporting Method:"),'right');
109 ?>
110 <form method="post" action="options.php">
111 <td>
112 <select name="meth">
113 <?php
114 if ($spamcop_quick_report) {
115 echo '<option value="quick_email"';
116 if ($spamcop_method == 'quick_email') echo ' selected';
117 echo ">"._("Quick email-based reporting");
118 echo '</option>';
119 }
120 ?>
121 <option value="thorough_email"
122 <?php
123 if ($spamcop_method == 'thorough_email') echo ' selected';
124 echo ">"._("Thorough email-based reporting");
125 ?>
126 </option>
127 <option value="web_form"
128 <?php
129 if ($spamcop_method == 'web_form') echo ' selected';
130 echo ">"._("Web-based form");
131 ?>
132 </option>
133 </select>
134 <input type="hidden" name="action" value="meth" />
135 <?php
136 echo '<input type="submit" value="' . _("Save Method") . "\" />\n";
137 ?>
138 </td></form>
139 </tr>
140 <tr>
141 <?php
142 echo html_tag('td',_("Spam Service Type:"),'right');
143 ?>
144 <form method="post" action="options.php">
145 <td>
146 <select name="type">
147 <option value="free"
148 <?php
149 if ($spamcop_type == 'free') echo ' selected';
150 echo ">"._("Free reporting");
151 ?>
152 </option>
153 <option value="member"
154 <?php
155 if ($spamcop_type == 'member') echo ' selected';
156 echo ">"._("Member services");
157 ?>
158 </option>
159 </select>
160 <?php
161 echo '<input type="hidden" name="action" value="type" />' .
162 '<input type="submit" value="' . _("Save Service Type") . "\" />\n";
163 ?>
164 </td></form>
165 </tr>
166 <tr>
167 <?php
168 echo html_tag('td',_("Your SpamCop authorization code:") . "<br />" .
169 '<small>(' . _("see below") . ')</small>','right','','valign="top"');
170 ?>
171 <form method="post" action="options.php"><td valign="top">
172 <input type="text" size="30" name="ID" value="<?php echo htmlspecialchars($spamcop_id) ?>" />
173 <input type="hidden" name="action" value="save_id" />
174 <?php
175 echo '<input type="submit" value="' . _("Save ID") . "\" />\n";
176 ?>
177 </td></form>
178 </tr>
179 </table>
180 <?php
181 echo "<p>";
182 echo _("SpamCop is a free service that greatly assists in finding the true source of the spam and helps in letting the proper people know about the abuse.");
183 echo "</p>\n";
184
185 echo "<p>";
186 echo _("To use it, you must get a SpamCop authorization code. There is a free <a href=\"http://spamcop.net/anonsignup.shtml\">sign up page</a> so you can use SpamCop.");
187 echo "</p>\n";
188
189 echo "<p>";
190 echo _("<b>Before you sign up, be warned:</b> Some users have reported that the email addresses used with SpamCop find their way onto spam lists. To be safe, you can just create an email forwarding account and have all SpamCop reports get sent to there. Also, if it gets flooded with spam, you can then just delete that account with no worries about losing your real email address. Just go create an email forwarder somewhere (<a href=\"http://www.yahoo.com/\">Yahoo!</a> has a <a href=\"http://dir.yahoo.com/Business_and_Economy/Business_to_Business/Communications_and_Networking/Internet_and_World_Wide_Web/Email_Providers/Forwarding_Services/Free_Forwarding/\">list of places</a>) so that messages from system administrators and whatnot can be sent to you.");
191 echo "</p>\n";
192
193 echo "<p>";
194 echo _("Once you have signed up with SpamCop and have received your SpamCop authorization code, you need to enable this plugin -- just click the link above. Once enabled, you go about your normal life. If you encounter a spam message in your mailbox, just view it. On the right-hand side, near the top of where the message is displayed, you will see a link to report this message as spam. Clicking on it brings you to a confirmation page. Confirming that you want the spam report sent will do different things with different reporting methods.");
195 echo "</p>\n";
196
197 echo "<p><b>" . _("Email-based Reporting") . "</b><br />";
198 echo _("Pressing the button forwards the message to the SpamCop service and will optionally delete the message. From there, you just need to go to your INBOX and quite soon a message should appear from SpamCop. (It gets sent to the account you registered with, so make sure that your mail forwarder works!) Open it up, click on the appropriate link at the top, and a new browser window will open.");
199 echo "</p>";
200
201 if ($spamcop_quick_report) {
202 echo "<p>";
203 echo _("Currently, the quick reporting just forwards the request to the thorough reporting. Also, it appears that this is for members (non-free) only. Hopefully this will change soon.");
204 echo "</p>\n";
205 }
206
207 echo "<p><b>" . _("Web-based Reporting") . "</b><br />";
208 echo _("When you press the button on the confirmation page, this will pop open a new browser window and the SpamCop service should appear inside. The message will not be deleted (working on that part), but you won't need to wait for a response email to start the spam reporting.");
209 echo "</p>\n";
210
211 echo "<p>";
212 echo _("The SpamCop service will display information as it finds it, so scroll down until you see a form button. It might pause a little while it is looking up information, so be a little patient. Read what it says, and submit the spam. Close the browser window. Press Cancel or click on the appropriate mail folder to see messages and/or delete the spam.");
213 echo "</p>\n";
214
215 echo "<p><b>". _("Spamcop Service Type") . "</b><br />\n";
216 echo _("Service type option allows selecting which spamcop services you are using. Member services use different web reporting forms and does not display nags. You can purchase these services, if you want to support SpamCop.");
217 echo "</p>\n";
218
219 echo "<p>";
220 echo _("<b>For more information</b> about SpamCop, it's services, spam in general, and many related topics, try reading through SpamCop's <a href=\"http://spamcop.net/help.shtml\">Help and Feedback</a> section.");
221 echo "</p>\n";
222 ?>
223 </body></html>