net::sieve::script::rule(3pm) [debian 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)

Check Out this Related Man Page

Path::Dispatcher::Rule(3pm)				User Contributed Perl Documentation			       Path::Dispatcher::Rule(3pm)

NAME

       Path::Dispatcher::Rule - predicate and codeblock

SYNOPSIS

	   my $rule = Path::Dispatcher::Rule::Regex->new(
	       regex => qr/^quit/,
	       block => sub { die "Program terminated by user.
" },
	   );

	   $rule->match("die"); # undef, because "die" !~ /^quit/

	   my $match = $rule->match("quit"); # creates a Path::Dispatcher::Match

	   $match->run; # exits the program

DESCRIPTION

       A rule has a predicate and an optional codeblock. Rules can be matched (which checks the predicate against the path) and they can be ran
       (which invokes the codeblock).

       This class is not meant to be instantiated directly, because there is no predicate matching function. Instead use one of the subclasses
       such as Path::Dispatcher::Rule::Tokens.

ATTRIBUTES

   block
       An optional block of code to be run. Please use the "run" method instead of invoking this attribute directly.

   prefix
       A boolean indicating whether this rule can match a prefix of a path. If false, then the predicate must match the entire path. One use-case
       is that you may want a catch-all rule that matches anything beginning with the token "ticket".  The unmatched, latter part of the path will
       be available in the match object.

METHODS

   match path -> match
       Takes a path and returns a Path::Dispatcher::Match object if it matched the predicate, otherwise "undef". The match object contains
       information about the match, such as the results (e.g. for regex, a list of the captured variables), the "leftover" path if "prefix"
       matching was used, etc.

   run
       Runs the rule's codeblock. If none is present, it throws an exception.

perl v5.12.4							    2011-08-30					       Path::Dispatcher::Rule(3pm)

Linux and UNIX Man Pages

net::sieve::script::rule(3pm) [debian man page]

Check Out this Related Man Page