Skip to content

Commit

Permalink
Merge pull request AY2324S2-CS2103T-T12-1#73 from Teee728/Update-UG-D…
Browse files Browse the repository at this point in the history
…G-for-mail-feature

Update UG, DG and add sequence diagram for mail feature
  • Loading branch information
Teeesa7 authored Mar 21, 2024
2 parents 7e165c7 + d682837 commit a5fb68f
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,14 @@ the command is executed:
* The history size could be made to be configurable by the user.
* The history could be saved to disk so that it persists between app launches.

### Send email directly feature

The following sequence diagram shows what happens as the user double clicks on the email address
<puml src="diagrams/SendEmailSequenceDiagram.puml" alt="Sequence Diagram for sending an email" />

#### Possible enhancements
* There can be a feature where multiple emails can be selected to send a mass email to them.

### \[Proposed\] Undo/redo feature

#### Proposed Implementation
Expand Down
1 change: 1 addition & 0 deletions docs/diagrams/ModelClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Class Address
Class Email
Class Name
Class Phone
Class GitHubUsername
Class Tag
Class TechStack

Expand Down
17 changes: 17 additions & 0 deletions docs/diagrams/SendEmailSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
@startuml
actor User
participant "ContactList View" as ContactListView
participant "MailApp" as MailApp
participant "Mail Application" as MailApplication

User -> ContactListView : Clicks on email address
activate ContactListView
ContactListView -> MailApp : handleEmailClicked()
activate MailApp
MailApp -> MailApplication : openDefaultMailApp(email)
activate MailApplication
MailApplication --> User : Mail application opens with selected email
deactivate MailApplication
deactivate MailApp
deactivate ContactListView
@enduml

0 comments on commit a5fb68f

Please sign in to comment.