Child pages
  • UAPI Functions - BoxTrapper::get_email_template
Skip to end of metadata
Go to start of metadata

Description

This function retrieves a BoxTrapper email message template.

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/get_email_template?email=user@example.com&template=verify


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.

// Retrieve BoxTrapper message template for user@example.com.
$get_email_template = $cpanel->uapi(
    'BoxTrapper', 'get_email_template',
    array(
        'email'    => 'user@example.com',
        'template' => 'verify',
    )
);


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.
 
# Retrieve the BoxTrapper message template for user@example.com.
my $get_email_template = $cpliveapi->uapi(
    'BoxTrapper', 'get_email_template',
    {
        'email'    => 'user@example.com',
        'template' => 'verify',
    }
);


Note:

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

 Command Line
uapi --user=username BoxTrapper get_email_template email=user@example.com template=verify


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" : "To: %email%\nSubject: Re: %subject%\n\nThe user %acct% does not accept mail from your address.\n\nThe headers of the message sent from your address are shown below:\n\n%headers%\n",
      "warnings" : null,
      "errors" : null
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
email

string

Required

The account's email address.

Warning

If you call this function in Webmail, the system overrides this parameter. This parameter defaults to the current email address.

A valid email address on the cPanel account.user@example.com
templatestring

Required

The message template.

  • blacklist
  • returnverify
  • verifyreleased
  • verify

Note:

For more information on each template, read our BoxTrapper documentation.

verify

Returns

ReturnTypeDescriptionPossible valuesExample

stringA string that returns the template file's contents.A valid string.
 Click to view...
To: %email%\nSubject: Re: %subject%\n\nThe user %acct% does not accept mail from your address.\n\nThe headers of the message sent from your address are shown below:\n\n%headers%\n",