Our documentation is getting an overhaul! We would like your input! Click here to take a look at the beta launch of our new documentation site! Only cPanel & WHM version 82 documentation exists on our beta at this time. 84 will be added to the new site soon! Leave your feedback here: https://go.cpanel.net/docsfeedback
UAPI Functions - BoxTrapper::list_email_templates - Developer Documentation - cPanel Documentation
Child pages
  • UAPI Functions - BoxTrapper::list_email_templates
Skip to end of metadata
Go to start of metadata

Description

This function lists the BoxTrapper email templates.

Important:

When you disable the MailReceive role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples 


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/BoxTrapper/list_email_templates


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List BoxTrapper message templates for user@example.com.
$list_email_template = $cpanel->uapi(
    'BoxTrapper', 'list_email_templates',
);


Note:

For more information, read our Guide to the LiveAPI System.

 LiveAPI Perl Module
my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
 
# List the BoxTrapper message templates for user@example.com.
my $list_email_templates = $cpliveapi->uapi(
    'BoxTrapper', 'list_email_templates',
);


Note:

For more information, read our Guide to the LiveAPI System.

 Command Line
uapi --user=username BoxTrapper list_email_templates


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
	{
      "messages" : null,
      "metadata" : {},
      "status" : 1,
      "data" : [
         "blacklist",
         "returnverify",
         "verifyreleased",
         "verify"
      ],
      "warnings" : null,
      "errors" : null
 	}


Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample

arrayAn array that contains the message's templates.
  • blacklist
  • returnverify
  • verifyreleased
  • verify

For more information about each template, read our BoxTrapper




 Click to view...
blacklist,
returnverify,
verifyreleased,
verify