mirror of
https://github.com/soywod/himalaya.git
synced 2025-04-21 16:53:39 +00:00
8cdeba62a1
* doc: fix blur in list msg screenshots (#181) * fix a typo in mbox arg (#245) `targetted` to `targeted` 👌🏻 * make inbox, sent and drafts folder customizable (#246) * mbox: make inbox, sent and drafts folder customizable * msg: update send handler parameters order * vim: fix extracting message ids from list (#247) The current method doesn't work because the list uses a fancy line character (`│`) as the separator, not a regular pipe character (`|`). Matching for the first number in the line instead solves the problem and will continue to work regardless of what separator is used. * add new line after printing strings (#251) * init cargo workspace (#252) * init cargo workspaces * nix: fix assets path * doc: update rtp vim plugin * vim: add error message if loading vim plugin from vim/ * init sub crates (#253) * init sub crates * doc: update readme * doc: improve main readme * doc: add links, add missing crate task * doc: update emojis * update cargo lock * implement contact completion with completefunc (#250) This allows users to define a command for contact completion with `g:himalaya_complete_contact_cmd` and trigger it with `<C-x><C-u>` when writing an email. * fix clippy lints (#255) * revert cargo workspace feature * fix nix run (#274) * replace cargo2nix by naersk * add rust-analyzer and rustfmt to nix build inputs * remove wiki from git submodules, update changelog * fix missing range when fetch fails, add more logs (#276) * add missing fix in changelog * remove blank lines and spaces from plain parts (#280) * fix watch command (#271) * remove also tabs from text parts (#280) * pin native-tls minor version (#278) * improve msg sanitization (#280) * fix mbox vim plugin telescope preview (#249) * bump version v0.5.2 * update changelog Co-authored-by: Austin Traver <austintraver@gmail.com> Co-authored-by: Jason Cox <dev@jasoncarloscox.com> Co-authored-by: Gökmen Görgen <gkmngrgn@gmail.com> Co-authored-by: Ethiraric <ethiraric@gmail.com>
126 lines
5.6 KiB
Text
126 lines
5.6 KiB
Text
*himalaya.txt* - Command-line interface for email management
|
|
|
|
_/ _/ _/_/_/ _/ _/ _/_/ _/ _/_/ _/ _/ _/_/
|
|
_/ _/ _/ _/_/ _/_/ _/ _/ _/ _/ _/ _/ _/ _/ _/
|
|
_/_/_/_/ _/ _/ _/ _/ _/_/_/_/ _/ _/_/_/_/ _/ _/_/_/_/
|
|
_/ _/ _/ _/ _/ _/ _/ _/ _/ _/ _/ _/ _/
|
|
_/ _/ _/_/_/ _/ _/ _/ _/ _/_/_/ _/ _/ _/ _/ _/
|
|
|
|
==============================================================================
|
|
TABLE OF CONTENTS *himalaya* *himalaya-contents*
|
|
|
|
Requirements ....................................... |himalaya-requirements|
|
|
Configuration ..................................... |himalaya-configuration|
|
|
Usage ..................................................... |himalaya-usage|
|
|
License ................................................. |himalaya-license|
|
|
|
|
==============================================================================
|
|
REQUIREMENTS *himalaya-requirements*
|
|
|
|
- Vim or Neovim
|
|
- Himalaya CLI {1}
|
|
https://github.com/soywod/himalaya#installation {1}
|
|
|
|
==============================================================================
|
|
CONFIGURATION *himalaya-configuration*
|
|
|
|
------------------------------------------------------------------------------
|
|
MAILBOX PICKER PROVIDER
|
|
>
|
|
let g:himalaya_mailbox_picker = 'native' | 'fzf' | 'telescope'
|
|
<
|
|
Defines the provider used for picking mailboxes:
|
|
|
|
- `native`: a vim native input
|
|
- `fzf`: https://github.com/junegunn/fzf.vim
|
|
- `telescope`: https://github.com/nvim-telescope/telescope.nvim
|
|
|
|
If no value given, the first loaded (and available) provider will be used (fzf
|
|
> telescope > native).
|
|
|
|
------------------------------------------------------------------------------
|
|
TELESCOPE PREVIEW
|
|
>
|
|
let g:himalaya_telescope_preview_enabled = 0
|
|
<
|
|
Should enable telescope preview when picking a mailbox with the telescope
|
|
provider.
|
|
|
|
------------------------------------------------------------------------------
|
|
CONTACT COMPLETION
|
|
>
|
|
let g:himalaya_complete_contact_cmd = '<your completion command>'
|
|
<
|
|
Define the command to use for contact completion. When this is set,
|
|
'completefunc' will be set when composing messages so that contacts can be
|
|
completed with |i_CTRL-X_CTRL-U|.
|
|
|
|
The command must print each possible result on its own line. Each line must
|
|
contain tab-separated fields; the first must be the email address, and the
|
|
second, if present, must be the name. `%s` in the command will be replaced
|
|
with the search query.
|
|
|
|
For example, to complete contacts with khard, you could use
|
|
`khard email --remove-first-line --parsable '%s'` as the completion command.
|
|
|
|
==============================================================================
|
|
USAGE *himalaya-usage*
|
|
|
|
It is recommanded to first read the Himalaya CLI documentation {1} to
|
|
understand the concept and to configure it properly.
|
|
|
|
Then, to list your emails:
|
|
>
|
|
:Himalaya
|
|
<
|
|
Change the current mbox gm
|
|
Show previous page gp
|
|
Show next page gn
|
|
Read focused msg <Enter>
|
|
Write a new msg gw
|
|
Reply to the focused msg gr
|
|
Reply all to the focused msg gR
|
|
Forward the focused message gf
|
|
Download attachments from focused message ga
|
|
Copy the focused message gC
|
|
Move the focused message gM
|
|
Delete the focused message(s) gD
|
|
|
|
https://github.com/soywod/himalaya#readme {1}
|
|
|
|
==============================================================================
|
|
LICENSE *himalaya-license*
|
|
|
|
Copyright © 2020,2021 Clément DOUIN (AKA soywod) <clement.douin@posteo.net>
|
|
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are met:
|
|
|
|
* Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
|
|
* Redistributions in binary form must reproduce the above
|
|
copyright notice, this list of conditions and the following
|
|
disclaimer in the documentation and/or other materials provided
|
|
with the distribution.
|
|
|
|
* Neither the name of Author name here nor the names of other
|
|
contributors may be used to endorse or promote products derived
|
|
from this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
==============================================================================
|
|
vim:tw=78:ts=4:ft=help:norl:
|