Skip to content
This repository was archived by the owner on Mar 18, 2024. It is now read-only.

Commit 477ae6d

Browse files
authored
Update README.md
1 parent 71079ce commit 477ae6d

File tree

1 file changed

+65
-4
lines changed

1 file changed

+65
-4
lines changed

README.md

Lines changed: 65 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,66 @@
1+
12
# EMailClient-GUI
2-
<p><strong>JavaFX User Interface for the <a href="https://github.com/xLPMG/EMailClient">Java E-Mail Client</a></strong></p>
3-
<p>Institution: FSU Jena, Comp Sci Year 3<br />Advanced Java programming course: E-Mail Client<br />Deadline: 10.02.23</p>
4-
<p>Tasks:</p>
5-
<p>Develop the standard version of an eMail client. Use the following layout as a guideline, whereby each area must have a certain (minimum) functionality:<br />- Dialog for entering account information<br />◦ Entering the name<br />◦ Entering the sender e-mail address<br />◦ Entering the address/port of the POP3 server<br />◦ Entering the address/port of the SMTP server<br />◦ Entering the user ID<br />◦ Entering the user password<br />- Window for creating new messages<br />◦ Entering the sender address (preselection from account information)<br />◦ Entering the recipient<br />◦ Entering the copy recipient<br />◦ Entering the subject<br />◦ Field for entering the message text<br />◦ Menu for sending the message and for canceling it.<br />- Main window as interface for the client<br />◦ Menu for new eMail, receive, options, exit<br />◦ List of downloaded mails<br />◦ Field for displaying the eMail selected in the list.<br />- Administration of eMails<br />◦ Management of emails on hard disk<br />◦ load old eMails when starting the program<br />◦ when retrieving eMails from the server, load only new ones (even after program restart).</p>
3+
4+
Java GUI E-Mail Client based on the [Java E-Mail Client](https://github.com/xLPMG/EMailClient)
5+
- **Institution:** FSU Jena, Comp Sci Year 3
6+
- **Course:** Advanced programming course: E-Mail Client
7+
- **Deadline:** 10.02.2023
8+
- **GUI:** [JavaFX](https://openjfx.io)
9+
- **Mail API:** [Jakarta Mail](https://jakartaee.github.io/mail-api/)
10+
- **Library management:** Gradle(Kotlin)
11+
12+
13+
## Authors
14+
15+
- [@xLPMG](https://www.github.com/xLPMG)
16+
- [@ZeyxRew](https://www.github.com/ZeyxRew)
17+
18+
19+
## Features (requested functionalities)
20+
21+
**Task:** Develop the standard version of an eMail client. Use the following layout as a guideline, whereby each area must have a certain (minimum) functionality
22+
- Dialog for entering account information
23+
- Entering the name
24+
- Entering the sender e-mail address
25+
- Entering the address/port of the POP3 server
26+
- Entering the address/port of the SMTP server
27+
- Entering the user ID
28+
- Entering the user password
29+
- Window for creating new messages
30+
- Entering the sender address (preselection from account information)
31+
- Entering the recipient
32+
- Entering the copy recipient
33+
- Entering the subject
34+
- Field for entering the message text
35+
- Menu for sending the message and for canceling it.
36+
- Main window as interface for the client
37+
- Menu for new eMail, receive, options, exit
38+
- List of downloaded mails
39+
- Field for displaying the eMail selected in the list.
40+
- Administration of eMails
41+
- Management of emails on hard disk
42+
- load old eMails when starting the program
43+
- when retrieving eMails from the server, load only new ones (even after program restart).
44+
45+
## Color Reference
46+
47+
see [macOS Color Guide](https://developer.apple.com/design/human-interface-guidelines/foundations/color/)
48+
49+
## Color Reference
50+
51+
| Color | Hex |
52+
| ------------------------- | -------------------------------------------------------------------- |
53+
| systemBackground | ![#000000FF](https://placehold.co/15x15/000000/000000.png) #000000FF |
54+
| secondarySystemBackground | ![#1C1C1EFF](https://placehold.co/15x15/1C1C1E/1C1C1E.png) #1C1C1EFF |
55+
| tertiarySystemBackground | ![#2C2C2EFF](https://placehold.co/15x15/2C2C2E/2C2C2E.png) #2C2C2EFF |
56+
| primarylabel | ![#FFFFFFFF](https://placehold.co/15x15/FFFFFF/FFFFFF.png) #FFFFFFFF |
57+
| secondaryLabel | ![#EBEBF599](https://placehold.co/15x15/EBEBF5/EBEBF5.png) #EBEBF599 |
58+
| tertiaryLabel | ![#EBEBF54D](https://placehold.co/15x15/EBEBF5/EBEBF5.png) #EBEBF54D |
59+
| quaternaryLabel | ![#EBEBF52E](https://placehold.co/15x15/EBEBF5/EBEBF5.png) #EBEBF52E |
60+
| highlightLabel | ![#0A84FFFF](https://placehold.co/15x15/0A84FF/0A84FF.png) #0A84FFFF |
61+
| highlightNegativeLabel | ![#FF453AFF](https://placehold.co/15x15/FF453A/FF453A.png) #FF453AFF |
62+
63+
## Demo
64+
65+
in progress
66+

0 commit comments

Comments
 (0)