Child pages
  • cPanel API 1 Functions - BoxTrapper::fetchcfgfile

Versions Compared

Key

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

 

Description

Excerpt

This function prints the contents of a BoxTrapper configuration file or form letter.

Include Page
LIB:_cPanelAPI1NoEquivalent
LIB:_cPanelAPI1NoEquivalent

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.
$print_boxtrapper_file = $cpanel->api1('BoxTrapper', 'fetchcfgfile', array('user@example.com', 'list', 'black-list.txt') ); // 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 $print_boxtrapper_file = $cpliveapi->api1('BoxTrapper', 'fetchcfgfile', ['user@example.com', 'list', 'black-list.txt'] ); # 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="BoxTrapper::fetchcfgfile( $FORM('account','filetype','cfgfile') )">
Expand
titleCommand Line
Code Block
languagebash
cpapi1 --user=username BoxTrapper fetchcfgfile user@example.com list black-list.txt

Include Page
LIB:_cPanelAPI1CLINote
LIB:_cPanelAPI1CLINote

Expand
titleOutput (plaintext)
Code Block
languagetext
linenumberstrue
To: %email%
Subject: Re: %subject%

The user %acct% does not accept mail from your address.

The headers of the message sent from your address are shown below:

%headers%

Parameters

ParameterTypeDescriptionPossible valuesExample
accountstring

Required

The account's email address.

A valid email address on the server.user@example.com
filetypestring

Required

The file type.

  • msg — Print the contents of a configuration file.
  • list — Print the contents of a form letter file.
list
cfgfilestring

Required

The filename.

Warning
titleImportant:

Make certain that you select the correct filetype value. 

Configuration files:

  • black-list.txt
  • ignore-list.txt
  • white-list.txt

Form letter files:

  • blacklist.txt
  • returnverify.txt
  • verifyreleased.txt
  • verify.txt
blacklist.txt

Returns

This function returns the selected file's full contents.