File: /var/www/ojs/lib/pkp/schemas/emailTemplate.json
{
"title": "Email Template",
"description": "A saved email message that can be sent by the application during registration, submission, peer review and all other operations of the application.",
"type": "object",
"required": [
"contextId",
"body",
"key",
"subject"
],
"properties": {
"_href": {
"type": "string",
"format": "uri",
"readOnly": true,
"apiSummary": true
},
"body": {
"type": "string",
"description": "The email template to be used in the email's main body content.",
"multilingual": true,
"apiSummary": true,
"validation": [
"nullable"
]
},
"canDisable": {
"type": "boolean",
"description": "Can this email template be disabled in the context settings area? Default is `true`.",
"apiSummary": true,
"readOnly": true
},
"canEdit": {
"type": "boolean",
"description": "Can this email template be edited in the context settings area? Default is `true`.",
"apiSummary": true,
"readOnly": true
},
"contextId": {
"type": "integer",
"description": "The ID of the context (journal/press) this email is related to. Only used for custom email templates. Default is `null`.",
"apiSummary": "true",
"validation": [
"nullable",
"min:0"
]
},
"description": {
"type": "string",
"description": "A description of when this email template is used.",
"multilingual": true,
"apiSummary": true,
"readOnly": true
},
"enabled": {
"type": "boolean",
"description": "Is this email template enabled? Default is `true`.",
"apiSummary": true
},
"fromRoleId": {
"type": "integer",
"description": "The `ROLE_ID_*` of the user who will send this email.",
"apiSummary": true,
"readOnly": true
},
"id": {
"type": "integer",
"description": "The email template ID.",
"apiSummary": true,
"readOnly": true
},
"key": {
"type": "string",
"description": "A unique key for this email template.",
"apiSummary": true,
"validation": [
"alpha_dash"
]
},
"subject": {
"type": "string",
"description": "The subject of the email to be used in the email's subject header.",
"multilingual": true,
"apiSummary": true,
"validation": [
"nullable"
]
},
"toRoleId": {
"type": "integer",
"description": "The `ROLE_ID_*` of the user who will receive this email.",
"apiSummary": true,
"readOnly": true
},
"stageId": {
"type": "integer",
"description": "The `WORKFLOW_STAGE_ID_*` that email template is associated with or `null` if it is not associated with a stage.",
"apiSummary": true,
"readOnly": true
}
}
}