Child pages
  • cPanel API 1 Functions - Email::checkpipefwd

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

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
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$check_pipes = $cpanel->api1('Email', 'checkpipefwd', array('script.pl') ); // Call the function.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

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

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Email::checkpipefwd( $FORM('pipe_name') )">
Expand
titleCommand Line
Code Block
cpapi1 --user=username Email checkpipefwd script.pl

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote

Expand
titleOutput (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.