Initial groundwork to use phpdocumentor.
[squirrelmail.git] / plugins / spamcop / options.php
1 <?php
2
3 /**
4 ** options.php -- SpamCop options page
5 **
6 ** Copyright (c) 1999-2003 The SquirrelMail development team
7 ** Licensed under the GNU GPL. For full terms see the file COPYING.
8 **
9 ** $Id$
10 * @package plugins
11 * @subpackage spamcop
12 **/
13
14 /** @ignore */
15 define('SM_PATH','../../');
16 require_once(SM_PATH . 'include/validate.php');
17
18 function spamcop_enable_disable($option,$disable_action,$enable_action) {
19 if ($option) {
20 $ret= _("Enabled") . "(<a href=\"options.php?action=$disable_action\">" . _("Disable it") . "</a>)\n";
21 } else {
22 $ret = _("Disabled") . "(<a href=\"options.php?action=$enable_action\">" . _("Enable it") . "</a>)\n";
23 }
24 return $ret;
25 }
26
27 displayPageHeader($color, 'None');
28
29 /* globals */
30 sqgetGlobalVar('action', $action);
31 sqgetGlobalVar('meth', $meth);
32 sqgetGlobalVar('ID' , $ID);
33
34 sqgetGlobalVar('username', $username, SQ_SESSION);
35 /* end of globals */
36
37 $action = (!isset($action) ? '' : $action);
38
39 switch ($action) {
40 case 'enable':
41 setPref($data_dir, $username, 'spamcop_enabled', 1);
42 break;
43 case 'disable':
44 setPref($data_dir, $username, 'spamcop_enabled', '');
45 break;
46 case 'save':
47 setPref($data_dir, $username, 'spamcop_delete', '');
48 break;
49 case 'delete':
50 setPref($data_dir, $username, 'spamcop_delete', 1);
51 break;
52 case 'meth':
53 if (isset($meth)) {
54 setPref($data_dir, $username, 'spamcop_method', $meth);
55 }
56 break;
57 case 'save_id':
58 if (isset($ID)) {
59 $ID = trim($ID);
60 $ID = preg_replace('/@.*/','',$ID);
61 $ID = preg_replace('/.*\./','',$ID);
62 setPref($data_dir, $username, 'spamcop_id', $ID);
63 }
64 break;
65 }
66
67 global $spamcop_enabled, $spamcop_delete;
68 spamcop_load();
69
70 ?>
71 <br />
72 <table width="95%" align="center" border="0" cellpadding="2" cellspacing="0">
73 <tr><td bgcolor="<?php echo $color[0]; ?>">
74 <center><b><?php echo _("Options") . " - " . _("Spam reporting"); ?></b></center>
75 </td></tr></table>
76 <br />
77
78 <table align="center">
79 <tr>
80 <?php
81 echo html_tag('td',_("SpamCop link is:"),'right');
82 echo html_tag('td', spamcop_enable_disable($spamcop_enabled,'disable','enable') );
83 ?>
84 </tr>
85 <tr>
86 <?php
87 echo html_tag('td',_("Delete spam when reported:") . "<br />\n" .
88 '<font size="-2">(' . _("Only works with email-based reporting") . ')</font>',
89 'right','','valign="top"');
90 echo html_tag('td', spamcop_enable_disable($spamcop_delete,'save','delete'),'','','valign="top"');
91 ?>
92 </tr>
93 <tr>
94 <?php
95 echo html_tag('td',_("Spam Reporting Method:"),'right');
96 ?>
97 <form method="post" action="options.php">
98 <td>
99 <select name="meth">
100 <option value="quick_email"
101 <?php
102 if ($spamcop_method == 'quick_email') echo ' selected';
103 echo ">"._("Quick email-based reporting");
104 ?>
105 </option>
106 <option value="thorough_email"
107 <?php
108 if ($spamcop_method == 'thorough_email') echo ' selected';
109 echo ">"._("Thorough email-based reporting");
110 ?>
111 </option>
112 <option value="web_form"
113 <?php
114 if ($spamcop_method == 'web_form') echo ' selected';
115 echo ">"._("Web-based form");
116 ?>
117 </option>
118 </select>
119 <input type="hidden" name="action" value="meth">
120 <input type="submit" value="<?php echo _("Save Method"); ?>">
121 </td></form>
122 </tr>
123 <tr>
124 <?php
125 echo html_tag('td',_("Your SpamCop authorization code:") . "<br />" .
126 '<font size="-2">(' . _("see below") . ')</font>','right','','valign="top"');
127 ?>
128 <form method="post" action="options.php"><td valign="top">
129 <input type="text" size="30" name="ID" value="<?php echo htmlspecialchars($spamcop_id) ?>" />
130 <input type="hidden" name="action" value="save_id" />
131 <input type="submit" value="<?php echo _("Save ID"); ?>" />
132 </td></form>
133 </tr>
134 </table>
135 <?php
136 echo "<p>";
137 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.");
138 echo "</p>\n";
139
140 echo "<p>";
141 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.");
142 echo "</p>\n";
143
144 echo "<p>";
145 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.");
146 echo "</p>\n";
147
148 echo "<p>";
149 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.");
150 echo "</p>\n";
151
152 echo "<p><b>" . _("Email-based Reporting") . "</b><br />";
153 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.");
154 echo "</p>";
155
156 echo "<p>";
157 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.");
158 echo "</p>\n";
159
160 echo "<p><b>" . _("Web-based Reporting") . "</b><br />";
161 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.");
162 echo "</p>\n";
163
164 echo "<p>";
165 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.");
166 echo "</p>\n";
167
168 echo "<p>";
169 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.");
170 echo "</p>\n";
171 ?>
172 </body></html>