Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Sympa::CommandDef(3Sympa)	 sympa 6.2.16	     Sympa::CommandDef(3Sympa)

NAME
       Sympa::CommandDef - Definition of mail commands

SYNOPSIS
       TBD

DESCRIPTION
       This module keeps definition of mail commands.

   Global variable
       %comms
	   This	hash defines format of mail commands.  It is used for decoding
	   and encoding	between	command	lines and internal request objects.

	   Key is the name of action which is given as "action"	parameter to
	   constructor of Sympa::Request.  Note	that not all sort of requests
	   are defined.

	   Value is the	hashref.  Each item of hashrefs	accepts	the following
	   keywords :

	   cmd_regexp
	       A regexp	matching command.  Note	that "i" modifier is
	       necessary.

	   arg_regexp
	       A regexp	matching command line arguments.  Note that "i"
	       modifier	may be needed.

	   arg_keys
	       An arrayref of parameter	names mapping command line to
	       attribute.  'localpart' is special: If it is contained,
	       "context" attribute of resulting	request	object is an instance
	       of Sympa::List class.

	   cmd_format
	       A string	to format command line using attributes.  If this item
	       is code reference, it will be called with request object	and
	       returned	value will be used as format string.

	   filter
	       A coderef to perform additional checking.  It is	called with
	       request object and, if it returns false value, decoding will
	       fail.

SEE ALSO
       Sympa::Request, Sympa::Request::Message.

HISTORY
       Sympa::CommandDef appeared on Sympa 6.2.13.

6.2.16				  2016-06-03	     Sympa::CommandDef(3Sympa)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | HISTORY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Sympa::CommandDef&sektion=3sympa&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help