How do I customize the Trademark Claims Notification e-mail?
Question
How do I customize the Trademark Claims Notification e-mail?
Answer
In some cases Openprovider is obliged to send a Trademark Claims Notification (TCN). It is possible to personalize this e-mail and the page on which the customer acknowledges the registration. By setting up your own confirmation page, your customer does not have to leave your website.
Configuration of e-mail
Log in to the control panel and navigate to the menu Account > Settings to configure your TCN branding. The Confirmation link can be used to lead the registrant to your own website. This confirmation link can be anything, as long as you include the following two or three variables:
- %%domain%% is the domain name to be registered (optional value)
- %%domainId%% is a unique identifier for the domain that is registered
- %%authCode%% is a security code to prevent abuse
Two examples of a valid URL would then be:
https://www.example.com/transfers/confirm.php?domain=%%domain%%&domainId=%%domainId%%&authCode=%%authCode%%
https://foa-approve.example.com/%%domainId%%/%%authCode%%/
Handling TCN responses
Basically, your script should call the callback script of Openprovider with the right variables: domainId, authCode and approval. (The variable domain is not used in the call to Openprovider.) The approval variable should contain yes or no:
https://rcp.openprovider.eu/misc.php/domain/claimCallback/?domainId=%%domainId%%&authCode=%%authCode%%&approve=%%approval%%
There are many ways to accomplish this, one of the approaches is written in an example PHP script below. This script displays a very basic form and asks for an approval or reject. Having that answer, it calls the Openprovider server:
<?php
/* requires confirmation URL including
?domainId=%%domainId%%&authCode=%%authCode%%
*/
if (isset($_GET['approval']) && $_GET['domainId'] && $_GET['authCode']) {
$url = 'http://rcp.openprovider.eu/misc.php/domain/claimCallback/'
.'?domainId='.$_GET['domainId']
.'&authCode='.$_GET['authCode']
.'&approve='.$_GET['approval'];
// This command requires allow_url_fopen to be enabled
$response = file_get_contents($url);
// Alternatively, use the PHP CURL functions
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$response = curl_exec($ch);
curl_close ($ch);
// Output the response to the website visitor, or use this response in your own script for a better answer
echo $response;
exit;
}
else if ($_GET['submit']) {
echo 'Not all fields completed<br />';
}
?>
<html>
<head>
<title>Acknowledge registration</title>
</head>
<body>
<form method="get">
Domain: <input type="text" name="domain" value="<?php echo $_GET['domain']; ?>" /><br />
DomainId: <input type="hidden" name="domainId" value="<?php echo $_GET['domainId']; ?>" /><br />
Code: <input type="text" name="authCode" value="<?php echo $_GET['authCode']; ?>" /><br />
<input type="radio" name="approval" value="yes" <?php if ($_GET['approval'] == 'yes') echo ' checked'; ?> /> Approve
<input type="radio" name="approval" value="no" <?php if ($_GET['approval'] == 'no') echo ' checked'; ?> /> Reject<br />
<input type="submit" name="submit" value="Send" />
</form>
</body>
</html>
There are four possible responses:
- If an approval is successfully processed, the response is:
status=Ok;
message=TMCH claims has been approved. - If a rejection is successfully processed, the response is:
status=Rejected;
message=TMCH claims has been rejected. - If an other error occurred, the response shows details, for example:
-
status=Error;
message=We were not able to proceed with approval claims, because authCode for this operation is wrong