Use this endpoint to suggest email addresses based on the first name, last name, and partial email input provided by the user.
Related Email documentation:
- Email introduction
- DQEEMAILLOOKUP — Email validation
- Email API Swagger documentation
- Email output columns
GET request
Endpoint
https://{SERVER_ADDRESS}/MAILSUGGEST/?Nom={NAME}&Prenom={FIRST_NAME}&Email={EMAIL}&Pays={COUNTRY_CODE}&Licence={LICENCE_CODE}Replace the values in braces with your own information:
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| SERVER_ADDRESS | {SERVER_ADDRESS} |
Address of the DQE server that will process the data. | Mandatory |
| Licence | {LICENCE_CODE} |
Licence code assigned to your account. | Mandatory |
| Nom | {NAME} |
Last name entered in the form. | Mandatory; can be empty. |
| Prenom | {FIRST_NAME} |
First name entered in the form. | Mandatory; can be empty. |
{EMAIL} |
Part of the email already entered by the user. | Mandatory; can be empty. | |
| Pays | {COUNTRY_CODE} |
ISO 3-letter country code. | Optional. Default value: FRA. |
POST request
Endpoint
https://{SERVER_ADDRESS}/MAILSUGGEST/Add the following parameters in the request body using x-www-form-urlencoded.
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Licence code assigned to your account. | Mandatory |
| Nom | {NAME} |
Last name entered in the form. | Mandatory; can be empty. |
| Prenom | {FIRST_NAME} |
First name entered in the form. | Mandatory; can be empty. |
{EMAIL} |
Part of the email already entered by the user. | Mandatory; can be empty. | |
| Pays | {COUNTRY_CODE} |
ISO 3-letter country code. | Optional. Default value: FRA. |
Response
Success response
The JSON response is a dictionary containing the suggest key. Its value is an array of suggested email addresses.
| Key | Description | Type |
|---|---|---|
| Instance | Instance number passed as a parameter during the request. | STRING(3) |
| syntaxe |
ok or ko. |
STRING(2) |
| suggest | List of suggested email addresses. | ARRAY |
Example:
{
"Instance": "0",
"suggest": [
"ttesta@",
"testat@",
"t.testa@",
"testbtesta@",
"ttestb@",
"testatestb@",
"testa.testb@",
"testb.testa@",
"testb-testa@",
"testa-testb@",
"t-testa@",
"testa-t@"
],
"syntaxe": "ok"
}Error response
| Error type | Response type |
|---|---|
Missing Licence parameter |
400 Bad Request |
Empty Licence parameter |
400 Bad Request |
| Incorrect licence number | Empty response |
See also
Related to