Skip to content

Latest commit

 

History

History
178 lines (123 loc) · 5.38 KB

README.md

File metadata and controls

178 lines (123 loc) · 5.38 KB
Raw

Prospect Mail

logo

Build & Release Latest release GitHub all releases

Unofficial email Outlook client using Electron. It uses the Web App 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 here.

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.

Get it from the Snap Store

Or use sudo snap install prospect-mail from the terminal.

Arch Linux has a community published artifact available in AUR here.

For other distributions please follow your specific steps.

Screenshots

screenshot-linux

screenshot-calendar-view

Features

  • Receive your Outlook Microsoft 365 online 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

Settings

Via tray menu settings.json can be opened and edited. After every save you need to click in "Reload settings" to apply changes.

{
 "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 for personal accounts.

{
  "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:

Build

Clone the repository and run in development mode. (You need to have git , node and yarn) installed)

git clone https://github.com/julian-alarcon/prospect-mail.git
cd prospect-mail
yarn
yarn start

Build the application for linux

yarn run 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:

yarn dist:linux:snap

Build the application for Mac (It works in versions 10.14 and 10.15)

yarn dist:mac

Build it for windows:

yarn dist:windows

Install developer artifact

Once it was builded, or using the release files available, you can install the files using AppImage process, using .deb sudo dpkg -i prospect-mail_x.y.z_arch.deb or using the snap file sudo snap install prospect-mail_x.y.z_arch.snap --dangerous.

Release to Public

With the specific permissions on Github, to create a new release follow the steps defined by action-electron-builder

  1. Open Pull Request for new version
  2. Define version in package.json. E.g. 1.0.0-beta2

Manual release to Snapstore

snapcraft login
snapcraft upload --release=edge prospect-mail_x.y.z_arch.snap

License

MIT by Julian Alarcon based on electron-outlook by Howard J