Skip to content

Rich email address

Preview

This feature is not subject to our service terms. Pre-GA features are available as is and might have limited support.

A rich email address includes both the syntax and intelligence components of an email address. For some job types, your application must provide an email address. For others, providing one or more email addresses is recommended because it can increase accuracy and coverage. In some cases, Modigie may append email addresses.

Schema

The job's payload.emailAddresses property is an array of type RichEmailAddressV2.

A RichEmailAddressV2 object has three properties:

emailAddress: EmailAddress
The syntax components of an email address. See EmailAddress for more details. The userFormat property is required, and all other properties are read-only.
rels: List of string optional

The presumed relationship of this email address:

  • "business": Email address of a person in relation to a business.
  • "personal": Private email address of a person.
  • "sms": Email address that can be used to send an email as an SMS message to a phone number. Typically, Modigie appends this when enriching a mobile phone number.
  • "other": Email address with any other or unknown relation to the person.
source: JobV2Source optional
The source of this RichEmailAddressV2 object. See Source of an attribute for more details.

Examples

Your application provides a business email address

job-request.json
{
  "payload": {
    "emailAddresses": [
      {
        "emailAddress": {
          "userFormat": "jdoe@acme.com"
        },
        "rels": ["business"],
        "source": {
          "objectId": "personA",
          "propertyName": "companyEmail"
        }
      }
    ],
    ...
  },
  ...
}

Modigie performs a syntax validation on every email address your application provides. In many cases, your application should test that isSyntaxValid=true and isDeliverable=true. The latter indicates whether a DNS record is set up for the domain part of the email address. Without this MX record, an email cannot be delivered to this address.

job-response.json
{
  "payload": {
    "emailAddresses": [
      {
        "rels": [
          "business"
        ],
        "emailAddress": {
          "userFormat": "jdoe@acme.com",
          "normalFormat": "jdoe@acme.com",
          "rfc882Format": "jdoe@acme.com",
          "isDeliverable": true,
          "isSyntaxValid": true
        },
        "source": {
          "objectSystem": null,
          "objectType": null,
          "objectId": "personA",
          "propertyName": "companyEmail"
        }
      }
    ],
    ...
  },
  ...
}

Your application provides an invalid email address

job-request.json
{
  "payload": {
    "emailAddresses": [
      {
        "emailAddress": {
          "userFormat": "example.com"
        },
        "rels": ["business"],
        "source": {
          "objectId": "personA",
          "propertyName": "companyEmail"
        }
      }
    ],
    ...
  },
  ...
}

Because the syntax of the email address is invalid, Modigie removes the business relationship and may reject the job request.

job-response.json
{
  "payload": {
    "emailAddresses": [
      {
        "emailAddress": {
          "isDeliverable": false,
          "isSyntaxValid": false,
          "normalFormat": null,
          "rfc882Format": null,
          "userFormat": "example.com"
        },
        "rels": [],
        "source": {
          ...
        }
      }
    ],
    ...
  },
  ...
}

Schema: RichEmailAddressV2