view release on metacpan or  search on metacpan

bin/spamcup  view on Meta::CPAN

=item Uses modern Perl coding practices

App-SpamcupNG uses more modern practices for Perl development, which might (or not!) make it more robust. Also, this distribution is being activaly
developed.

=item WWW::Mechanize is not required

L<WWW::Mechanize> (the base of L<WWW::Mechanize::SpamCop>) is pretty neaty, easier to use than L<LWP::UserAgent>, but on the other hand has
more dependencies and wouldn't add any value compared to the already in place webcrawler implementation. If the Spamcop.net website changes, I
might consider moving to it, but not before that.

=back

=head1 WARNINGS

Some important warnings before starting using it:

=over

=item *

The script does NOT know where the SPAM report will be sent so IT'S YOUR RESPONSIBILITY!

=item *

If the script asks Spamcop to send reports to wrong places IT'S YOUR FAULT!

=item *

If the script has a bug that causes same report being sent thousand times IT'S YOUR MAIL ADDRESSES!

=item *

DO NOT USE THIS SCRIPT IF YOU DON'T UNDERSTAND WHAT IT DOES! IT'S YOUR SHAME!

=back

=head1 CONFIGURATION FILE

You can also provide a configuration file to avoid having to provide the same information every time you want to execute the program.

Another advantage of using the configuration file is that you can setup multiple Spamcop.net in the same file and the C<spamcup> program will
loop over them and report the associated SPAM automatically.

The program will look for a configuration file named C<.spamcup.yml> in the corresponding home directory of the user (that will dependend
on the OS you're executing it).

The configuration file must be written as an YAML file, with the exact properties below:

    ---
    ExecutionOptions:
    all: y
    stupid: y
    nothing: n
    alt_code: n
    verbosity: INFO
    alt_user: n
    database:
      enabled: true
      path: /var/spamcupng/reports.db
    Accounts:
      Provider1:
        e-mail: account@provider1.com.br
        password: FOOBAR
      Provider2:
        e-mail: account@provider2.com.br
        password: FOOBAR

You can use any name instead of "Provider1" or "Provider2" as long as their are valid key names for YAML format.

All those options have their corresponding command line parameter. Be sure to take care of file permissions to avoid disclosure of your Spamcop.net password!

=head2 VERBOSITY

C<spamcup> uses L<Log::Log4perl>, so you can use the default values for logging.

If you use C<INFO>, only basic information is printed to C<STDOUT>. This should be your default level.

If you define C<DEBUG>, all messages (including HTML from Spamcop.net website) will go to the C<spamcup.log> file, located at your home directory.
Nothing will be printed to C<STDOUT> or C<STDERR>.

All other levels will show more or less messages to C<STDOUT>, depending on the severity of the messages.

=head1 SEE ALSO

=over

=item *

L<App::SpamcupNG>

=back

=head1 AUTHOR

Alceu Rodrigues de Freitas Junior, E<lt>glasswalk3r@yahoo.com.brE<gt>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2015 of Alceu Rodrigues de Freitas Junior, E<lt>glasswalk3r@yahoo.com.brE<gt>

This file is part of App-SpamcupNG distribution.

App-SpamcupNG is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

App-SpamcupNG is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with spamcupNG. If not, see <http://www.gnu.org/licenses/>.

=cut

# vim: filetype=perl