Check for broken email addresses (EK20002)
Valid email addresses keep contact paths open. Learn how EkLine checks the addresses in your documentation and how to fix broken ones.
A valid email address keeps readers able to reach the support, feedback, or access contact you point them to. EkLine verifies that the email addresses in your documentation are well-formed and deliverable, and flags any that aren’t (rule EK20002).
Why check for valid email addresses in documentation?
Section titled “Why check for valid email addresses in documentation?”Documentation often directs readers to an email address for support, feedback, or access requests. A typo or a retired address sends those messages nowhere, and the reader rarely learns the mail failed. Checking addresses on every review keeps your contact paths open.
What EkLine flags
Section titled “What EkLine flags”EK20002 checks each email address in your documentation and flags one that is malformed or undeliverable. A malformed address has a structural problem, such as a missing @ or domain, while an undeliverable address has valid form but no reachable mailbox.
How to fix
Section titled “How to fix”Correct the address so it is well-formed and points at a live mailbox, or remove it if the contact no longer exists.
How do you fix a broken email address?
Section titled “How do you fix a broken email address?”Correct the address so it is well-formed and points at a live mailbox, or remove it if the contact no longer exists.
Does the check follow addresses it can’t verify?
Section titled “Does the check follow addresses it can’t verify?”It may flag a valid address it can’t confirm, such as an internal alias. When the address is valid, keep it and ignore the rule on that line.
Rule details
Section titled “Rule details”| Property | Value |
|---|---|
| Rule ID | EK20002 |
| Category | Links and references |
| Default severity | Error |
| Enabled by default | No |
Ignore this rule
Section titled “Ignore this rule”Fix or remove the address before you silence this rule — a broken address stops readers from reaching you. When an address is valid but EkLine flags it, such as an internal alias, keep it on one line with an inline comment:
<!-- ekline-ignore-next-line EK20002 -- valid internal alias -->Contact docs-team@internal for access.To disable the rule across your project, add it to the ignore list in your configuration file.
Related rules
Section titled “Related rules”- EK20001 — Check for broken links