Description

This function checks whether a pipe or a shebang should precede a script that receives forwarded mail.

  • If the script requires a shebang, the function sets a value for the pipefwd_needs_hashbang cPvariable.
  • If the script requires a pipe, the function sets a value for the pipefwd_needs_fixup cPvariable.
  • For more information, read our How to Configure Mail Filters documentation. 

Examples 


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$check_pipes = $cpanel->api1('Email', 'checkpipefwd', array('script.pl') ); // Call the function.

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $check_pipes = $cpliveapi->api1('Email', 'checkpipefwd', ['script.pl'] ); # Call the function.

 

<cpanel Module="Email::checkpipefwd( $FORM('pipe_name') )">
cpapi1 --user=username Email checkpipefwd script.pl

This function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
pipe_namestring

Required

The piped script.

The path to a piped script or other application.

script.pl

Returns

This function does not return output.