This repository is only a mirror, all developpment happens at gitlab

Readme

Anounces

• Since v1.0.0 the g:VimMailSendCmd has been replaced by a couple of more flexible configuration options, see Sending mails

• Since v0.3.2 it is possible to change the flags used for sendmail depending on the current filetype see Mail client

• v0.3 provides the possibility to set startflags depending on the contents of the mail, see issue #6 and start position.

• v0.2.9 adds a mapping to switch from address from a predefined list see switch from.

• Since v0.2.7 Vim-mail can handle (virtually) any contact providers, this implies a few configuration changes.

see contacts completion and Address book configuration and maybe Adding a contact provider.

What is this plugin ?

This plugin is a small helper for writing mail from vim, I designed it using mutt but it should work with other clients. I recommend to use it in combination with CheckAttach.

Install

Vizardry

If you have Vizardry installed, you can run from vim:

:Invoke -u dbeniamine vim-mail

Pathogen install

git clone https://github.com/dbeniamine/vim-mail.git ~/.vim/bundle/vim-mail

Quick install

git clone https://github.com/dbeniamine/vim-mail.git
cd vim-mail/
cp -r ./* ~/.vim

Features

This plugin provides the following features

Contact completion

The following providers are currently supported :

• pc_query (pycard)
• khard
• mu (maildir-utils, requires specific configuration)

see address book configuration and Adding a contact provider.

To search your address book from vim:

• While writing a mail, in insert mode, type:

  <LocalLeader>a
  

  or (using omnifunc)

  <C-X><C-O>
  

• While editing any other file:

  As the previous mapping are only set for mail files, you need to set the completefunc (using omnifunc would be a bad idea):

  set completefunc=vimmail#contacts#CompleteAddr
  

  Then use <C-X><C-U> (in insert mode) to trigger contact completion.

It will search for the word under the cursor in your contact list.

If you are currently in a From,To,CC or Bcc line, only mail addresses will be proposed, else all the match will appear. More details will appear in the preview window including contact name, type of the entry (mail, cell, phone etc.).

To synchronise your address book, in a mail, in normal mode, type:

<LocalLeader>a

Redaction

Cursor initial position

By default vim-mail place your cursor at the beginning of the mail (right after the headers) adds a blank line and switch to insert mode. This behavior can be modified through a series of flags:

The available flags are:

Flag	Meaning
r	Remove quoted signatures from reply
i	insert mode
o	Add new line after cursor
O	Add new line before cursor
A	Place cursor at the end of the line
W	Start on second word (a.k.a first address of field / word of subject)
I	Intelligent start: If two replies, start above or below, as the last replier, else default to other flags
t	top (Right after headers)
b	Bottom (After last message)
F	From field
T	To field
C	Cc field
B	Bcc field
S	Subject field

The flags can be set globally or by type of mail using the variable VimMail detects 4 types of mail :

Type	When
blank	To: field is empty
nosubject	To: field is not empty but Subject: is
new	Neither To: or Subject: is empty and there is no quote
reply	Neither To: or Subject: is empty and there is a quote

Examples

Adding the following line to your vimrc will make you start at the end of the subject line when subject is empy:

    let g:VimMailStartFlags={'nosubject' :"SAi" }

You can do somthing more complex for instance :

    let g:VimMailStartFlags={
        \'blank': 'TAi',
        \'nosubject': 'SAi',
        \'default' : "boi"}

Notes:

• default key is special, in the above case it means either new or reply.
• For retro compatibility with version 0.2.x, let g:VimMailStartFlags='toi' is the same as let g:VimMailStartFlags = { 'default': 'toi'}.

Easy spelllang switch

While writing mails, I often need to do switch the spell lang which can be annoying, so this plugin provide an easy way to do it. Just type:

<LocalLeader>l

and the plugin will switch the spelllang using a list of allowed languages.
If the current spellang is the last allowed, it will disable spell, hit

<LocalLeader>l

once more and you will restart with the first lang. You can set the list of allowed langs in your vimrc:

let g:VimMailSpellLangs=['fr', 'en', 'sp']

The default langs are french, english.

This will work for any filetype as it can be usefull for many other kind of files.

Switch from

You can easliy from address just by hitting <localleader>F. By default vimmal will search the email addresses for a contact with the same full name as your unix user. You can also specify a contact (or a search string) with by adding the following to your vimrc :

let g:VimMailFromContact="John doe"

or directly specify a list of addresses :

let g:VimMailFromList = [
    \'John doe <John@doe.foo>',
    \'Ano nymous <ano@nymous.org'
    \]

Messages folds

A folding method which allows you to open are close the messages of the conversation is provided.

Quick in-mail navigation

With this plugin, you can easily navigate through the different par of the mail using the following mappings:

• Headers

  Mapping	Effect
  <LocalLeader>f	Go to the From field
  <LocalLeader>b	Go to the Bcc field
  <LocalLeader>c	Go to the Cc field
  <LocalLeader>s	Go to the SUbject field
  <LocalLeader>R	Go to the Reply-To field
  <LocalLeader>t	Go to the Reply-To field

• Conversation

  Mapping	Effect
  <LocalLeader>B	Go to the first line (after headers)
  <LocalLeader>E	Go to the first line after the conversation
  <LocalLeader>r	Go to the first message of the conversation
  <LocalLeader>r2	Go to the second message of the conversation
  <LocalLeader>r3	Go to the third message of the conversation
  <LocalLeader>r4	Go to the fourth message of the conversation
  <LocalLeader>S	Go to your signature

Launch mail client

One of Mutt main drawbacks is that you can't access your mailbox while writing mails, good news everyone, with vim-mail you can open mutt in RO mode easily by typing

<LocalLeader>M

Send file from Vim

When you are vimming at one point, you might want to send the file you are working on. Leaving vim to send a mail from vim is so annoying, happily there is the solution just type: <LocalLeader>m and VimMail will pipe the file to mutt.

Mappings

All mappings can be disabled by adding the following line to your vimrc:

let g:VimMailDoNotMap=1

• On any file

  Mapping	Effect
  <LocalLeader>m	Send the current buffer
  <LocalLeader>l	Switch spelllang
  <LocalLeader>M	Open the mail client

• On mail only

  Mapping	Effect
  <Localleader>a	Search the word before cursor as a contact
  <LocalLeader>F	Switch From address
  <LocalLeader>f	Go to the From field
  <LocalLeader>b	Go to the Bcc field
  <LocalLeader>c	Go to the Cc field
  <LocalLeader>s	Go to the SUbject field
  <LocalLeader>R	Go to the Reply-To field
  <LocalLeader>t	Go to the Reply-To field
  <LocalLeader>r	Go to the first message of the conversation
  <LocalLeader>r2	Go to the second message of the conversation
  <LocalLeader>r3	Go to the third message of the conversation
  <LocalLeader>r4	Go to the fourth message of the conversation
  <LocalLeader>S	Go to your signature

CONFIGURATION

`<LocalLeader>kqs` | Kill Quoted Signatures

Address book configuration

The following providers are currently supported :

• pc_query (pycard)
• khard
• mu (maildir-utils, requires specific configuration)

You can set one or several providers using:

let g:VimMailContactsProvider=['pc_query', 'mu']

You can also change query and sync commandsby adding the following to your vimrc (adapting the commands) :

if(!exists("g:VimMailContactsCommands"))
    let g:VimMailContactsCommands = {}
endif
let g:VimMailContactsCommands['pc_query']={ 'query' : "pc_query",
            \'sync': "pycardsyncer"}

If you don't see the preview while using contact completion, add the following to your vimrc (see |completeopt| |preview| ):

set completeopt=preview

If you don't want this completion you can either not use the plugin or add the following line to your vimrc:

let g:VimMailDontUseComplete=1

By default, the contact completion appends the query to the result list, you can disable this feature:

let g:VimMailDoNotAppendQueryToResults

Mu configuration

Mu stores an email index by account, to use mu contact completion, you need to tel for each email address two settings :

• the mu home (where mu index is stored)
• the maildir directorory (where the emails are stored, only if you want to be able to sync contacts)

This can be done via the g:VimMailContactsCommands dictionnary, there is an example :

let g:VimMailContactsCommands={'mu' :
        \{ 'query' : "mu cfind",
            \'sync': "mu index",
            \'config': {
                \'sommeaddr': {
                    \'home': '$HOME/mu/someaccount',
                    \'maildir': '$HOME/mail/someaccount',
                \},
                \'default': {
                    \'home': '$HOME/mu/otheraccount',
                    \'maildir': '$HOME/mail/otheraccount',
                \}
            \}
        \}
    \}

Spell

Setting the list of possible spell langs:

let g:VimMailSpellLangs=['fr', 'en', 'sp']

Folds

To disable message folds, add the following line to your vimrc:

let g:VimMailDoNotFold=1

Mail Client

Launching mail client

You can set the mail client command to your launcher script by adding to your vimrc something like:

let g:VimMailClient="/path/to/your/launcher"

Sending mails

By default, this plugin searches for neomutt and mutt as client and treats the file as attachment to the mail unless it has filetype mail, in which case it uses the file as a draft.

This behavior can be customized with the following variables, where the example shows the default values:

" If does not exist then neomutt or mutt is used
let g:VimMailBin="..."
" Arguments to g:VimMailBin specific to the filetype
let g:VimMailArgsByFiletype={"mail" : "-H %"}
" Arguments to g:VimMailBin if filetype is not known to g:VimMailArgsByFiletype
let g:VimMailArgsDefault="-a %"

If you run traditional vim then the mail program is launched by :!, but on neovim and gvim it is launched by :terminal. (Note that neovim has no interactive :! and gvim has troubles displaying mutt via :!.) However, you can overrule this behavior by simply setting g:VimMailUseTerminal.

The following settings could be used for thunderbird as mail client:

let g:VimMailBin="thunderbird"
let g:VimMailArgsDefault="-compose attachment=%:p"
let g:VimMailArgsByFiletype={"mail" : "-compose \"body=`cat %:p`\""}
let g:VimMailUseTerminal=0

Adding a contact provider

Adding a contact provider is now a simple task for anyone who already wrote some vimscript. To add a provider for the command my_abook, one needs to

1. Copy autoload/vimmail/contacts/pc_query.vim to autoload/vimmail/contacts/my_abook.vim
2. Rename the functions replacing pc_query by my_abook
3. Same for the dictionnary at the beginnig
4. Adapts both functions
   • To write the complete function see :help completefunc, it should return a list of results, each results being a dictionnaty, containing :
     • word : the replacement to write
     • kind : the kind of result itis (M mail, C for T for Telephone)
     • menu : a bit more info like cell, work, personnal
     • abbr for email adresses, only the email (instead of first last <email>)
     • info : supplementary field info (usually the name of the contact and the full line of the provider command)
   • The sync function is trivial

License

This plugin is distributed under GPL Licence v3.0, see https://www.gnu.org/licenses/gpl.txt