Advanced options for the email verification widget

In this page

The email verification widget can be customised to suit your needs. The integration instructions should allow you to set up quickly, and once this is done, you can tweak the behaviour.

There are four attributes that can be customised. These are: disposable, role, public and unverified. For each of these, you are able to set a rule and a message. See the API docs for a definition for these attributes.

There are three rules you can pick from:

• allow will trigger the widget to show a green tick, and no error message.
• warn will trigger the widget to show an orange warning icon, and an error message.
• block will trigger the widget to show a red cross, and an error message. It will also prevent the user from submitting the form.

When using warn or block you can also provide a customised message.

Custom rules and messges

Below is an example of the rules that can be used to customise the widget:

    
rules: {
  disposable: {
    rule: "block",
    message: "We do not accept disposable email addresses, please enter a different email to continue"
  },
  role: {
    rule: "warn",
    message: "We prefer it if you provide your own email address instead of a shared inbox. You can still sign up with this one if you want."
  },
  public: {
    rule: "allow"
  },
  unverified: {
    rule: "warn",
    message: "We are not able to verify that this is a correct email address. You can sign up with it, but please check you don't have any spelling mistakes."
  }
}
    
  

Optional rules and messges

The rule and the message are both optional, here is an example of a partial customisation:

    
rules: {
  disposable: {
    rule: "block",
    message: "We do not accept disposable email addresses, please enter a different email to continue"
  },
  role: {
    rule: "warn",
  },
  public: {
    rule: "allow"
  },
  unverified: {
    message: "We are not able to verify that this is a correct email address. You can sign up with it, but please check you don't have any spelling mistakes."
  }
}
    
  

Default rules and messges

In the absence of a specified rule and message, the following defaults are applied:

    
{
  disposable: {
    rule: "allow"
  },
  role: {
    rule: "allow"
  },
  public: {
    rule: "allow"
  },
  unverified: {
    rule: “warn”,
    message: "It looks like there could be a problem with this email address, this is allowed but please check it is correct before continuing"
  }
}
    
  

Default responses

In the absence of a message supplied, the following defaults are applied: