Email¶

See Email for more information about this algorithm framework.

Creating an Email Algorithm via API¶

Retrieve the frameworkId for the Email Framework. This information can be retrieved using the following endpoint:
```
algorithm   GET /algorithm/frameworks
```
The framework information should look similar to the following:
```
{
      "frameworkId": 3,
      "frameworkName": "Email",
      "frameworkType": "STRING",
      "plugin": {
          "pluginId": 7,
          "pluginName": "dlpx-core",
          "pluginAuthor": "Delphix Engineering",
          "pluginType": "EXTENDED_ALGORITHM"
      }
}
```
1. Lookup files should be provided via File Reference. Files can be uploaded via the following endpoint:
  
  fileUpload POST /file-uploads
Alternatively, those files might also be provided via HTTP / HTTPS / NFS mount URLs.

Create an Email algorithm via the following endpoint:

algorithm   POST /algorithms

Configure a new algorithm using the JSON formatted input similar to the following:

 {
      "algorithmName": "ExampleEmailAlgorithm",
      "algorithmType": "COMPONENT",
      "frameworkId": 3,
      "algorithmExtension": {
          "nameAction": "LOOKUP",
          "domainAction": "REPLACEMENT",
          "nameAlgorithm": null,
          "nameLookupFile": {
              "uri": "delphix-file://upload/f_08bb469a2ddc407bb97a31e96ed0a76a/lookup.txt"
          },
          "domainAlgorithm": null,
          "domainReplacementString": "delphix.com"
      }
}

Email Algorithm Extension¶

nameAction

NameAction
The type of action to apply to the name portion of the email. Must be one of the following enum values:
- UNIQUE - applies a SHA-256 hash of the entire input then Base32 encodes the hash value
- LOOKUP - applies a secure lookup using the values provided in the lookup list
- APPLY_ALGORITHM - the name portion is replaced by the output of another chained masking algorithm

Info

The UNIQUE option may produce masked name portions with lengths up to 52 characters.
domainAction

MaskAction
The type of action to apply to the name portion of the email. Must be one of the following enum values:
- REPLACEMENT - the domain portion is replaced by a fixed value
- APPLY_ALGORITHM - the domain portion is replaced by the output of another chained masking algorithm
nameLookupFile

FileReference
A file reference to a UTF-8 encoded file containing newline separated replacement values for the name portion of the email.
nameAlgorithm

AlgorithmInstanceReference
A reference for the algorithm to use when "APPLY_ALGORITHM" is the NameAction type. The algorithm must have maskingType "STRING". The algorithm will never be passed a null or empty value to mask. See AlgorithmInstanceReference Extension below for more information.
domainAlgorithm

AlgorithmInstanceReference
A reference for the algorithm to use when "APPLY_ALGORITHM" is the DomainAction type. The algorithm must have maskingType "STRING". The algorithm will never be passed a null or empty value to mask. See AlgorithmInstanceReference Extension below for more information.
domainReplacementString

String
The string to replace the domain portion when "REPLACEMENT" is the DomainAction type.

AlgorithmInstanceReference Extension¶

name

String
The algorithm instance name.