ctrl+shift+p filters: :st2 :st3 :win :osx :linux


by divinites ST3

A light-weight email agent for Sublime Text 3



  • Total 652
  • Win 344
  • Mac 184
  • Linux 124
May 26 May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1 Apr 30 Apr 29 Apr 28 Apr 27 Apr 26 Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12
Windows 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Mac 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0




I developed this plug-in because I sometimes want to send directly what I wrote in sublime text, and I do not want to enter my password every time or store my plain-text email account name and password somewhere. That's why I choose to support oauthv2. With oauth method, the password will not be leaked to the third party, so it is basically safer. Nevertheless, there are still potential risks that other malicious plug-ins (if any) will get the cached “access_token” and obtain the access privileges that you grant to sublime text editor. All in all, Use this plug-in at your own risk, the author will not take any responsibility for any loss.

Set-up steps:

Currently, Gmail supports Microsoft outlook.com (including hotmail, livemail, etc.) and gmail and most of standard IMAP/SMTP mail servers.

GMail supports two authentication methods: oauth authentication and password authentication.

The setting template is

Preference -> Package Settings -> GMail -> Mail settings - Default

you should copy it and paste to

Preference -> Package Settings -> GMail -> Mail settings - User

to configure your own mail settings.

For Oauth Authentication (No password needed, much safer)

Gmail Settings:

Gmail setup is quite simple,

  1. Go to Google dev centre, create a project. Here is a nice tutorial if you are not familiar with that How to obtain Google Client ID and Secret.

Now, you have a client ID and Client Secret, copy and paste them into the Mail settings - User and it simply works.

Google also provide a downloadable json-format configuration file (including client_id, client_secret, auth_uri and etc.). If you prefer to use this, you can download it and copy the full path, create an entry “client_secret_file” just before “client_id”, and paste the path of your downloaded configuration file. It should also do the job.

Microsoft Mail settings:

  1. go to microsoft dev centre, create an application.

  2. In the API settings, you will find your client_id and client_secret, fill in the scope with ** wl.imap**, choose no for mobile client.

  3. Microsoft's policy about the redirect URI is quite tricky, it must be in the form http://www.xxx.com:[port], so in the current version, I hard code http://www.mylocalhost.com:10111 as the default redirect url, please fill in the API settings as well. in the future version, I will add an option entry so that users can choose there preferred names in mail.sublime-settings.

  4. modify your host file: for osx users, it is /etc/host, add a new line www.mylocalhost.com at the end.

Password Method

If oauth method does not work for you, or you want to use email other than gmail and microsoft mail, you can use password Method.

First, add an entry “authentication”: “password” in QuickMail.sublime-settings, and do not forget entering the correct imap/smtp server.

The first time you using this email, an input panel will show up and sequentially ask you to input your username and password. Input it in 10 second, and that's all. Username and password will be cached so you do not need to enter it again. (I will add an option to let you decide whether username and password should be cached or not)


  • write_mail: do exactly as the command name describes, this command will open a new view
  • send_mail: do exactly as the command name, describes, this command will send the mail you write
  • send_as_mail: this command will add email header on top of all the content in current view
  • show_mail_list: this command will show a panel, you can choose which mailbox to open, the default mailbox will be listed on the top.
  • show_mail: it would be better to use it after showing mail list, since this command with show an input panel, you can enter the mail ID (listed by show_mail_list command) and a new view will open and show your mail content.

That's it. In the first time you use this plug-in, it will redirect your an authorization page, where you can click “yes” for authorization, after you see the page “the authentication flow has completed”, you can close that page and return to Sublime Text. In the next time and what so ever, you can instantly send emails without any additional step, since the program will automatically deal with everything and refresh the access_token when necessary.

Future Development:

  1. This project is still in a very early stage, now it supports sending and receiving mails via Outlook mails and Gmails. You are welcome to send me request about more email server support, or, send me a pull request.

  2. Enhancement:

    • Adding signature support
    • Adding IMAP support, so users will be able to receive recent emails
    • Adding reply, reply_all and forwarding command
    • Using tmLanguage to define different colors when displaying email list
    • Use Up-Down Arrow keys to browse mail list and Right arrow key to read email
    • fold, not cut over-long title in the mail list
    • Add a panel for mailbox selection

I have no intention to make it a full functional email agent with complicated rules, since we already have so many excellent programs. I will keep it light-weight, only necessary functions will be added.

Change Logs:

  • v. 0.1.1 The first commitment
  • v. 0.2.0 re-write using oauthmail API
  • v. 0.3.0 IMAP fully worked
  • v. 0.3.1 minor changes
  • v. 0.3.5 correct some minor errors
  • v. 0.4.0 add YAML support (still working on it)
  • v. 0.4.1 accepted by package control channel
  • v. 0.6.6 reconstruct the code and support username/password authentication
  • v. 0.8.0 add tmLanguage to color mail list
  • v. 0.8.5 a bunch of improvement
    • add reply, reply all, forward command
    • add a panel for mailbox selection
    • Email address are divided into two lines.
    • Mail will not initialize a new IMAP connection everytime, it will reuse the active connection if possible.


Special thanks to klorenz's project sublime-email and many stack-overflow answers.