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

Description

This function saves the contents of a BoxTrapper 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/save_email_template?email=user@example.com&template=blacklist&contents=To%3A+%25email%25%0D%0ASubject%3A+Re%3A+%25subject%25%0D%0AThe+user+%25acct%25+does+not+accept+mail+from+your+address%0D%0A%0D%0AThe+headers+of+the+message+sent+from+your+address+are+shown+below%0D%0A%0D%0A%25headers%25%0D%0A


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.

// Save BoxTrapper message template content for user@example.com.
$save_email_template = $cpanel->uapi(
    'BoxTrapper', 'save_email_template',
    array(
        'email'    => 'user@example.com',
        'template' => 'blacklist',
		'contents' => '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',
    )
);


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.
 
# Save BoxTrapper message template content for user@example.com.
my $save_email_template = $cpliveapi->uapi(
    'BoxTrapper', 'save_email_template',
    {
        'email'    => 'user@example.com',
        'template' => 'blacklist',
		'contents' => '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',
    }
);


Note:

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

 cPanel Template Toolkit
<!-- Save BoxTrapper message template content for user@example.com. -->
    SET result = execute('BoxTrapper', 'save_email_template', {
        email => 'email@domain.com',
        template => 'blacklist',
        content => "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"
    });

	IF result.status; %]

        <h1>Success!</h1>
        ...
    [% ELSE %]
        [% FOREACH error in result.errors %]
            <p>[% error %]</p>
        [% END %]
    [% END %] 


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=user BoxTrapper save_email_template email=user@example.com template=blacklist contents=To%3A+%25email%25%0D%0ASubject%3A+Re%3A+%25subject%25%0D%0AThe+user+%25acct%25+does+not+accept+mail+from+your+address%0D%0A%0D%0AThe+headers+of+the+message+sent+from+your+address+are+shown+below%0D%0A%0D%0A%25headers%25%0D%0A


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)
{
    "data": null,
    "errors": null,
    "messages": null,
    "metadata": {},
    "status": 1
}


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

Important:

If you use the verify template, you must include Subject: verify#%msgid% in this parameter's value.

Note:

  • For more information about each template, read our BoxTrapper
blacklist
contents string

Required

The template file's contents.

A valid, URI-encoded string.

Important:

  • You must include To: %email% in this parameter's value.
  • If you use the verify template, you must include Subject: verify#%msgid% in this parameter's value.
  • This value cannot exceed four kilobytes (KB).
 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

Returns

This function only returns metadata.