Skip to content

Commit f7b57b0

Browse files
committed
Update ReadME
1 parent 1576a5f commit f7b57b0

File tree

3 files changed

+56
-22
lines changed

3 files changed

+56
-22
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2024 [Cuboid Inc.] ([email protected])
3+
Copyright (c) 2024 Cuboid Inc. ([email protected])
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 54 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Open Mail App Flutter ![Flutter 3.24.4](https://img.shields.io/badge/Flutter-3.24.4-blue)
1+
# Open Mail
2+
3+
![Flutter 3.24.4](https://img.shields.io/badge/Flutter-3.24.4-blue)
24
[![pub package](https://img.shields.io/pub/v/open_mail.svg?label=open_mail&color=blue)](https://pub.dev/packages/open_mail)
35

46
### Open Mail is a Flutter package designed to simplify the process of querying installed email apps on a device and allowing users to open the email app of their choice.
@@ -7,20 +9,28 @@ This package is especially useful for developers who want to provide users with
79

810
If you just want to compose an email or open any app with a `mailto:` link, you are looking for [url_launcher](https://pub.dev/packages/url_launcher).
911

10-
## Why Use Open Mail?
12+
This Flutter package allows users to open their installed mail app effortlessly. It draws inspiration from similar packages, particularly [open_mail_app](https://pub.dev/packages/open_mail_app), and builds upon that foundation to provide an improved and streamlined experience.
1113

12-
• url_launcher allows you to open mailto: links but does not let you:
13-
• Choose a specific email app.
14-
• Query the list of available email apps.
15-
• On iOS, url_launcher will always open the default Mail app, even if the user prefers another app like Gmail or Outlook.
16-
• With Open Mail, you can:
17-
• Identify all installed email apps.
18-
• Allow users to select their preferred email app (if multiple options are available).
14+
## Why Use Open Mail?
1915

16+
- `url_launcher` allows you to open `mailto:` links but does not let you:
17+
- Choose a specific email app.
18+
- Query the list of available email apps.
19+
- On iOS, `url_launcher` will always open the default **Mail App**, even if the user prefers another app like Gmail or Outlook.
20+
- With **Open Mail**, you can:
21+
- Identify all installed email apps.
22+
- Allow users to select their preferred email app (if multiple options are available).
2023

2124
## Setup
25+
26+
### Android
27+
28+
No additional configuration is required for Android. The package works out of the box.
29+
2230
### iOS Configuration
31+
2332
For iOS, you need to list the URL schemes of the email apps you want to query in your `Info.plist` file. Add the following code:
33+
2434
```
2535
<key>LSApplicationQueriesSchemes</key>
2636
<array>
@@ -37,15 +47,19 @@ For iOS, you need to list the URL schemes of the email apps you want to query in
3747
```
3848

3949
Feel free to file an issue on GitHub for adding more popular email apps you would like to see supported. These apps must be added to both your app’s `Info.plist` and the source code of this library.
40-
Please file issues to add popular email apps you would like to see on iOS. They need to be added to both your app's `Info.plist` and in the source of this library.
50+
Please file issues to add popular email apps you would like to see on iOS. They need to be added to both your app's `Info.plist` and in the source of this library.
51+
4152
## Installation
53+
4254
Add the following to your `pubspec.yaml`:
55+
4356
```
4457
dependencies:
4558
open_mail: latest_version
4659
```
4760

4861
Then, run the following command:
62+
4963
```
5064
flutter pub get
5165
```
@@ -122,17 +136,37 @@ class MyApp extends StatelessWidget {
122136
```
123137

124138
## Key Features
125-
1. ### Detect Installed Email Apps
126-
• Automatically identifies email apps installed on the device.
127-
2. ### Open Specific Email App
128-
• Open a specific app based on user selection or app configuration.
129-
3. ### Native Dialog Support
130-
• On iOS, displays a dialog to let users pick their preferred app when multiple apps are installed.
139+
140+
1. Detect Installed Email Apps
141+
142+
- Automatically identifies email apps installed on the device.
143+
144+
2. Open Specific Email App
145+
146+
- Open a specific app based on user selection or app configuration.
147+
148+
3. Native Dialog Support
149+
150+
- On iOS, displays a dialog to let users pick their preferred app when multiple apps are installed.
131151

132152
## Support
133-
Feel free to file issues on the GitHub repository for:
134-
• Adding support for additional email apps.
135-
• Reporting bugs or suggesting improvements.
153+
154+
Feel free to file issues on the [GitHub](https://github.com/Cuboid-Inc/open_mail) repository for:
155+
156+
- Adding support for additional email apps.
157+
- Reporting bugs or suggesting improvements.
158+
159+
## Contributors
160+
161+
<table>
162+
<tr>
163+
<td align="center"><a href="https://github.com/mrcse"><img src="https://avatars.githubusercontent.com/u/73348512?v=4" width="100px;" alt=""/><br /><sub><b>Jamshid Ali</b></sub></a><br /><a href="https://github.com/mrcse" title="Code">💻</a></td>
164+
<td align="center"><a href="https://github.com/Mubashir-Saeed1"><img src="https://avatars.githubusercontent.com/u/58908265?v=4" width="100px;" alt=""/><br /><sub><b>Mubashir Saeed</b></sub></a><br />
165+
<a href="https://github.com/Mubashir-Saeed1" title="Code">💻</a></td>
166+
167+
</tr>
168+
</table>
136169

137170
## License
138-
This package is distributed under the MIT License. See the LICENSE file for details.
171+
172+
This package is distributed under the MIT License. See the [LICENSE](https://raw.githubusercontent.com/Cuboid-Inc/open_mail/main/LICENSE) file for details.

pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: open_mail
22
description: A Flutter package to query the device for installed email apps and open them programmatically.
3-
version: 0.0.1
3+
version: 0.0.4
44
homepage: https://github.com/Cuboid-Inc/open_mail
55
repository: https://github.com/Cuboid-Inc/open_mail
66

0 commit comments

Comments
 (0)