Child pages
  • UAPI Functions - Email::check_pipe_forwarder
Skip to end of metadata
Go to start of metadata

Description

This function checks a program that receives forwarded mail.

Important:

In cPanel & WHM version 76 and later, when you disable the MailReceive and MailSend roles, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Email/check_pipe_forwarder?pipe_name=script.pl


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 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',
         )
);


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.
 
# Check whether a pipe or hashbang should precede script.pl.
my $check_pipe_forwarder = $cpliveapi->uapi(
    'Email', 'check_pipe_forwarder',
    {
        'pipe_name'         => 'script.pl',
    }
);


Note:

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

 

 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 %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 

 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.
  • 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 (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "pipefwd_needs_hashbang": 1,
  "data": null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
pipe_namestring

Required

The path to a piped program.

The location of a piped program.

script.pl

Returns

ParameterTypeDescriptionPossible valuesExample
pipefwd_needs_hashbangBoolean

Whether the program requires a hashbang (#!).

  • 1 — Requires a hashbang.
  • 0 — Does not require a hashbang.
1
pipefwd_needs_fixupBoolean

Whether the program requires a pipe character (|).

  • 1 — Requires a pipe.
  • 0 — Does not require a pipe.
0