Description

This function sets the FTP welcome message.

Examples 




https://hostname.example.com:2083/cpsess##########/execute/Ftp/set_welcome_message?message=Greetings%2C%20Professor%20Falken.



$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// Set the FTP welcome message.
$welcome = $cpanel->uapi(
    'Ftp', 'set_welcome_message',
    array(
        'message'    => 'Greetings, Professor Falken.',
         )
);

 



my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# Set the FTP welcome message.
my $welcome = $cpliveapi->uapi(
    'Ftp', 'set_welcome_message',
    {
        'message'    => 'Greetings, Professor Falken.',
    }
);

 



<!-- Set the FTP welcome message. -->
[% execute( 'Ftp', 'set_welcome_message', { message => 'Greetings, Professor Falken.' } ); %]

 



uapi --user=username Ftp set_welcome_message message='Greetings, Professor Falken.'



{  
   "messages":null,
   "errors":null,
   "status":1,
   "metadata":{  

   },
   "data":null
}



Parameters

ParameterTypeDescriptionPossible valuesExample
messagestring

Required

The cPanel account's new FTP welcome message.

A string.

Greetings, Professor Falken.

Returns

This function returns only metadata.