Skip to content

README.md

Latest commit

 

History

History
99 lines (74 loc) · 2.34 KB

README.md

File metadata and controls

99 lines (74 loc) · 2.34 KB

rustmail.nvim

Neovim client for RustMail — browse captured emails without leaving your editor.

License

rustmail.nvim — message list and detail view inside Neovim

Requirements

  • Neovim >= 0.10
  • rustmail binary on PATH (or specify path in config)
  • curl on PATH (only needed when auto_start = true)

Install

lazy.nvim

{
  "rustmailapp/rustmail.nvim",
  cmd = "RustMail",
  keys = {
    { "<leader>rm", "<cmd>RustMail toggle<cr>", desc = "Toggle RustMail" },
  },
  opts = {},
}

packer.nvim

use {
  "rustmailapp/rustmail.nvim",
  config = function()
    require("rustmail").setup()
  end,
}

Configuration

require("rustmail").setup({
  host = "127.0.0.1",
  port = 8025,
  smtp_port = 1025,
  auto_start = false,
  binary = "rustmail",
  layout = "float",
  float = {
    width = 0.9,
    height = 0.9,
    border = "rounded",
  },
  toggle_keymap = false,
})

All options and their defaults: :help rustmail-config

Usage

Command Description
:RustMail Open the TUI
:RustMail toggle Toggle the TUI window
:RustMail close Close the TUI window
:RustMail stop Stop the auto-started daemon

Keymaps

Message List — <CR> open, dd delete, mr toggle read, ms toggle star, R refresh, / search, D delete all, q close

Message Detail — <BS> back, dd delete, mr toggle read, ms toggle star, gR raw message, ga attachments, gA auth results, q close

Full keymap reference: :help rustmail-keymaps

Documentation

License

Licensed under either of:

at your option.