.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Net::Sieve::Script 3pm" .TH Net::Sieve::Script 3pm "2017-09-30" "perl v5.26.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::Sieve::Script \- Parse and write sieve scripts .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Net::Sieve::Script; \& \& my $test_script = \*(Aqrequire "fileinto"; \& # Place all these in the "Test" folder \& if header :contains "Subject" "[Test]" { \& fileinto "Test"; \& }\*(Aq; \& \& my $script = Net::Sieve::Script\->new ($test_script); \& \& print "OK" if ( $script\->parsing_ok ) ; \& \& print $script\->write_script; .Ve .PP or .PP .Vb 1 \& my $script = Net::Sieve::Script\->new(); \& \& my $cond = Net::Sieve::Script::Condition\->new(\*(Aqheader\*(Aq); \& $cond\->match_type(\*(Aq:contains\*(Aq); \& $cond\->header_list(\*(Aq"Subject"\*(Aq); \& $cond\->key_list(\*(Aq"Re: Test2"\*(Aq); \& \& my $actions = \*(Aqfileinto "INBOX.test"; stop;\*(Aq; \& \& my $rule = Net::Sieve::Script::Rule\->new(); \& $rule\->add_condition($cond); \& $rule\->add_action($actions); \& \& $script\->add_rule($rule); \& \& print $script\->write_script; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Manage sieve script .PP Read and parse file script, make Net::Sieve::Script::Rule, Net::Sieve::Script::Action, Net::Sieve::Script::Condition objects .PP Write sieve script .PP Support \s-1RFC 5228\s0 \- sieve base \s-1RFC 5231\s0 \- relationnal \s-1RFC 5230\s0 \- vacation Draft regex .PP missing 5229 variables 5232 imapflags 5233 subaddress 5235 spamtest notify draft .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" .Vb 3 \& Argument : optional text script \& Purpose : if param, put script in raw, parse script \& Return : main Script object .Ve .PP Accessors : .PP .Vb 4 \& \->raw() : read or set original text script \& \->require() : require part of script \& \->rules() : array of rules \& \->max_priority() : last rule id .Ve .SH "METHODS" .IX Header "METHODS" .SS "parsing_ok" .IX Subsection "parsing_ok" return 1 on raw parsing success .SS "write_script" .IX Subsection "write_script" Purpose : write full script, require and rules parts .PP Return : set current require, return rules ordered by priority in text format .SS "equals" .IX Subsection "equals" .Vb 1 \& $object\->equals($test_object): return 1 if $object and $test_object are equals .Ve .SS "read_rules" .IX Subsection "read_rules" .Vb 3 \& $script\->read_rules() : read rules from raw \& $script\->read_rules($some_text) : parse text rules \& use of read_rules set $script\->rules() .Ve .PP Return 1 on success .SS "find_rule" .IX Subsection "find_rule" Return Net::Sieve::Script::Rule pointer find by priority .PP Return 0 on error, 1 on not find .SS "swap_rules" .IX Subsection "swap_rules" Swap priorities, now don't take care of if/else/elsif .PP Return 1 on success, 0 on error .SS "reorder_rules" .IX Subsection "reorder_rules" Reorder rules with a list of number, start with 1, and with blanck separator. Useful for ajax sort functions. .PP Thank you jeanne for your help in brain storming. .PP Return 1 on success, 0 on error .SS "delete_rule" .IX Subsection "delete_rule" Delete rule and change priority, delete rule take care for 'if' test .PP .Vb 3 \& if deleted is \*(Aqif\*(Aq \& delete next if next is \*(Aqelse\*(Aq \& change next in \*(Aqif\*(Aq next is \*(Aqelsif\*(Aq .Ve .PP Return : 1 on success, 0 on error .SS "add_rule" .IX Subsection "add_rule" Purpose : add a rule in end of script .PP Return : priority on success, 0 on error .PP Argument : Net::Sieve::Script::Rule object .SH "BUGS" .IX Header "BUGS" Rewrite a hand made script will lose comments. Verify parsing success with parsing_ok method before write a new script. .SH "SUPPORT" .IX Header "SUPPORT" Please report any bugs or feature requests to \*(L"bug-net-sieve-script at rt.cpan.org\*(R", or through the web interface at . I will be notified, and then you'll automatically be notified of progress on your bug as I make changes. .SH "AUTHOR" .IX Header "AUTHOR" Yves Agostini \- .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2017 Yves Agostini \- .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP The full text of the license can be found in the \&\s-1LICENSE\s0 file included with this module. .SH "SEE ALSO" .IX Header "SEE ALSO" Net::Sieve