Cpanel::Ftp::listftpwithdisk

This article documents the usage of the Cpanel::Ftp::listftpwithdisk function in relation to the cPanel interface. This tag can be used inside cPanel pages.

Synopsis

Cpanel::Ftp::listftpwithdisk.

Description

This function lists FTP accounts for a domain which are using a FTP server compatible with disk space quotas.

Variables

Input

• infinitylang (string)
  
  • Outputs the ``infinity'' language tag if declared and statistic limit is infinity. Usage: infinitylang=true
• infinityimg (string)
  
  • Outputs the image specified if the statistic limit is infinity. Usage: infinityimg=imagename.extension

Output

• accttype
  
  • Type of FTP account. (anonymous, sub, main)
• diskquota
  
  • Disk space usage quota in MB.
• diskused
  
  • Amount of disk space used for the user (or directory if shared) in MB.
• login
  
  • FTP account username. Format: user
• reldir
  
  • Root FTP directory for a user. Relative to /home/username/
• serverlogin
  
  • Username used to login for remote FTP access. Format: user@domain.com

Examples

<?cp Ftp::listftpwithdisk( [tr] [td]%[/td] [td]%[/td] [td]%[/td] [td]% MB[/td] [td]% MB[/td] [/tr] ,serverlogin,accttype,reldir,diskused,diskquota) infinitylang=true ?>

This example will output rows of table with ftp logins, account types, relative FTP root directories, disk space usage, and disk space quotas for all users in the domain.

Copyright

Copyright 2007 cPanel Inc.