Description
This function sets the FTP welcome message.
Examples
cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_welcome_message?message=Greetings%2C%20Professor%20Falken.
LiveAPI PHP Class
$cpanel = new CPANEL();
$welcome = $cpanel->uapi(
'Ftp', 'set_welcome_message',
array(
'message' => 'Greetings, Professor Falken.',
)
);
LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new();
my $welcome = $cpliveapi->uapi(
'Ftp', 'set_welcome_message',
{
'message' => 'Greetings, Professor Falken.',
}
);
cPanel Template Toolkit
[% execute( 'Ftp', 'set_welcome_message', { message => 'Greetings, Professor Falken.' } ); %]
Command Line
uapi --user=username Ftp set_welcome_message message='Greetings, Professor Falken.'
|
Output (JSON)
{
"messages":null,
"errors":null,
"status":1,
"metadata":{
},
"data":null
}
Parameters
|
Parameter
|
Type
|
Description
|
Possible values
|
Example
|
|
message
|
string
|
Required
The cPanel account's new FTP welcome message.
|
A string.
|
Greetings, Professor Falken.
|
Returns
This function returns only metadata.
