# email

Name email
Type panel
Version 1.0
Since 2020-01-01

# Prologue

Email panel is a complex tool to send emails with up-to-date process data.

# Preview

# Configuration

email:
	render: {width: 6}
	config:

		# Optional | Default null
		# Scalar process variable which is set to TRUE when email is sent
		variable: variable_name

		# Required
		# One of emails or roles required
		from:

			# Optional | Default []
			emails:
				john@doe.com: John Doe
				noreply@system.com: Sysadmin

			# Optional | Default []
			roles: [@creator]

			# Optional | Default []
			# Scalar variable can be used with comma separated emails
			# Json variable can be used with path to emails with comma separated emails
			# Json variable can be used with emails in array
			variables: [scalarVariable, jsonVariable.emails]

		# Required
		# One of emails or roles required
		recipients:

			# Optional | Default []
			emails: [john@black.org, bill@gates.uk]

			# Optional | Default []
			roles: [technician]

			# Optional | Default []
			# Scalar variable can be used with comma separated emails
			# Json variable can be used with path to emails with comma separated emails
			# Json variable can be used with emails in array
			variables: [scalarVariable, jsonVariable.emails]

			# Optional | Default - true
			# User can override recipients
			edit: true

		# Optional
		cc:

			# Optional | Default []
			emails: [john@wick.org]

			# Optional | Default []
			roles: [assistant]

			# Optional | Default []
			# Scalar variable can be used with comma separated emails
			# Json variable can be used with path to emails with comma separated emails
			# Json variable can be used with emails in array
			variables: [scalarVariable, jsonVariable.emails]

		# Optional
		bcc:

			# Optional | Default []
			emails: [joe@wick.org]

			# Optional | Default []
			roles: [@creator]

			# Optional | Default []
			# Scalar variable can be used with comma separated emails
			# Json variable can be used with path to emails with comma separated emails
			# Json variable can be used with emails in array
			variables: [scalarVariable, jsonVariable.emails]

		# Optional
		subject:

			# Optional | Default - null
			# Process variables support
			text: 'Amount of files uploaded: {count($files)}'

			# Optional | Default - true
			# User can edit subject
			edit: true

		# Email main content - optional
		content:

			# Optional | Default - null
			# Has process variables support
			text: 'Good day {$customer->name}, this is email body.'

			# Optional | Default - true
			# User can edit
			edit: true/false

		# Optional
		attachments:

			# Optional | Default: false
			# User can or must attach files
			upload: true/false/mandatory

			# Optional | Default: []
			# Files in variables will be attached to email
			variables: [letter, invoice]

		ui:
			# Optional | Default - null
			# Panel title
			title: Title of panel

			# Optional | Default - null
			# Panel description
			description: Description of the panel
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117