Child pages
  • UAPI Functions - Chkservd::get_exim_ports_ssl
Skip to end of metadata
Go to start of metadata

 

Description

This function retrieves Exim's SSL port.

Examples 


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


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 Exim's SSL port.
$get_exim_ports_ssl = $cpanel->uapi(
    'Chkservd', 'get_exim_ports_ssl'
);


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 Exim's SSL port.
my $get_exim_ports_ssl = $cpliveapi->uapi(
    'Chkservd', 'get_exim_ports_ssl',
);


Note:

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

 cPanel Template Toolkit
<!-- List Exim's SSL port. -->
[% data = execute( 'Chkservd', 'get_exim_ports_ssl' ); %]


Note:

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

 Command Line
uapi --user=username Chkservd get_exim_ports_ssl


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/api/uapi


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


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 for SSL/TLS connections.

An array of positive integers.

465