Email Plug-In

The Email Plug-In for Convergence for MDM provides an enricher to improve the quality of email addresses and a validator to check email validity.

Convergence Email Enricher

Plug-in ID

Convergence Email Enricher - com.semarchy.engine.plugins.convergence.email

Description

This enricher takes an Input Email Address and splits this address into the local-part (user name) and the domain name. Both these parts are checked syntactically and syntax errors are fixed automatically. The domain name validity is also checked using MX records lookup.

The plug-in uses several mechanisms for faster checks and automated fixes on domain names:

Plug-in Parameters

The following table lists the plug-in parameters.

Parameter Name Mandatory Type Description
Datasource No String Full name of the JDBC Datasource used to store the host name validation cache. If no datasource is specified then the data location’s datasource is used. For example: java:comp/env/jdbc/email_cache.
Lowercase User Name No String Set to ‘1’ to transform the local-part (username) to lowercase in the cleansed email address.
Offline Mode No String Set to ‘1’ to query only the local domain cache. The plug-in does not perform the MX Record Lookup.
Processing Mode No String Processing mode: DATABASE (default) or MEMORY. Memory mode is faster but requires more memory as it caches entirely the host name validation cache in memory.

Plug-in Inputs

The following table lists the plug-in inputs.

Parameter Name Mandatory Type Description
Input Email Address Yes String Input email address to cleanse.

Plug-in Outputs

The following table lists the plug-in outputs.

Parameter Name Type Description
Cleansed Email Address String Cleansed email address returned by the enricher. This address may be valid or not. The syntactic validity or domain name validity of the email address is indicated in the other plug-in outputs.
Valid Domain String Flag (0 or 1) indicating whether the domain name is valid or not (based on syntax and MX records lookup) in the cleansed email address. In Offline mode, this parameter returns 1 or 0 if the domain name appears in the local domain cache as valid of invalid. It returns “null” if the domain name does not exist in the cache and the MX Lookup was not issued.
Valid Domain Syntax String Flag (0 or 1) indicating whether the domain name syntax is valid or not in the cleansed email address.
Valid Email Syntax String Flag (0 or 1) indicating indicating whether the the cleansed email address is syntactically valid or not.
Valid Username Syntax String Flag (0 or 1) indicating whether the local-part (user name) syntax is valid or not in the cleansed email address.
Valid Input Domain String Flag (0 or 1) indicating whether the domain name is valid or not (based on syntax and MX records lookup) in the input email address. In Offline mode, this parameter returns 1 or 0 if the domain name appears in the local domain cache as valid of invalid. It returns “null” if the domain name does not exist in the cache and the MX Lookup was not issued.
Valid Input Domain Syntax String Flag (0 or 1) indicating whether the domain name syntax is valid or not in the input email address.
Valid Input Email Syntax String Flag (0 or 1) indicating whether the input email address is syntactically valid or not.
Valid Input Username Syntax String Flag (0 or 1) indicating whether the local-part (user name) syntax is valid or not in the input email address.

Convergence Email Validator

Plug-in ID

Convergence Email Validator - com.semarchy.engine.plugins.convergence.email

Description

This enricher takes an Input Email Address and checks its syntactic validity. Tthe domain name validity is optionally also checked using MX records lookup.

The plug-in uses the same mechanisms as the Convergence Email Enricher for checking the email validity, except that it does not modify the incoming email.

Plug-in Parameters

The following table lists the plug-in parameters.

Parameter Name Mandatory Type Description
Accepted Domains No String Value tolerated for the email domain. Possibles values are ALL_DOMAINS (domain is not checked as all), VALID_DOMAINS (domain must be syntactically valid and MX lookup must be successful) and and VALID_AND_UNKNOWN (domain must be syntactically valid).
Offline Mode No String Set to ‘1’ to query only the local domain cache. The plug-in does not perform the MX Record Lookup.
Processing Mode No String Processing mode: DATABASE (default) or MEMORY. Memory mode is faster but requires more memory as it caches entirely the host name validation cache in memory.

Plug-in Inputs

The following table lists the plug-in inputs.

Parameter Name Mandatory Type Description
Input Email Address Yes String Input email address to check.