Description
This function returns the anonymous FTP welcome message.
Examples
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$ftp_welcomemsg = $cpanel->api1('Ftp','get_welcomemsg'); // Call the function.
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $ftp_welcomemsg = $cpliveapi->api1('Ftp','get_welcomemsg'); # Call the function.
cPanel Tag System (deprecated)
Warning:
In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. This example is present in order to help developers move from the old cPanel tag system to our LiveAPI.
We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.
<cpanel Module="Ftp::get_welcomemsg()">
Command Line
cpapi1 --user=username Ftp get_welcomemsg
Output (plaintext)
All your base are belong to us.
Parameters
This function does not accept parameters.
Returns
This function returns the anonymous FTP welcome message.