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

FreeBSD Manual Pages

  
 
  

home | help
Sympa::Spindle::ProcessIncoming(3sympa)Sympa::Spindle::ProcessIncoming(3Sympa)

NAME
       Sympa::Spindle::ProcessIncoming - Workflow of processing	incoming
       messages

SYNOPSIS
	 use Sympa::Spindle::ProcessIncoming;

	 my $spindle = Sympa::Spindle::ProcessIncoming->new;
	 $spindle->spin;

DESCRIPTION
       Sympa::Spindle::ProcessIncoming defines workflow	to process incoming
       messages.

       When spin() method is invoked, it reads the messages in incoming	spool
       and rejects, quarantines	or modifies them.  Processing are done in the
       following order:

       o   Checks if message has message ID and	sender,	and if not,
	   quarantines it.  Because such messages will be source of various
	   troubles.

       o   Checks if robot which message is bound for exists, and if not,
	   rejects it.

       o   Checks spam status, DKIM signature and S/MIME signature, and
	   decrypts message if possible.  Result of these checks are stored in
	   message object and used in succeeding process.

       o   If message is bound for the list, checks if the list	exists,	and if
	   not,	rejects	it.

       o   Loop	prevention.  If	loop is	detected, ignores message.

       o   Virus checking, if enabled by configuration.	 And if	malware	is
	   detected, rejects or	discards message.

       o   Splices message to appropriate class	according to the type of
	   message: Sympa::Spindle::DoCommand for command message;
	   Sympa::Spindle::DoForward for message bound for administrator;
	   Sympa::Spindle::DoMessage for ordinal post.

       Order to	process	messages in source spool are controlled	by
       modification time of files and delivery date.  Some messages are
       skipped according to these priorities (See Sympa::Spool::Incoming):

       o   Messages with lowest	priority ("z" or "Z") are skipped.

       o   Messages with possibly higher priority are chosen.  This is done by
	   skipping messages with lower	priority than those already found.

   Public methods
       See also	"Public	methods" in Sympa::Spindle.

       new ( [ keepcopy	=> $directory ], [ lang	=> $lang ], [ log_level	=>
       $level ], [ log_smtp => 0|1 ] )
       spin ( )
	   new() may take following options:

	   keepcopy => $directory
	       spin() keeps copy of successfully processed messages in
	       $directory.

	   lang	=> $lang
	       Overwrites lang parameter in configuration.

	   log_level =>	$level
	       Overwrites log_level parameter in configuration.

	   log_smtp => 0|1
	       Overwrites log_smtp parameter in	configuration.

   Properties
       See also	"Properties" in	Sympa::Spindle.

       {distaff}
	   Instance of Sympa::Spool::Incoming class.

SEE ALSO
       Sympa::Message, Sympa::Spindle, Sympa::Spindle::DoCommand,
       Sympa::Spindle::DoForward, Sympa::Spindle::DoMessage,
       Sympa::Spool::Incoming.

HISTORY
       Sympa::Spindle::ProcessIncoming appeared	on Sympa 6.2.13.

6.2.56				  2020-Sympa::Spindle::ProcessIncoming(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::Spindle::ProcessIncoming&sektion=3sympa&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help