[PATCH] cli: add a tool for starting new message in the emacs ui

[Tomi Ollila]

On Sun, Jan 18 2015, David Bremner <david at tethera.net> wrote:

> From: Jani Nikula <jani at nikula.org>
>
> Add a tool to start composing an email in the Notmuch Emacs UI with
> the specified subject, recipients, and message body.
> ---
>
> This version fixes my complaint about the previous version not
> starting emacs.  It does this by starting a new "frame", either at the
> window system level, or in the current terminal.  The traditional
> "-nw" short form of the argument "--no-window-system" seems maybe more
> work to parse than it's worth.

Well, id:1405026779-29966-1-git-send-email-tomi.ollila at iki.fi (*) had -nw
parsing, but I can live without...

But more than that one important feature has to be agreed before initial
interface is locked down -- how to provide body content from command line
without resorting to temporary files. In (*) --body was adding those lines
instead of reading file and I later suggested that --include or --insert
could do the same as -i ... but I am open to any solution that gives me
opportunity to provide body *content* from command line.

Tomi

>
>  doc/conf.py                    |   4 ++
>  doc/man1/notmuch-emacs-mua.rst |  53 ++++++++++++++++++
>  notmuch-emacs-mua              | 122 +++++++++++++++++++++++++++++++++++++++++
>  3 files changed, 179 insertions(+)
>  create mode 100644 doc/man1/notmuch-emacs-mua.rst
>  create mode 100755 notmuch-emacs-mua
>
> diff --git a/doc/conf.py b/doc/conf.py
> index fb49f6e..8fbc854 100644
> --- a/doc/conf.py
> +++ b/doc/conf.py
> @@ -78,6 +78,10 @@ man_pages = [
>          u'creates a plain-text dump of the tags of each message',
>          [u'Carl Worth and many others'], 1),
>  
> +('man1/notmuch-emacs-mua','notmuch-emacs-mua',
> +        u'send mail with notmuch and emacs',
> +        [u'Carl Worth and many others'], 1),
> +
>  ('man5/notmuch-hooks','notmuch-hooks',
>          u'hooks for notmuch',
>          [u'Carl Worth and many others'], 5),
> diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst
> new file mode 100644
> index 0000000..bf8c3aa
> --- /dev/null
> +++ b/doc/man1/notmuch-emacs-mua.rst
> @@ -0,0 +1,53 @@
> +=================
> +notmuch-emacs-mua
> +=================
> +
> +SYNOPSIS
> +========
> +
> +**notmuch-emacs-mua** [options ...] [<to-address> ...]
> +
> +DESCRIPTION
> +===========
> +
> +Start composing an email in the Notmuch Emacs UI with the specified
> +subject, recipients, and message body.
> +
> +For **notmuch-emacs-mua** to work, you need **emacsclient** and an
> +already running Emacs with a server.
> +
> +Supported options for **notmuch-emacs-mua** include
> +
> +    ``-h, --help``
> +        Display help.
> +
> +    ``-s, --subject=``\ <subject>
> +        Specify the subject of the message.
> +
> +    ``--to=``\ <to-address>
> +        Specify a recipient (To).
> +
> +    ``-c, --cc=``\ <cc-address>
> +        Specify a carbon-copy (Cc) recipient.
> +
> +    ``-b, --bcc=``\ <bcc-address>
> +        Specify a blind-carbon-copy (Bcc) recipient.
> +
> +    ``-i, --body=``\ <file>
> +        Specify a file to include into the body of the message.
> +
> +    ``--no-window-system``
> +        Even if a window system is available, use the current terminal
> +
> +    ``--print``
> +        Output the resulting elisp to stdout instead of evaluating it.
> +
> +The supported positional parameters and short options are a compatible
> +subset of the **mutt** MUA command-line options.
> +
> +Options may be specified multiple times.
> +
> +SEE ALSO
> +========
> +
> +**notmuch(1)**, **emacsclient(1)**, **mutt(1)**
> diff --git a/notmuch-emacs-mua b/notmuch-emacs-mua
> new file mode 100755
> index 0000000..fdf4024
> --- /dev/null
> +++ b/notmuch-emacs-mua
> @@ -0,0 +1,122 @@
> +#!/usr/bin/env bash
> +#
> +# notmuch-emacs-mua - start composing a mail on the command line
> +#
> +# Copyright © 2014 Jani Nikula
> +#
> +# This program is free software: you can redistribute it and/or modify
> +# it under the terms of the GNU General Public License as published by
> +# the Free Software Foundation, either version 3 of the License, or
> +# (at your option) any later version.
> +#
> +# This program is distributed in the hope that it will be useful,
> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
> +# GNU General Public License for more details.
> +#
> +# You should have received a copy of the GNU General Public License
> +# along with this program.  If not, see http://www.gnu.org/licenses/ .
> +#
> +# Authors: Jani Nikula <jani at nikula.org>
> +#
> +
> +set -eu
> +
> +escape ()
> +{
> +    echo "${1//\"/\\\"}"
> +}
> +
> +PRINT_ONLY=
> +CLIENT_TYPE="-c"
> +
> +# The crux of it all: construct an elisp progn and eval it.
> +ELISP="(prog1 'done (require 'notmuch) (notmuch-mua-new-mail)"
> +
> +while getopts :s:c:b:i:h opt; do
> +    # Handle errors and long options.
> +    case "${opt}" in
> +	:)
> +	    echo "$0: short option -${OPTARG} requires an argument." >&2
> +	    exit 1
> +	    ;;
> +	\?)
> +	    opt=$1
> +	    if [ "${OPTARG}" != "-" ]; then
> +		echo "$0: unknown short option -${OPTARG}." >&2
> +		exit 1
> +	    fi
> +
> +	    case "${opt}" in
> +		# Long options with arguments.
> +		--subject=*|--to=*|--cc=*|--bcc=*|--body=*)
> +		    OPTARG=${opt#--*=}
> +		    opt=${opt%%=*}
> +		    ;;
> +		# Long options without arguments.
> +		--help|--print|--no-window-system)
> +		    ;;
> +		*)
> +		    echo "$0: unknown long option ${opt}, or argument mismatch." >&2
> +		    exit 1
> +		    ;;
> +	    esac
> +	    # getopts does not do this for what it considers errors.
> +	    OPTIND=$((OPTIND + 1))
> +	    ;;
> +    esac
> +
> +    OPTARG="$(escape "${OPTARG}")"
> +
> +    case "${opt}" in
> +	--help|h)
> +	    exec man notmuch-emacs-mua
> +	    ;;
> +	--subject|s)
> +	    ELISP="${ELISP} (message-goto-subject) (insert \"${OPTARG}\")"
> +	    ;;
> +	--to)
> +	    ELISP="${ELISP} (message-goto-to) (insert \"${OPTARG}, \")"
> +	    ;;
> +	--cc|c)
> +	    ELISP="${ELISP} (message-goto-cc) (insert \"${OPTARG}, \")"
> +	    ;;
> +	--bcc|b)
> +	    ELISP="${ELISP} (message-goto-bcc) (insert \"${OPTARG}, \")"
> +	    ;;
> +	--body|i)
> +	    ELISP="${ELISP} (message-goto-body) (cd \"${PWD}\") (insert-file \"${OPTARG}\")"
> +	    ;;
> +	--print)
> +	    PRINT_ONLY=1
> +	    ;;
> +	--no-window-system)
> +	    CLIENT_TYPE="-t"
> +	    ;;
> +	*)
> +	    # We should never end up here.
> +	    echo "$0: internal error (option ${opt})." >&2
> +	    exit 1
> +	    ;;
> +    esac
> +
> +    shift $((OPTIND - 1))
> +    OPTIND=1
> +done
> +
> +# Positional parameters.
> +for arg; do
> +    arg="$(escape "${arg}")"
> +    ELISP="${ELISP} (message-goto-to) (insert \"${arg}, \")"
> +done
> +
> +# End progn.
> +ELISP="${ELISP})"
> +
> +if [ -n "$PRINT_ONLY" ]; then
> +    echo ${ELISP}
> +    exit 0
> +fi
> +
> +# Evaluate the progn.
> +exec emacsclient ${CLIENT_TYPE} -a '' --eval "${ELISP}"
> -- 
> 2.1.4