Description
This function changes the anonymous FTP welcome message.
Examples
LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$ftp_welcomemsg = $cpanel->api1('Ftp', 'set_welcomemsg', array('Someone set us up the bomb') ); // Call the function.
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $ftp_welcomemsg = $cpliveapi->api1('Ftp', 'set_welcomemsg', ['Someone set us up the bomb!'] ); # 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::set_welcomemsg( $FORM('message'))">
Command Line
cpapi1 --user=username Ftp set_welcomemsg message="Someone set us up the bomb!"
Output (none)
This function does not return output.
Parameters
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
message
|
string
|
Required
The new anonymous FTP welcome message.
|
A valid string.
|
Someone set us up the bomb!
|
Returns
This function does not return output.