We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function checks whether plaintext authentication is enabled on the Dovecot® mail server.

Important:

In cPanel & WHM version 76 and later, when you disable the Receive Mail role, the system disables this function.

Examples 


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



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 plaintext authentication is enabled.
$has_plaintext = $cpanel->uapi(
    'Email', 'has_plaintext_authentication'
);


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 plaintext authentication is enabled.
my $fastmail_enabled = $cpliveapi->uapi(
    'Email', 'has_plaintext_authentication',
);


Note:

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


 Command Line
uapi --user=username Email has_plaintext_authentication


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,
   "metadata":{  

   },
   "data":"1"
}


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
dataBooleanWhether plaintext authentication is enabled on the Dovecot mail server.
  • 1 — Enabled.
  • 0 — Disabled.
1