From: Tomi Ollila Date: Mon, 19 Jan 2015 16:32:30 +0000 (+0200) Subject: Re: [PATCH] cli: add a tool for starting new message in the emacs ui X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=1fe830901223f753c9afb2ba0134e666dd53e7eb;p=notmuch-archives.git Re: [PATCH] cli: add a tool for starting new message in the emacs ui --- diff --git a/23/dfa4f5228b1184c8b9f0f2b6f2bfcda8ddb378 b/23/dfa4f5228b1184c8b9f0f2b6f2bfcda8ddb378 new file mode 100644 index 000000000..a1762d7d8 --- /dev/null +++ b/23/dfa4f5228b1184c8b9f0f2b6f2bfcda8ddb378 @@ -0,0 +1,306 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id E7EFB431FB6 + for ; Mon, 19 Jan 2015 08:33:01 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 2.438 +X-Spam-Level: ** +X-Spam-Status: No, score=2.438 tagged_above=-999 required=5 + tests=[DNS_FROM_AHBL_RHSBL=2.438] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id cRP+PzMovMSF for ; + Mon, 19 Jan 2015 08:32:56 -0800 (PST) +Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34]) + by olra.theworths.org (Postfix) with ESMTP id D3324431FAF + for ; Mon, 19 Jan 2015 08:32:55 -0800 (PST) +Received: from guru.guru-group.fi (localhost [IPv6:::1]) + by guru.guru-group.fi (Postfix) with ESMTP id 3642E1000E0; + Mon, 19 Jan 2015 18:32:31 +0200 (EET) +From: Tomi Ollila +To: David Bremner , "Jani Nikula" , + notmuch@notmuchmail.org +Subject: Re: [PATCH] cli: add a tool for starting new message in the emacs ui +In-Reply-To: <1421598115-4889-1-git-send-email-david@tethera.net> +References: <1404244957-3671-1-git-send-email-david@tethera.net> + <1421598115-4889-1-git-send-email-david@tethera.net> +User-Agent: Notmuch/0.19+29~g7367d27 (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-unknown-linux-gnu) +X-Face: HhBM'cA~ +MIME-Version: 1.0 +Content-Type: text/plain; charset=utf-8 +Content-Transfer-Encoding: quoted-printable +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Mon, 19 Jan 2015 16:33:02 -0000 + +On Sun, Jan 18 2015, David Bremner wrote: + +> From: Jani Nikula +> +> Add a tool to start composing an email in the Notmuch Emacs UI with +> the specified subject, recipients, and message body. +> --- + +I've given this quite a lot of thought today (while commuting on the bus), +and at some (late) moment of time I started to think about security=20 +(command line options are visible in ps(1) output), and based on that the +naive user option --body taking content from a file is tol^H^H^Hgood idea +after all.=20 + +Therefore, the current command line interface gets +1 from me. + +I'll use this as a base for further work after this is committed to +the repository. + +(I am now on a terminal unsuitable for yet another review round; I'll +do that tomorrow) + +Tomi + + + + +> +> 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. +> +> 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 =3D [ +> u'creates a plain-text dump of the tags of each message', +> [u'Carl Worth and many others'], 1), +>=20=20 +> +('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 @@ +> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +> +notmuch-emacs-mua +> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +> + +> +SYNOPSIS +> +=3D=3D=3D=3D=3D=3D=3D=3D +> + +> +**notmuch-emacs-mua** [options ...] [ ...] +> + +> +DESCRIPTION +> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +> + +> +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=3D``\ +> + Specify the subject of the message. +> + +> + ``--to=3D``\ +> + Specify a recipient (To). +> + +> + ``-c, --cc=3D``\ +> + Specify a carbon-copy (Cc) recipient. +> + +> + ``-b, --bcc=3D``\ +> + Specify a blind-carbon-copy (Bcc) recipient. +> + +> + ``-i, --body=3D``\ +> + 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 +> +=3D=3D=3D=3D=3D=3D=3D=3D +> + +> +**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 =C2=A9 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 +> +# +> + +> +set -eu +> + +> +escape () +> +{ +> + echo "${1//\"/\\\"}" +> +} +> + +> +PRINT_ONLY=3D +> +CLIENT_TYPE=3D"-c" +> + +> +# The crux of it all: construct an elisp progn and eval it. +> +ELISP=3D"(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=3D$1 +> + if [ "${OPTARG}" !=3D "-" ]; then +> + echo "$0: unknown short option -${OPTARG}." >&2 +> + exit 1 +> + fi +> + +> + case "${opt}" in +> + # Long options with arguments. +> + --subject=3D*|--to=3D*|--cc=3D*|--bcc=3D*|--body=3D*) +> + OPTARG=3D${opt#--*=3D} +> + opt=3D${opt%%=3D*} +> + ;; +> + # 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=3D$((OPTIND + 1)) +> + ;; +> + esac +> + +> + OPTARG=3D"$(escape "${OPTARG}")" +> + +> + case "${opt}" in +> + --help|h) +> + exec man notmuch-emacs-mua +> + ;; +> + --subject|s) +> + ELISP=3D"${ELISP} (message-goto-subject) (insert \"${OPTARG}\")" +> + ;; +> + --to) +> + ELISP=3D"${ELISP} (message-goto-to) (insert \"${OPTARG}, \")" +> + ;; +> + --cc|c) +> + ELISP=3D"${ELISP} (message-goto-cc) (insert \"${OPTARG}, \")" +> + ;; +> + --bcc|b) +> + ELISP=3D"${ELISP} (message-goto-bcc) (insert \"${OPTARG}, \")" +> + ;; +> + --body|i) +> + ELISP=3D"${ELISP} (message-goto-body) (cd \"${PWD}\") (insert-file = +\"${OPTARG}\")" +> + ;; +> + --print) +> + PRINT_ONLY=3D1 +> + ;; +> + --no-window-system) +> + CLIENT_TYPE=3D"-t" +> + ;; +> + *) +> + # We should never end up here. +> + echo "$0: internal error (option ${opt})." >&2 +> + exit 1 +> + ;; +> + esac +> + +> + shift $((OPTIND - 1)) +> + OPTIND=3D1 +> +done +> + +> +# Positional parameters. +> +for arg; do +> + arg=3D"$(escape "${arg}")" +> + ELISP=3D"${ELISP} (message-goto-to) (insert \"${arg}, \")" +> +done +> + +> +# End progn. +> +ELISP=3D"${ELISP})" +> + +> +if [ -n "$PRINT_ONLY" ]; then +> + echo ${ELISP} +> + exit 0 +> +fi +> + +> +# Evaluate the progn. +> +exec emacsclient ${CLIENT_TYPE} -a '' --eval "${ELISP}" +> --=20 +> 2.1.4 +> +> _______________________________________________ +> notmuch mailing list +> notmuch@notmuchmail.org +> http://notmuchmail.org/mailman/listinfo/notmuch