hop-user-manual/modules/ROOT/pages/plugins/transforms/mailvalidator.adoc

////
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at
  http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
////
:documentationPath: /plugins/transforms/
:language: en_US
:page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/transforms/mailvalidator/src/main/doc/mailvalidator.adoc
= Mail Validator

== Description

This transform checks if an email address is valid or not. The checking process returns one result field (Boolean or String depending on your settings) and one additionnal field (String) containing errors string when email address is not valid.

This transform must receive input stream and add result fields in this input stream.

== Options

[width="90%", options="header"]
|===
|Option|Description
|Transform name|Name of the transform.
|email fieldname|Specify the name of the field that contains the email addresses to check. This field must be defined in a previous transform. Dropdown the combo to select fieldname.
|SMTP check?|By default, Hop will only check email address structure (using regular expression). If you want to perform a SMTP check, please select this option and fill Email sender (see after). Hop will extract domain name from the supplied email address (to check) and will try to get all exchangers from the domain name. Each exchanger will be queryed.
|Time out|In order to perform a SMTP check, Hop will open a socket on the target SMTP host. Specify here the socket time out (by default 0).
|Email sender|If you select "SMTP check?" option, this field is mandatory. Hop will need sender email address to query SMTP host.
|Default SMTP server|If you know which SMTP server to query, please specify it here, Hop will then query only this one.
|dynamic default SMTP?|IF you want to pass default SMTP server in a dynamic way, check this option.
|Default SMTP field|If you select the previous option, you must fill this field. This field must be defined in a previous transform. Dropdown the combo to select fieldname.
|Result fieldname|Hop will store the result of the process in this field. The result will be Boolean (TRUE = the email address is valid, FALSE = the email address is unvalid) if "Result is a string" option is unchecked (see after).
Note: This field is mandatory and will be added to the input stream.
|Result is a string|This option will turn the ouput field into a String and when the email address is valid the output will contains the "Email is valid" field (see after) otherwise it will contains the "Email is not valid" field (see after).
|Email is valid|If you selected the previous option, you must fill this field
|Email is not valid|If you selected the previous option, you must fill this field
|Errors field|When an email is address is unvalid, Hop return the reason. If you want to add it in the input stream, please give the field a name, otherwhise leave this field blank. 
|===