Child pages
  • cPanel API 1 Functions - Ftp::set_welcomemsg

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Description

Excerpt

This function changes the anonymous FTP welcome message.

Warning
titleWarning:

Include Page
LIB:_cPanelAPI1NewerFunctions
LIB:_cPanelAPI1NewerFunctions

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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.

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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.

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 

Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelTagsWarning
LIB:_cPanelTagsWarning

Code Block
languagetext
<cpanel Module="Ftp::set_welcomemsg( $FORM('message'))">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username Ftp set_welcomemsg "Message"
Note
titleNote:

For more information and additional output options, read our Guide to cPanel API 1 documentation or run the cpapi1 --help command.  

Expand
titleOutput (none)
This function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
messagestring

Required

The new anonymous FTP welcome message.

A valid string.
Message

Returns

This function does not return output.