cPanel API 1 Functions - Email::checkpipefwd

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 deprecatedDo 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.

 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.

 cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.

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 pipe_name=script.pl

 

Notes:

  • You must URI-encode values.
  • username represents your account-level username.

 Output (none)

This function does not return output.

Parameters

 Parameter 

 Type 

Description

Possible values

 Example 

 pipe_name

 string

 Required

 The piped script.

 The path to a piped script or other application. 

 script.pl

 

Returns

This function does not return output.

  • 4 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....