NAME¶

Net::Sieve::Script - Parse and write sieve scripts

SYNOPSIS¶

  use Net::Sieve::Script;
  my $test_script = 'require "fileinto";
     # Place all these in the "Test" folder
     if header :contains "Subject" "[Test]" {
               fileinto "Test";
     }';
  my $script = Net::Sieve::Script->new ($test_script);
     print "OK" if ( $script->parsing_ok ) ;
     print $script->write_script;

or

    my $script = Net::Sieve::Script->new();
    my $cond = Net::Sieve::Script::Condition->new('header');
       $cond->match_type(':contains');
       $cond->header_list('"Subject"');
       $cond->key_list('"Re: Test2"');
    my $actions = 'fileinto "INBOX.test"; stop;';
    my $rule =  Net::Sieve::Script::Rule->new();
       $rule->add_condition($cond);
       $rule->add_action($actions);
       $script->add_rule($rule);
       print $script->write_script;

DESCRIPTION¶

Manage sieve script

Read and parse file script, make Net::Sieve::Script::Rule, Net::Sieve::Script::Action, Net::Sieve::Script::Condition objects

Write sieve script

Support RFC 5228 - sieve base
RFC 5231 - relationnal
RFC 5230 - vacation
Draft regex

missing
5229 variables
5232 imapflags
5233 subaddress
5235 spamtest
notify draft

CONSTRUCTOR¶

    Argument : optional text script
    Purpose  : if param, put script in raw, parse script
    Return   : main Script object

    ->raw()          : read or set original text script
    ->require()      : require part of script
    ->rules()        : array of rules
    ->max_priority() : last rule id

METHODS¶

 $object->equals($test_object): return 1 if $object and $test_object are equals

 $script->read_rules()  : read rules from raw 
 $script->read_rules($some_text) : parse text rules
 use of read_rules set $script->rules()

 if deleted is 'if'
  delete next if next is 'else'
  change next in 'if' next is 'elsif'

BUGS¶

Rewrite a hand made script will lose comments. Verify parsing success with parsing_ok method before write a new script.

SUPPORT¶

Please report any bugs or feature requests to "bug-net-sieve-script at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Sieve-Script>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

AUTHOR¶

Yves Agostini - <yvesago@cpan.org>

COPYRIGHT¶

Copyright 2017 Yves Agostini - <yvesago@cpan.org>

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

SEE ALSO¶

Net::Sieve