# stripo.generate_email: Stripo Generating, copying, moving, exporting and translating Stripo emails and templates.
stripo.generate_email: Stripo Generating, copying, moving, exporting and translating Stripo emails and templates.
Generates an email from a template and a data source.
Documentation
Fills the generation areas of the template with modules from the library, driven by the data sources, transformers and composers. Counts against the quota of emails and templates.Parameters of Procedure
The following parameters can be used to control the behaviour of the procedure `stripo.generate_email`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `begin package.procedure(value1, value2, value3); end` on a procedure with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `begin package.procedure(name1 => value1, name3 => value3); end` on the same procedure will use the default values for the second and fourth parameters and the specified values for the first and third.
| Name | Data Type | Required | Default Value | Documentation |
|---|:---:|:---:|:---:|---|
| `template_id` | `int64` | ☑ | | The template with the generation areas to fill. |
| `data_sources` | `string` | ☑ | | JSON array of data sources: name, type LINK or RAW, and value. |
| `transformers` | `string` | ☐ | | JSON array of transformers, such as an SRT transformer saved by name. |
| `composers` | `string` | ☐ | | JSON array of composers: which source fills which generation area. |
| `email_name` | `string` | ☐ | | The name of the new email. |
| `email_id` | `int64` | ☐ | | An existing email to overwrite instead of creating one. |
| `folder_id` | `int64` | ☐ | | The folder of the new email. |
| `title` | `string` | ☐ | | The subject line. |
| `preheader` | `string` | ☐ | | The preheader. |
| `utm` | `string` | ☐ | | JSON object of UTM parameters: utmSource, utmMedium, utmCampaign, utmContent, utmTerm and customUtms. |
| `tags` | `string` | ☐ | | Comma-separated tags of the new email. |