Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function lists the ports on which Exim listens.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Chkservd/get_exim_ports

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.
 
// List the ports that Exim listens to.
$get_exim_ports = $cpanel->uapi(
    'Chkservd', 'get_exim_ports'
);

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.
 
# List the ports that Exim listens to.
my $get_exim_ports = $cpliveapi->uapi(
    'Chkservd', 'get_exim_ports',
);

Note:

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

 cPanel Template Toolkit
<!-- Get a list of Exim ports. -->
[% data = execute( 'Chkservd', 'get_exim_ports' ); %]

Note:

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

 Command Line
uapi --user=username Chkservd get_exim_ports

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. 
  • We introduced this functionality in cPanel & WHM version 56.

 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "ports": [
      "25"
    ]
  }
}

Note:

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

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
portsarray

An array of port numbers on which Exim listens.

An array of positive integers.

25