path: root/imagrc.toml

# This is a example configuration file for the imag suite.
# It is written in TOML

[rt]
editor = "vim"

# If the command uses a progress bar to indicate progress, this is the template
# for it.
#
# The docs for the template language can be found at
#
#     https://docs.rs/indicatif
#
progressbar_style = "[{elapsed_precise}] {bar:40.cyan/blue} {pos:>7}/{len:7} {msg}"
progressticker_chars = "|/-\\-/-\\"

#
# imag supports templates when specifying formats. The templates support several
# functionalities, from colorizing to underlining and such things.
#
# Here goes a list of supported formatting helpers:
#
# These functions can be applied for colorizing the output:
#  {{black <input>}}
#  {{blue <input>}}
#  {{cyan <input>}}
#  {{green <input>}}
#  {{purple <input>}}
#  {{red <input>}}
#  {{white <input>}}
#  {{yellow <input>}}
#
# The following functions are allowed for formatting text:
#  {{lpad <count> <input>}}   - to "left pad" by <count> spaces
#  {{rpad <count> <input>}}   - to "right pad" by <count> spaces
#  {{abbrev <count> <input>}} - to "abbreviate" the output to <count> chars
#  {{underline <input>}}      - for underlining
#  {{bold <input>}}           - for making input bold
#  {{blink <input>}}          - for making input blinking
#  {{strikethrough <input>}}  - for making input struck through
#
# Strings can only be printed. Arrays can be indexed with the `lookup` function.
#
#
# The underlying templating engine also supports these:
#
# {{#raw}} ... {{/raw}} escape handlebars expression within the block
# {{#if ...}} ... {{else}} ... {{/if}} if-else block
# {{#unless ...}} ... {{else}} .. {{/unless}} if-not-else block
# {{#each ...}} ... {{/each}} iterates over an array or object.
#   Handlebar-rust doesn't support mustach iteration syntax so use this instead.
# {{#with ...}} ... {{/with}} change current context. Similar to {{#each}}, used for replace corresponding mustach syntax.
# {{lookup ... ...}} get value from array by @index or @key
# {{> ...}} include template with name
# {{log ...}} log value with rust logger, default level: INFO. Currently you cannot change the level.
#
# Warning: These are _not_ tested and should be used with care.
#

# The alias section
#
# In this section one can define aliases for imag subcommands.
#
# E.G: An alias `store = [ "s", "st" ]` allows the user to call `imag s` or
# `imag st` for calling `imag store`.
#
# The aliases have to be either a single string or an array of strings, where no
# string contains whitespace (thus, aliasing a "store-create" call to "sc" for
# example is not supported).
#
[imag.aliases]
store = [ "s", "st" ]
notes = [ "note" ] # imag-notes really should be imag-note

[imag.logging]
level = "debug"
destinations = [ "-" ]

#
# Valid variables for logging:
#  * "level"
#  * "module_path"
#  * "file"
#  * "line"
#  * "target"
#  * "message"
#

[imag.logging.format]
trace = "[imag][{{red level}}][{{module_path}}]: {{message}}"
debug = "[imag][{{cyan level}}][{{yellow target}}]: {{message}}"
info  = "[imag]: {{message}}"
warn  = "[imag][{{bold level}}]: {{yellow message}}"
error = "[imag][{{red level}}]: {{red message}}"

#
# Configuration options for the user interface
#
[ui]

#
# Configuration options for the commandline user interface
#
[ui.cli]

# History file path for readline. Will be created by imag if it does not exist.
readline_history_file = "/tmp/readline.history"

# Number of lines to safe in the history file
readline_history_size = 100

# Ignore duplicated lines
readline_history_ignore_dups = true

# Tell if lines which begin with a space character are saved or not in the
# history list.
readline_history_ignore_space = true

# The prompt string to use
readline_prompt = ">> "

[store]

# Set to false if you do not want imag to create the directory where the store
# lives implicitely
implicit-create = false

[diary]
default_diary = "default"

[diary.diaries.default]
timed = "minutely"

[bookmark]
default_collection = "default"
open = "firefox {{url}}"

[view.viewers]
# Configure which viewers there are for `imag view <entry> in <viewer>`.
editor = "vim -R {{entries}}"
web    = "chromium {{entries}}"

[contact]

# Format for listing contacts
#
# Available variables:
#  * "i"            : Integer, counts the output lines
#  * "id"           : The hash which can be used to print the entry itself.
#  * "ADR"          : Array
#  * "ANNIVERSARY"  : String
#  * "BDAY"         : String
#  * "CATEGORIES"   : Array<String>
#  * "CLIENTPIDMAP" : String
#  * "EMAIL"        : Array<String>
#  * "FN"           : Array<String>
#  * "GENDER"       : String
#  * "GEO"          : Array<String>
#  * "IMPP"         : Array<String>
#  * "KEY"          : Array<String>
#  * "LANG"         : Array<String>
#  * "LOGO"         : Array<String>
#  * "MEMBER"       : Array<String>
#  * "N"            : String
#  * "NICKNAME"     : Array<String>
#  * "NOTE"         : Array<String>
#  * "ORG"          : Array<String>
#  * "PHOTO"        : Array<String>
#  * "PRIOD"        : String
#  * "RELATED"      : Array<String>
#  * "REV"          : String
#  * "ROLE"         : Array<String>
#  * "SOUND"        : Array<String>
#  * "TEL"          : Array<String>
#  * "TITLE"        : Array<String>
#  * "TZ"           : Array<String>
#  * "UID"          : String
#  * "URL"          : Array<String>
#  * "VERSION"      : String
#
# Multiple lines shouldn't be used, as this is for listing multiple entries.
#
list_format = "{{lpad 5 i}} | {{abbrev 5 id}} | {{FN}} | {{mail}} | {{adr}}"

# The format when printing a single contact
#
# Here, the same rules like for the list format apply.
# Multiple lines should work fine.
# The "i" variable defaults to zero (0)
show_format = """
{{id}} - {{UID}}

Full name: {{FN}}
Email    : {{EMAIL}}
Address  : {{ADR}}
"""

[calendar]
list_format = "{{lpad 5 i}} | {{abbrev 5 uid}} | {{summary}} | {{location}}"
show_format = """
{{i}} - {{uid}}

Summary  : {{summary}}
Start    : {{dtstart}}
End      : {{dtend}}
Url      : {{url}}
Location : {{location}}

{{description}}

"""

[log]
logs = ["default"]
default = "default"

[git]
# Configuration for imag-git
#
# if this variable is _false_, imag-git will run git in $IMAG_RTP.
# if this variable is _true_, imag-git will run git in $IMAG_RTP/store
execute_in_store = false

[ref]

# configuration for imag-ref and ref using tools.
# The base pathes define the search pathes for libimagentryref
[ref.basepathes]
music = "/home/user/music"
mail = "/home/user/mail"
contacts = "/home/user/contacts"
calendars = "/home/user/calendars"

[mail]
# The name of the mail reference collection
list_format = "{{i}} - {{id}} - {{from}} -> {{to}}\t: {{subject}}"
notmuch_database = "/home/user/Mail"

# Tag that is automatically added to the entry upon importing from notmuch
# (optional)
import_tag = "mail"

# Import tags from notmuch into imag
import_notmuch_tags = true

# edit headers when typing mail
edit_headers = true

from_address = "User Name <user@name.tld>"

default_template = """
Dear {{to | get_name}}
{{if cc}}
dear {{cc | get_name}}
{{/if}}

With kind regards
"""

header_template = """
Date: {{date}}
From: {{from}}
Reply-To: {{from}}
Message-Id: {{message_id}}
To: {{to}}
Cc: {{cc}}
Subject: {{subject}}
{{#if is_in_reply_to}}In-Reply-To: {{in_reply_to}}{{/if}}

{{#if has_to_name}}Dear {{to_name}},{{/if}}
{{#if has_cc_name}}dear {{cc_name}},{{/if}}

With kind regards
"""

# The location where the mail is stored after it is written, but before it is sent.
#
# This is where imag puts the mail, intended to be send at some point.
# The mail-send-script should pick up each mail in here and process it.
# Not to be confused with "drafts" which are not intended for sending yet.
outgoing_maildir = "/home/user/.mail_outgoing"

# Path script to run before writing outgoing mail to outgoing_maildir (optional)
#pre_outgoing = ""

# Path script to run after writing outgoing mail to outgoing_maildir (optional)
#post_outgoing = ""

# The location where to put drafted mails
draft_maildir = "/home/user/.mail_draft"

# Path script to run before writing draft mail to draft_maildir (optional)
#pre_draft = ""

# Path script to run after writing draft mail to draft_maildir (optional)
#post_draft = ""

# The location where to put sent mails
sent_maildir = "/home/user/.mail_sent"

# Path script to run before writing mail to sent_maildir (optional)
#pre_sent = ""

# Path script to run after writing mail to sent_maildir (optional)
#post_sent = ""

# Path to script to receive email
# Script should output absolute pathes to emails linewise
# imag uses these pathes to parse the mail and show nice output.
# STDERR of the script is logged by imag.
recv_script = "/home/user/.mail_scripts/recv-emails"

# Whether to show nice output for each mail when receiving and the format
recv_output = true
recv_output_format = ""

# Whether to show nice output as a summary when receiving and the format
recv_output_summary = true
recv_output_summary_format = ""

# Script to be invoked before recving. (optional)
# STDERR of the script is logged by imag.
#pre_recv_script = ""

# Script to be invoked after recving. (optional)
# Can be used to call "notmuch new" for example
# STDERR of the script is logged by imag.
#post_recv_script = ""

# Whether to automatically import new emails
auto_import = true

# Path to script to send email
#
# The script gets the pathes to the email file on stdin.
# This script is called once for each mail.
#
# If the script exits with a nonzero exit code, the sending is expected to be failed. The mail
# is not considered sent.
#
# The script is expected to not alter the mails and not move them.
# STDERR of the script is logged by imag.
send_script = "/home/user/.mail_scripts/send-email"

# Whether to show a progress bar when sending
send_progress = true

# If false, the invokation of the send scripts are chained. If one fails, the chain is
# aborted.
#
# If true, the script is invoked in parallel for all mails. If one fails, the others are still
# running.
send_parallel = false

# Script to be invoked before sending. (optional)
#
# Invoked exactly the same as the send_script (once for each mail, either in parallel or in
# sequence). If this exits with a nonzero exit code, the send_script is not invoked. The
# operation is aborted in case of sequencial sending.
# STDERR of the script is logged by imag.
#pre_send_script = ""

# Script to be invoked after sending. (optional)
#
# Exit code ignored.
# STDERR of the script is logged by imag.
#post_send_script = ""

[todo]
show_format = """
{{i}}      {{uuid}}

Status:    {{status}}
Priority:  {{prio}}
Scheduled: {{sched}}
Hidden:    {{hidden}}
Due:       {{due}}

{{text}}
"""