jakartaee / jakartaee/mail-api

Invalid Javadoc links to https://javaee.github.io/jakartamail/...

Open
#612 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
285
Forks
109
Avg merge
15h 19m
Merged PRs (30d)
1

Description

**Describe the bug**
API documentation links to external material lead to 404 HTTP errors.

**To Reproduce**
Steps to reproduce the behavior:
1. Read link from https://github.com/eclipse-ee4j/mail/blob/fedabffb18abf8f4730f75d92e28980e20d0ad82/api/src/main/java/jakarta/mail/package-info.java#L28
2. https://javaee.github.io/jakartamail/docs/JakartaMail-1.6.pdf does not exist (and the filename does not match the API version neither btw)
3. Read links from https://github.com/eclipse-ee4j/mail/blob/fedabffb18abf8f4730f75d92e28980e20d0ad82/api/src/main/java/jakarta/mail/package-info.java#L58-L61
4. https://javaee.github.io/jakartamail/FAQ.html & https://javaee.github.io/jakartamail/ lead to 404s

**Expected behavior**
The Javadoc content to refer to existing material.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Mail server:**
- Protocol being used: [e.g. smtp, imap, pop3, etc.]
- Vendor/product: [e.g. Microsoft Exchange]
- Mail service URL: [e.g. gmail.com]

**Additional context**
Add any other context about the problem here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in api/src/main/java/jakarta/mail/package-info.java at the links cited around lines 28 and 58-61. Check the current Jakarta Mail documentation locations and verify the referenced pages are reachable and appropriate for the API version. Done means the Javadoc links no longer lead to 404 errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.