Net::Sieve::Script::Action(3pm) User Contributed Perl Documentation Net::Sieve::Script::Action(3pm)NAME
Net::Sieve::Script::Action - parse and write actions in sieve scripts
SYNOPSIS
use Net::Sieve::Script::Action;
$action = Net::Sieve::Script::Action->new('redirect "bart@example.edu"');
or
$action = Net::Sieve::Script::Action->new();
$action->command('redirect');
$action->param('"bart@example.edu"');
DESCRIPTION
Action object for Net::Sieve::Script, with command and optional param.
Support RFC 5228, RFC 5230 (vacation), regex draft
METHODS
CONSTRUCTOR new
Argument : "command param" string,
parse valid commands from RFCs, param are not validate.
command
read command : "$action->command()"
set command : "$action->command('stop')"
param
read param : "$action->param()"
set param : "$action->param(' :days 3 "I am away this week."')"
equals
return 1 if actions are equals
AUTHOR
Yves Agostini - Univ Metz - <agostini@univ-metz.fr>
<http://www.crium.univ-metz.fr>
COPYRIGHT
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.
perl v5.10.0 2008-09-15 Net::Sieve::Script::Action(3pm)
Check Out this Related Man Page
Net::Sieve::Script::Rule(3pm) User Contributed Perl Documentation Net::Sieve::Script::Rule(3pm)NAME
Net::Sieve::Script::Rule - parse and write rules in sieve scripts
SYNOPSIS
use Net::Sieve::Script::Rule;
my $pRule = Net::Sieve::Script::Rule->new (
ctrl => $ctrl,
test_list => $test_list,
block => $block,
order => $order
);
or
my $rule = Net::Sieve::Script::Rule->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;';
$rule->add_condition($cond);
$rule->add_action($actions);
print $rule->write;
DESCRIPTION CONSTRUCTOR
new
Arguments :
order => : optionnal set priority for rule
ctrl => : optionnal default 'if', else could be 'else', 'elsif'
or 'vacation'
test_list => : optionnal conditions by string or by Condition Object
block => : optionnal block of commands
Returns : Net::Sieve::Script::Rule object
Set accessors
alternate : as param ctrl
conditions : first condition in tree
actions : array of actions objects
priority : rule order in script, main id for rule
require :
METHODS
equals
return 1 if rules are equals
write
Return rule in text format
write_condition
set require for used conditions
return conditions in text format
write_action
set require for used actions
return actions in text format
delete_condition
Purpose : delete condition by rule, delete all block on delete anyof/allof
delete single anyof/allof block : single condition move up
Arguments : condition id
Returns : 1 on success, 0 on error
add_condition
Purpose : add condition to rule, add 'allof' group on second rule
Arguments : string or Condition object
Returns : new condition id or 0 on error
swap_actions
swap actions by order
return 1 on succes, 0 on failure
find_action
find action by order
Returns: Net::Sieve::Script::Action object, 0 on error
delete_action
delete action by order, first is 1;
add_action
Purpose : add action at end of block
Arguments : command line
or command line list with ; separator
or Net::Sieve::Script::Action object
Return : 1 on success
AUTHOR
Yves Agostini
CPAN ID: YVESAGO
Univ Metz
agostini@univ-metz.fr
http://www.crium.univ-metz.fr
COPYRIGHT
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.
perl v5.10.0 2008-09-15 Net::Sieve::Script::Rule(3pm)