Files
puter/doc/contributors/extensions/events.json.js
T
KernelDeimos 34fdf3abd9 doc: improve docs organization
- Move extension docs back into this repo
- Add index README.md under `doc/`
- Improve documentation of project structure
2025-02-24 16:28:08 -05:00

27 lines
839 B
JavaScript

module.exports = [
{
id: 'core.email.validate',
description: `
This event is emitted when an email is being validated.
The event can be used to block certain emails from being validated.
`,
properties: {
email: {
type: 'string',
mutability: 'no-effect',
summary: 'the email being validated',
notes: [
'The email may have already been cleaned.',
]
},
allow: {
type: 'boolean',
mutability: 'mutable',
summary: 'whether the email is allowed',
notes: [
'If set to false, the email will be considered invalid.',
]
},
},
}
];