Using a Rule to Verify a Contact Email Address

​

Requirements

• To send custom emails with email templates, you’ll need to have your own SMTP server with a username and password. Verify that you have your own SMTP server before following our tutorial Setting up an SMTP server with add-ons.

• Basic knowledge of how to create a player will be necessary, since there will need to be players with a username and password before calling account recovery logic.
• Read the Game Manager quickstart if you’re unfamiliar with the Game Manager, as it’s the place where email templates are created.
• Knowledge of how to work with player profiles will be required, to confirm that emails are necessary for checking that a contact email has been added to a player’s profile. Read up on how to get a player’s profile in the Getting Player Profiles tutorial, and make sure that under the Client Profile Options on your Title you allow Contact email addresses.
• Creating a rule is necessary in this tutorial it’s a good idea to read up on how Rules work.

​

Step 1 - Create an email template

• Select Content from the menu on the left.
• Go to the Email Templates tab.
• Select the NEW EMAIL TEMPLATE button.

• Template name: MyFirstEmailVerificationTemplate
• Template type: Email Verification
• Email subject: Verify your email
• Email body: (enter as below)

<head></head>
<body><p> You recently registered a new email with us.</p>
<p>Please click <a href="$ConfirmationUrl$">here</a> confirm your email. Thanks!</p>

• From Name: The name you want to show in the From field in the email.
• From Email Address: The email address you want to show in the From field in the email. This must be an email domain that the SMTP server enables you to send emails from.

• Callback URL: https://www.example.com

​

A few things to remember

• The $ConfirmationUrl$ in the email body generates a customized URL that when selected, tracks that a user has selected the URL, and then issues a redirect to the Callback URL. In this case, it’s injected into an anchor tag.
• The Callback URL is the URL that PlayFab will redirect to after the player selects the Confirmation URL link. It can be a static page that tells the user they were successful in confirming their email. In this case, we’ll redirect to https://www.example.com.

​

Step 2 - Create a rule to send an email when a contact email is updated

• Select Automation in the menu to the left.
• Select the Rules tab.
• Select NEW RULE.
• Fill out the Rule Name field with your Rule VerifyUpdatedEmail.
• From the Event Type drop-down, select com.playfab.player_updated_contact_email.
• Under the Actions heading, select +ADD ACTION.

• The Email template drop-down should be populated by the template created in Step 1 MyFirstEmailVerificationTemplate.
• If it isn’t, select MyFirstEmailVerificationTemplate from the drop-down.

​

Step 3 - Add a contact email to a player

​

C# code example

void AddContactEmailToPlayer()
{
    var loginReq = new LoginWithCustomIDRequest
    {
        CustomId = "SomeCustomID", // replace with your own Custom ID
        CreateAccount = true // otherwise this will create an account with that ID
    };

    var emailAddress = "testaddress@example.com"; // Set this to your own email

    PlayFabClientAPI.LoginWithCustomID(loginReq, loginRes =>
    {
        Debug.Log("Successfully logged in player with PlayFabId: " + loginRes.PlayFabId);
        AddOrUpdateContactEmail(loginRes.PlayFabId, emailAddress);
    }, FailureCallback);
}

void AddOrUpdateContactEmail(string playFabId, string emailAddress)
{
    var request = new AddOrUpdateContactEmailRequest
    {
        EmailAddress = emailAddress
    };
    PlayFabClientAPI.AddOrUpdateContactEmail(request, result =>
    {
        Debug.Log("The player's account has been updated with a contact email");
    }, FailureCallback);
}

void FailureCallback(PlayFabError error)
{
    Debug.LogWarning("Something went wrong with your API call. Here's some debug information:");
    Debug.LogError(error.GenerateErrorReport());
}

​

Step 4 - Confirm that the contact email was added to the player’s profile

​

Step 5 - Check that the email was sent

• Select Players in the menu to the left.
• On the Players Tab, go to the PlayStream area.
• It should show a Sent Email Event.

{
    "EventName": "sent_email",
    "EventNamespace": "com.playfab",
    "Source": "PlayFab",
    "EntityType": "player",
    "TitleId": "YourTitleId",
    "EventId": "a05625e48b1f4194bd08d1ff6a889cf8",
    "EntityId": "64647AA368D6448E",
    "SourceType": "BackEnd",
    "Timestamp": "2017-10-27T09:35:16.2946918Z",
    "History": null,
    "CustomTags": null,
    "Reserved": null,
    "emailTemplateId": "7D6438687903D4DC",
    "emailTemplateName": "MyFirstEmailVerificationTemplate",
    "emailTemplateType": "EmailVerification",
    "success": true,
    "emailName": "Primary"
}

https://a5f3.playfabapi.com/EmailConfirmation/Confirm/?token=2346241B7C277796&titleId=A5F3&templateId=38017AAE7F494AB3

1. PlayFab generates a new PlayStream event, called auth_token_validated. This is how you know that the player selected that URL in the email.
   • You can use that event to trigger actions, like granting coins or items to the player.
2. Because this email template was the special Email Verification template, PlayFab will then mark the player email as Verified.
3. PlayFab returns a redirect URL sending the player to the callback URL website.
   • On this website you can show a static Thanks for verifying your email message, or something more elaborate. The redirect URL looks something like this: https://www.example.com/?token=2346241B7C277796.
   • Go ahead and select the URL found in the email.
   • You’ll be taken to the example.com website.
   • View your Player Profile using the Game Manager.
   • You’ll see that the Verification status has changed.

​

Conclusion