Description

This function creates an account's /cpanelbranding directory and subdirectories, and sets its permissions.

Examples


$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
$branding_dir = $cpanel->api1('Branding', 'setupdir', array('public_html') ); // Call the function.

 

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
my $branding_dir = $cpliveapi->api1('Branding', 'setupdirs', ['public_html'] ); # Call the function.

 

<cpanel Module="Branding::setupdirs( $FORM('ownerhomedir') )">
cpapi1 --user=username Branding setupdirs public_html x3 package1

This function does not return output.

 

Parameters

ParameterTypeDescriptionPossible valuesExample
ownerhomedirstring

Required

The account owner's /home directory's filepath.

A valid directory name.public_html
themestringThe account's theme.

 

 

A valid theme.

x3
brandingpkgstring

The branding package name.

A valid branding package name.

package1

Returns

This function does not return output.