Child pages
  • cPanel API 1 Functions - Email::checkpipefwd
Skip to end of metadata
Go to start of metadata

 

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. 

Warning:

cPanel API 1 is deprecated. Do not use this function. Instead, we strongly recommend that you use the following newer functions:

Examples 


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


Note:

For more information, read our Guide to the LiveAPI System.

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


Note:

For more information, read our Guide to the LiveAPI System.

 

 cPanel Tag System (deprecated)


Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We provide this example to help developers move from the old cPanel tag system to our LiveAPI system. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

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


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (none)

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.