UAPI Functions - Email::check_pipe_forwarder - Knowledgebase

Description

This function checks a program that receives forwarded mail.

Examples

cPanel or Webmail Session URL

https://hostname.example.com:2083/cpsess##########/execute/Email/check_pipe_forwarder?pipe_name=script.pl

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Check whether a pipe or hashbang should precede script.pl.
$check_pipe_forwarder = $cpanel->uapi(
    'Email', 'check_pipe_forwarder',
    array(
        'pipe_name'         => 'script.pl',
         )
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Check whether a pipe or hashbang should precede script.pl.
my $check_pipe_forwarder = $cpliveapi->uapi(
    'Email', 'check_pipe_forwarder',
    {
        'pipe_name'         => 'script.pl',
    }
);

 cPanel Template Toolkit

<!-- Get a hash, then display the pipefwd_needs_hashbang value. -->
[% data = execute( 'Email', 'check_pipe_forwarder', { 'pipe_name' => 'script.pl' } ); %]
[% FOREACH q = data.pipefwd_needs_hashbang %]
     <p>
         [% q %]
     </p>
[% END %]
  
<!-- Get only the pipefwd_needs_hashbang value. -->
[% execute( 'Email', 'check_pipe_forwarder', { 'pipe_name' => 'script.pl' } ).data.pipefwd_needs_hashbang %]

Command Line

uapi --user=username Email check_pipe_forwarder pipe_name=script.pl

Notes:

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

 Output (JSON)

{
  "messages": null,
  "errors": null,
  "status": 1,
  "pipefwd_needs_hashbang": 1,
  "data": null
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

Parameter	Type	Description	Possible values	Example
pipe_name	string	Required The path to a piped program.	The location of a piped program.	script.pl

Parameter

Type

Description

Possible values

Example

pipe_name

string

Required

The path to a piped program.

The location of a piped program.

script.pl

Returns

Parameter	Type	Description	Possible values	Example
pipefwd_needs_hashbang	Boolean	Whether the program requires a hashbang (#!).	1 — Requires a hashbang. 0 — Does not require a hashbang.	1
pipefwd_needs_fixup	Boolean	Whether the program requires a pipe character (\|).	1 — Requires a pipe. 0 — Does not require a pipe.	0

Knowledgebase

Categories

Categories