https://github.com/julian-alarcon/prospect-mail
Prospect is an Outlook mail desktop client powered by Electron
https://github.com/julian-alarcon/prospect-mail
electron hacktoberfest linux macos microsoft365 office365 outlook outlook-desktop-client
Last synced: 5 months ago
JSON representation
Prospect is an Outlook mail desktop client powered by Electron
- Host: GitHub
- URL: https://github.com/julian-alarcon/prospect-mail
- Owner: julian-alarcon
- License: mit
- Created: 2019-05-20T18:42:22.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T09:50:35.000Z (almost 2 years ago)
- Last Synced: 2025-03-29T02:01:38.686Z (about 1 year ago)
- Topics: electron, hacktoberfest, linux, macos, microsoft365, office365, outlook, outlook-desktop-client
- Language: JavaScript
- Homepage:
- Size: 3.95 MB
- Stars: 474
- Watchers: 11
- Forks: 67
- Open Issues: 58
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- Awesome - Prospect Mail client - Prospect is an Outlook mail desktop client powered by Electron. (Communication and Collaboration Tools / E-mail)
README
# Prospect Mail
[](https://github.com/julian-alarcon/prospect-mail/actions/workflows/build-release.yml)
[](https://github.com/julian-alarcon/prospect-mail/releases/latest)
[](https://github.com/julian-alarcon/prospect-mail/releases)
Unofficial email Outlook client using Electron. It uses the
[Web App](https://www.microsoft.com/en-us/microsoft-365/outlook/web-email-login-for-outlook)
and wraps it as a standalone application using Electron. This only works for
Microsoft/Office 365 accounts, don't use it for personal Outlook.com accounts.
Available for Linux, Windows (10+) and macOS.
> This project has NO DIRECT AFFILIATION with Microsoft, Microsoft 365 or any
> product made by Microsoft.
## Download
The application can be downloaded from [release page](https://github.com/julian-alarcon/prospect-mail/releases).
Select the appropriated file depending on your OS:
- Windows: `.exe` file or `.msi` file
- macOS: `.dmg` file
- Linux: Multiple artifacts are available, please choose your needed one
(`AppImage`, `deb`, `pacman`, `rpm`, `snap`, `tar.gz`) depending on your Linux
Distribution.
## Installation
### Windows
Just double-click and follow the Installer steps.
### macOS
Double-click the `dmg` file and drag the blue Prospect Mail icon to the App
folder
### Linux
Snap builds are available in the Snap Store.
[](https://snapcraft.io/prospect-mail)
Or use `sudo snap install prospect-mail` from the terminal.
Arch Linux has a community published artifact available in
[AUR here](https://aur.archlinux.org/packages/prospect-mail-bin/).
For other distributions please follow your specific steps.
## Screenshots
## Features
- Check your Outlook Microsoft 365 emails/calendar from the desktop app
- Close to minimize
- Start as minimized (you can use the Option in the Tray icon menu or start app
with `prospect-mail --minimized`)
- Dock tray support
- System notification
- Connect to standard or custom Outlook URL
- Spellcheck using native Outlook MS Editor
- Visualize files (pdf) in emails
## Settings
Via tray menu `settings.json` can be opened and edited. After every save you
need to click in "Reload settings" to apply changes.
```json
{
"mainMailServiceUrl":"https://customurl.example/",
"deeplinkUrls":["customurl.example"],
"mailServicesUrls":["mailServicesUrls.example"],
"safelinksUrls": ["safelinksUrls.example"],
"showWindowFrame":true
}
```
As an example, this configuration will let you use Prospect with personal
Outlook.com account:
> Please notice that Prospect Mail is only tested in Work/Educational accounts
> and no issues will be reviewed on use for personal accounts.
```json
{
"mainMailServiceUrl": "https://login.live.com/login.srf",
"deeplinkUrls": ["outlook.com", "live.com"],
"mailServicesUrls": ["outlook.com", "live.com"]
}
```
### Architecture components
The main software architecture components and their versions are this:
- [Node.js](https://nodejs.org/en/about/previous-releases#release-schedule)
version: 22.x LTS
- [yarn](https://classic.yarnpkg.com/en/docs) [version: 1.x](https://www.electron.build/index.html#installation)
- [electron](https://www.electronjs.org/docs/latest/tutorial/electron-timelines)
version: 39.x
- [electron-builder](https://www.electron.build/) version: 26.x
- [electron-settings](https://github.com/nathanbuchar/electron-settings)
version: 4.0.4
## Build
Clone the repository and run in development mode.
(You need to have [git](https://git-scm.com/), node and yarn installed)
```shell
git clone https://github.com/julian-alarcon/prospect-mail.git
cd prospect-mail
yarn
yarn start
```
**Note:** If you encounter a sandbox error on Linux, run:
`ELECTRON_DISABLE_SANDBOX=1 yarn start`. See
[CONTRIBUTING.md](CONTRIBUTING.md#troubleshooting-sandbox-issues) for details.
Build the application for Linux
```shell
yarn dist:linux
```
This will build an AppImage, deb and snap files in the dist folder. This files
can be run in most popular Linux distributions.
Is possible to specify the snap or AppImage build type using running this:
```shell
yarn dist:linux:snap
```
Build the application for Mac (It works in versions 10.14 and 10.15)
```shell
yarn dist:mac
```
Build it for windows:
```shell
yarn dist:windows
```
### Install developer artifact
Once it has been built, or using the release files available, you can install the
files using [AppImage process](https://docs.appimage.org/user-guide/faq.html#question-how-do-i-run-an-appimage),
using .deb `sudo dpkg -i prospect-mail_x.y.z_arch.deb` or using the snap
file `sudo snap install dist/prospect-mail_x.y.z_arch.snap --dangerous`.
## Contributing
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for
guidelines on how to contribute to this project, including development setup,
coding standards, and the release process.
## License
[MIT](https://github.com/julian-alarcon/prospect-mail/blob/master/LICENSE) by
[Julian Alarcon](https://desentropia.com) based on
[electron-outlook](https://github.com/eNkru/electron-outlook) by
[Howard J](https://enkru.github.io/)