summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2018-09-27 09:53:31 +0200
committerGitHub <noreply@github.com>2018-09-27 09:53:31 +0200
commitc791977aab6eb94520cf299fb05a8355da10718c (patch)
treee9caee502f39c7f2833cd07b0231dca9f175737c
parentccbc2b2672defc61f4e67040fc193b8271bd9f60 (diff)
parent6bf49aa6b52b501f01efb786e986e97d0719baf6 (diff)
downloadimag-c791977aab6eb94520cf299fb05a8355da10718c.zip
imag-c791977aab6eb94520cf299fb05a8355da10718c.tar.gz
Merge pull request #1506 from matthiasbeyer/minor
Minor
-rw-r--r--.travis.yml3
-rw-r--r--bin/core/imag-diagnostics/Cargo.toml2
-rw-r--r--bin/core/imag-ids/src/main.rs8
-rw-r--r--bin/core/imag-init/src/main.rs7
-rw-r--r--bin/domain/imag-contact/src/main.rs5
-rw-r--r--bin/domain/imag-log/Cargo.toml2
-rw-r--r--bin/domain/imag-mail/Cargo.toml2
-rw-r--r--bin/domain/imag-timetrack/Cargo.toml2
-rw-r--r--doc/src/04020-module-diary.md2
-rw-r--r--doc/src/04020-module-mails.md298
-rw-r--r--doc/src/04020-module-timetrack.md6
-rw-r--r--doc/src/04020-module-todo.md6
-rw-r--r--doc/src/05100-lib-mails.md13
-rw-r--r--doc/src/05100-lib-todo.md3
-rw-r--r--imagrc.toml8
-rw-r--r--scripts/check-binary-names14
16 files changed, 332 insertions, 49 deletions
diff --git a/.travis.yml b/.travis.yml
index c9cbab4..83c4d83 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -46,7 +46,8 @@ addons:
notifications:
email:
- on_success: never
+ on_success: always
+ on_failure: always
irc:
channels:
- chat.freenode.net#imag
diff --git a/bin/core/imag-diagnostics/Cargo.toml b/bin/core/imag-diagnostics/Cargo.toml
index 08c4e7c..a6a12d9 100644
--- a/bin/core/imag-diagnostics/Cargo.toml
+++ b/bin/core/imag-diagnostics/Cargo.toml
@@ -3,7 +3,7 @@ name = "imag-diagnostics"
version = "0.9.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
-description = "Part of the imag core distribution: imag-gps command"
+description = "Part of the imag core distribution: imag-diagnostics command"
keywords = ["imag", "PIM", "personal", "information", "management"]
readme = "../../../README.md"
diff --git a/bin/core/imag-ids/src/main.rs b/bin/core/imag-ids/src/main.rs
index c8da3ce..308a56a 100644
--- a/bin/core/imag-ids/src/main.rs
+++ b/bin/core/imag-ids/src/main.rs
@@ -91,14 +91,6 @@ fn main() {
.entries()
.map_err_trace_exit_unwrap(1)
.trace_unwrap_exit(1)
- .enumerate()
- .map(|(i, e)| {
- if i % 100 == 0 {
- let _ = rt.store().flush_cache();
- }
-
- e
- })
.filter(|id| collection_filter.filter(id))
.filter(|id| match query_filter.as_ref() {
None => true,
diff --git a/bin/core/imag-init/src/main.rs b/bin/core/imag-init/src/main.rs
index de80912..ef89963 100644
--- a/bin/core/imag-init/src/main.rs
+++ b/bin/core/imag-init/src/main.rs
@@ -267,8 +267,11 @@ mod tests {
#[test]
fn test_config() {
- assert!(from_str::<Value>(&get_config()[..]).is_ok());
- assert!(from_str::<Value>(&get_config_devel()[..]).is_ok());
+ let val = from_str::<Value>(&get_config()[..]);
+ assert!(val.is_ok(), "Config parsing errored: {:?}", val);
+
+ let val = from_str::<Value>(&get_config_devel()[..]);
+ assert!(val.is_ok(), "Config parsing errored: {:?}", val);
}
}
diff --git a/bin/domain/imag-contact/src/main.rs b/bin/domain/imag-contact/src/main.rs
index e1005d7..c8c033b 100644
--- a/bin/domain/imag-contact/src/main.rs
+++ b/bin/domain/imag-contact/src/main.rs
@@ -227,8 +227,9 @@ fn show(rt: &Runtime) {
None
}
})
- .for_each(|elem| {
- let data = build_data_object_for_handlebars(0, &elem);
+ .enumerate()
+ .for_each(|(i, elem)| {
+ let data = build_data_object_for_handlebars(i, &elem);
let s = show_format
.render("format", &data)
diff --git a/bin/domain/imag-log/Cargo.toml b/bin/domain/imag-log/Cargo.toml
index 30af3f7..3c22c70 100644
--- a/bin/domain/imag-log/Cargo.toml
+++ b/bin/domain/imag-log/Cargo.toml
@@ -3,7 +3,7 @@ name = "imag-log"
version = "0.9.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
-description = "Part of the imag core distribution: imag-bookmark command"
+description = "Part of the imag core distribution: imag-log command"
keywords = ["imag", "PIM", "personal", "information", "management"]
readme = "../../../README.md"
diff --git a/bin/domain/imag-mail/Cargo.toml b/bin/domain/imag-mail/Cargo.toml
index 6e07a5b..08ecff0 100644
--- a/bin/domain/imag-mail/Cargo.toml
+++ b/bin/domain/imag-mail/Cargo.toml
@@ -3,7 +3,7 @@ name = "imag-mail"
version = "0.9.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
-description = "Part of the imag core distribution: imag-notes command"
+description = "Part of the imag core distribution: imag-mail command"
keywords = ["imag", "PIM", "personal", "information", "management"]
readme = "../../../README.md"
diff --git a/bin/domain/imag-timetrack/Cargo.toml b/bin/domain/imag-timetrack/Cargo.toml
index 6ff6461..8266313 100644
--- a/bin/domain/imag-timetrack/Cargo.toml
+++ b/bin/domain/imag-timetrack/Cargo.toml
@@ -3,7 +3,7 @@ name = "imag-timetrack"
version = "0.9.0"
authors = ["Matthias Beyer <mail@beyermatthias.de>"]
-description = "Part of the imag core distribution: imag-tag command"
+description = "Part of the imag core distribution: imag-timetrack command"
keywords = ["imag", "PIM", "personal", "information", "management"]
readme = "../../../README.md"
diff --git a/doc/src/04020-module-diary.md b/doc/src/04020-module-diary.md
index d62c2bc..b2d56fe 100644
--- a/doc/src/04020-module-diary.md
+++ b/doc/src/04020-module-diary.md
@@ -6,7 +6,7 @@ The diary module giv3s you the possibility to write your diary in imag.
It offers daily, hourly and minutely entries (the latter beeing more like
a private tumble-blog).
-Exporting the diary is possible, so one can write it in markdown and
+Exporting the diary is possible, so one can write it in markdown and
later pass that to pandoc, if desired, to generate a website or book
from it.
diff --git a/doc/src/04020-module-mails.md b/doc/src/04020-module-mails.md
index 87752c3..bfaed6a 100644
--- a/doc/src/04020-module-mails.md
+++ b/doc/src/04020-module-mails.md
@@ -1,29 +1,297 @@
## Mails {#sec:modules:mails}
-The Mails module implements a commandline email client. Emails can be written (via `$EDITOR`) and viewed, also in threads. Emails can be crawled for creating new contacts.
+The Mails module implements a commandline email client. Emails can be written
+(via `$EDITOR`) and viewed, also in threads. Emails can be crawled for creating
+new contacts.
A Text User Interface is not planned, but might be there at some point.
-The mail module implements a minimal Email client. It does not handle IMAP syncing or SMTP things, it is just a _viewer_ for emails (a MUA).
+The mail module implements a minimal Email client. It does not handle IMAP
+syncing or SMTP things, it is just a _viewer_ for emails (a MUA).
-The goal of the initial implementation is only a CLI, not a TUI like mutt offers, for example (but that might be implemented later). As this is an imag module, it also creates references to mails inside the imag store which can be used by other tools then (for example `imag-link` to link an entry with a mail - or the imag entry representing that mail).
+The goal of the initial implementation is only a CLI, not a TUI like mutt
+offers, for example (but that might be implemented later). As this is an imag
+module, it also creates references to mails inside the imag store which can be
+used by other tools then (for example `imag-link` to link an entry with a mail -
+or the imag entry representing that mail).
-So this module offers functionality to read (Maildir) mailboxes, search for and list mails and mail-threads and reply to mails (by spawning the `$EDITOR`).
+So this module offers functionality to read (Maildir) mailboxes, search for and
+list mails and mail-threads and reply to mails (by spawning the `$EDITOR`).
-Outgoing mails are pushed to a special directory and can later on be send via `imag-mail` which calls a MTA (for example msmtp) and also creates store entries for the outgoing mails.
+Outgoing mails are pushed to a special directory and can later on be send via
+`imag-mail` which calls a MTA (for example msmtp) and also creates store entries
+for the outgoing mails.
### CLI
The CLI of the imag-mail module is planned as follows:
- imag mail track <path> [opts...] # track a new mail, mail file passed as path
- imag mail scan <path> [opts...] # scan a maildir and track all untracked mails
- imag mail box <name|path> # work with the mailbox specified by <name|path>, name mappings from config
- imag mail list <args...> # list mails in a given mailbox for a given account or the default account
- imag mail show <args...> # open new mails in the pager
- imag mail thread list <args...> # list mails from a thread
- imag mail thread show <args...> # open new mails from a thread in the pager or call a script with them
- imag mail new <args...> # craft a new mail and safe it in the <outgoing> folder
- imag mail send <args...> # send emails from the outgoing folder, optionally also move them to archice boxes
- imag mail mv <srcbox> <dstbox> # move a mail (or thread) from one mailbox to another
+* imag mail
+
+ Requires configuration:
+ * mail.outgoingbox
+ * mail.accounts.<account>.maildirroot
+
+ -A, --account - Specify the "account" to use for the opperation.
+ A account is nothing more than a mapping of a name to a
+ path where the Maildirs are located. It is specified in
+ the imag configuration file.
+ For example:
+
+ private -> ~/.mails/personal
+
+ If none is specified, the configuration is searched for a
+ "maildir" setting (where all Maildirs are found in). If
+ there is no such setting, imag-mail fails.
+ (or: read in documentation for --box).
+
+ -B, --box - Specify a temporary location for a Maildir to work with.
+
+* imag mail track <path> [opts...]
+ Track a new mail, mail file passed as path
+
+ --refind - re-find messages. Loads all messages which are known to imag
+ and compares identifiers, to update the imag-internal cache if
+ a mail got moved
+
+ -O, --output-id - print the store id for the new (or in case of --refind
+ updated) imag entry
+
+* imag mail scan <path> [opts...]
+ Scan a maildir and track all untracked mails
+
+ --refind - re-find messages. Loads all messages which are known to imag
+ and compares identifiers, to update the imag-internal cache if
+ a mail got moved
+
+ -O, --output-id - print the store id for the new (or in case of --refind
+ updated) imag entry
+
+* imag mail list <args...>
+ List mails in a given mailbox for a given account or the default account
+
+ -S, --style - print messages in a certain style
+ Available:
+ - 'linewise'
+ - 'thread'
+
+ -g, --grep - Filter by grepping for a pattern in body and subject
+
+ -d, --daterange - Filter by date(range)
+
+ -F, --filter - Filter by passed filter
+
+ --thread - Print only messages from the same thread as the found ones
+
+ --format=<fmt> - Format mails for showing.
+ --format always colorizes output (specify color in config)
+ except when using --no-pager or piping output.
+
+ When --tree is passed, the format is applied to the
+ fragment _after_ the tree graphic.
+
+ Default mode is 'default'.
+
+ Modes:
+ - 'subject': <Subject>
+ - 'simple': <From>: <Subject>
+ - 'default': <Date> - <From>: <Subject>
+ - 'fmt:<fmt>' format with passed format
+
+ Additional formats can be specified via the configuration
+ file. If a format has the same name as a predefined one,
+ the config overrides the predefined formats.
+
+ --color - Colorize output (default).
+ --no-color - Do never colorize output.
+
+* imag mail show <args...>
+ Show mail(s) - either in pager or by printing them to stdout.
+
+ Mails are specified by message id or imag entry
+
+ --refind - If a imag entry is passed but the mail file is not there,
+ try to re-find it.
+
+ --refind-in - Same as --refind, but a path to a Maildir or a tree of
+ Maildirs might be passed to narrow down search space.
+
+ -C, --concat - Open all mails in one pager (by concatenating them)
+ instead of one pager per message.
+
+ --pager - Use pager to show mails (default).
+
+ --no-pager - Do not use pager to show mails.
+
+ --multipager - Pass all mails as arguments to one pager call instead of
+ calling the pager on each mail individually (default).
+ Only possible with --pager.
+
+ --no-multipager - Disable --multipager.
+ Only possible with --pager.
+
+ --format=<fmt> - Format mails for showing.
+ --format always colorizes emails (specify color in config)
+ except when using --no-pager or piping output.
+
+ Modes:
+ - 'simple': Remove headers, except
+ From, To, Cc, Subject, Date,
+ Message-Id/References/In-Reply-To
+ - 'simple-imag': Same as 'simple' but also show imag
+ entry id.
+ - 'print': Show everything
+ - 'full': Show everything and add imag entry id
+ - 'minimal': Remove headers, except From, To, Cc, Subject, Date,
+ - 'tiny': Remove headers, except From, To, Subject
+ - 'fmt:<fmt>' format with passed format
+
+ Additional formats can be specified via the configuration
+ file. If a format has the same name as a predefined one,
+ the config overrides the predefined formats.
+
+ --no-format - Disable all formatting (same as --pretty=print and
+ disabling color output).
+
+ --color - Colorize output (default).
+ --no-color - Do never colorize output.
+
+* imag mail new <args...>
+ Craft a new mail and safe it in the <outgoing> folder
+
+ Requires configuration:
+ * mail.accounts.<account>.draftbox
+ * mail.accounts.<account>.outgoingbox
+
+ --outbox - Specify the outbox for where the new mail should be stored
+ in, if it is not given in the config (or to override it)
+
+ --to - Specify to whom to send.
+ If the specified string does not contain a valid email
+ address, `imag contact find` is used to find the email
+ address (if not suppressed via --no-autofind).
+ Multiple allowed.
+
+ --cc - Specify to whom to send in CC.
+ If the specified string does not contain a valid email
+ address, `imag contact find` is used to find the email
+ address (if not suppressed via --no-autofind).
+ Multiple allowed.
+
+ --bcc - Specify to whom to send in BCC.
+ If the specified string does not contain a valid email
+ address, `imag contact find` is used to find the email
+ address (if not suppressed via --no-autofind).
+ Multiple allowed.
+
+ --no-autofind - Do not automatically find contacts
+ with `imag contact find`.
+
+ --fcc - Specify to store a copy of the mail somewhere.
+ Multiple allowed.
+
+ --subject - Specify subject.
+
+ --gpg-sign - Sign with gpg.
+
+ --gpg-crypt - Crypt with gpg to all recipients.
+
+ --no-track - Do not track new mailfile with imag.
+
+ -D, --draft - Do not safe in "outgoing" box but rather in "draft" box.
+
+* imag mail compose <args...>
+ Same as 'new'.
+
+* imag mail fetch <args...>
+ Fetch emails
+
+ Requires configuration:
+ * mail.fetchcommand or mail.accounts.<account>.fetchcommand
+ * mail.postfetchcommand or mail.accounts.<account>.postfetchcommand (optional)
+
+ --all - Fetch for all accounts
+ --boxes - Fetch only some boxes (does not work with --all)
+
+* imag mail send <args...>
+ Send emails from the outgoing folder, also move them to 'sent' boxes
+
+ Requires configuration:
+ * mail.accounts.<account>.outgoingbox
+ * mail.accounts.<account>.sentbox
+ * mail.sendcommand or mail.accounts.<account>.sendcommand
+ * mail.postsendcommand or mail.accounts.<account>.postsendcommand (optional)
+
+ --outbox - Specify the outbox for where the mails that are about to
+ be send are stored in, if it is not given in the config
+ (or to override it).
+
+ --sentbox - Specify the sentbox for where the sent mails should be
+ moved after sending them, if it is not given in the config
+ (or to override it).
+
+ --no-move-sent - Do not move mail to the "sent" folder after sending it.
+
+ --confirm - Confirm each mail before sending (default).
+
+ --no-confirm - Do not confirm each mail before sending.
+
+ --no-track - Do not track mailfile with imag. Does only work if `imag
+ mail new` was invoked with `--no-track` (so that the mail
+ is not tracked already).
+
+* imag mail mv <src mail> <dstbox>
+ Move a mail to another mailbox
+
+ --thread - Move the complete thread of emails belonging to the
+ specified mail.
+
+ --no-track - Do not track new mailfile with imag. Does not work if
+ mailfile is already tracked with imag.
+
+* imag mail find <args...>
+ Search for a mail (by header field (msgid, from, to, cc, subject, date,
+ date-range), body, ...)
+
+ --msgid
+ --no-msgid
+ --from
+ --no-from
+ --to
+ --no-to
+ --cc
+ --no-cc
+ --subject
+ --no-subject
+ --date
+ --no-date
+ --body
+ --no-body
+ --daterange - Toggle where to look at
+
+ --print-entryid - Print imag entry id when finding mail
+ --no-print-entryid - Do not print imag entry id when finding mail (default).
+
+ --print=<what> - What to print for the found mails.
+ Valid values:
+ - msgid
+ - subject
+ - from
+ - cc
+ - to
+ - date
+ - filepath (default)
+
+* imag mail reply <args...>
+ Reply to an email.
+
+ Requires configuration: mail.accounts.<account>.outgoingbox
+
+ Specify the mail to reply to by msgid, filepath or imag entry id.
+
+ --add-to
+ --add-cc
+ --add-bcc - Add another recipient. Multiple allowed.
+
+ --no-track - Do not track new mailfile with imag.
diff --git a/doc/src/04020-module-timetrack.md b/doc/src/04020-module-timetrack.md
index a22fca2..01b52d9 100644
--- a/doc/src/04020-module-timetrack.md
+++ b/doc/src/04020-module-timetrack.md
@@ -1,8 +1,10 @@
## Timetrack {#sec:modules:timetrack}
-The Timetrack module implements a `timewarrior`-like timetracking functionality for imag.
+The Timetrack module implements a `timewarrior`-like timetracking functionality
+for imag.
-Each timetracking is a 'tag' which can be started and stopped. These tags are _no_ tags as in imag-tag, but timetracking-tags.
+Each timetracking is a 'tag' which can be started and stopped. These tags are
+_no_ tags as in imag-tag, but timetracking-tags.
Summaries can be printed, also filtered by tags if desired.
diff --git a/doc/src/04020-module-todo.md b/doc/src/04020-module-todo.md
index 426052c..3849b24 100644
--- a/doc/src/04020-module-todo.md
+++ b/doc/src/04020-module-todo.md
@@ -1,7 +1,9 @@
## Todo {#sec:modules:todo}
-The Todo module implements `taskwarrior` functionality by integrating taskwarrior itself into imag.
+The Todo module implements `taskwarrior` functionality by integrating
+taskwarrior itself into imag.
-Each taskwarrior task s referenced from imag and represented as imag entry, thus making it linkable by other imag entries.
+Each taskwarrior task s referenced from imag and represented as imag entry, thus
+making it linkable by other imag entries.
diff --git a/doc/src/05100-lib-mails.md b/doc/src/05100-lib-mails.md
index dd0e346..fde0879 100644
--- a/doc/src/05100-lib-mails.md
+++ b/doc/src/05100-lib-mails.md
@@ -1,9 +1,14 @@
## libimagmails
-The mail library implements everything that is needed for beeing used to implement a mail reader (MUA).
+The mail library implements everything that is needed for beeing used to
+implement a mail reader (MUA).
-It therefor providea reading mailboxes, getting related content or mails, saving attachements to external locations, crafting new mails and responses,...
+It therefor providea reading mailboxes, getting related content or mails, saving
+attachements to external locations, crafting new mails and responses,...
-It also offers, natively, ways to search for mails (which are represented as imag entries) via tags, categories or even other metadata.
+It also offers, natively, ways to search for mails (which are represented as
+imag entries) via tags, categories or even other metadata.
+
+For more information on the domain of the `imag-mail` command, look at the
+documentation of the @sec:modules:mails module.
-For more information on the domain of the `imag-mail` command, look at the documentation of the @sec:modules:mails module.
diff --git a/doc/src/05100-lib-todo.md b/doc/src/05100-lib-todo.md
index d37085b..1109ee8 100644
--- a/doc/src/05100-lib-todo.md
+++ b/doc/src/05100-lib-todo.md
@@ -2,6 +2,7 @@
The library for the todo module.
-Whether this wraps `taskwarrior` or implements a todo tracking mechanism in imag itself is to be defined. Probably the latter.
+Whether this wraps `taskwarrior` or implements a todo tracking mechanism in imag
+itself is to be defined. Probably the latter.
diff --git a/imagrc.toml b/imagrc.toml
index 1371b93..8e21f8d 100644
--- a/imagrc.toml
+++ b/imagrc.toml
@@ -323,13 +323,7 @@ web = "chromium {{entries}}"
#
# Multiple lines shouldn't be used, as this is for listing multiple entries.
#
-# Note: Abbreviating the hash ("id") is not yet supported in the "show" command,
-# thus we print the id here without abbreviating it. To abbreviate it to 5
-# characters, use:
-#
-# {{abbrev 5 id}}
-#
-list_format = "{{lpad 5 i}} | {{id}} | {{FN}} | {{mail}} | {{adr}}"
+list_format = "{{lpad 5 i}} | {{abbrev 5 id}} | {{FN}} | {{mail}} | {{adr}}"
# The format when printing a single contact
#
diff --git a/scripts/check-binary-names b/scripts/check-binary-names
new file mode 100644
index 0000000..075c073
--- /dev/null
+++ b/scripts/check-binary-names
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+for file in `find bin -type f -name Cargo.toml -o -name main.rs -o -name ui.rs`;
+do
+ echo "$file" | grep Cargo.toml > /dev/null 2>/dev/null && {
+ name=$(cat $file | grep description | sed 's,.*: ,,; s, .*,,')
+
+ echo "$file" | grep "$name" > /dev/null 2>/dev/null || {
+ echo "Crate in $file is named $name"
+ exit 1
+ }
+ }
+
+done