From 88f4eac845d76c4806aba7cd95ab28849fa5a2cd Mon Sep 17 00:00:00 2001 From: wsdjeg Date: Tue, 22 Mar 2022 18:52:13 +0800 Subject: [PATCH] docs(mail): add doc for `mail` layer --- docs/layers/mail.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/layers/mail.md diff --git a/docs/layers/mail.md b/docs/layers/mail.md new file mode 100644 index 000000000..2a8ad8832 --- /dev/null +++ b/docs/layers/mail.md @@ -0,0 +1,37 @@ +--- +title: "SpaceVim mail layer" +description: "mail layer provides basic mail client for SpaceVim." +--- + +# [Available Layers](../) >> mail + + + +- [Description](#description) +- [Layer options](#layer-options) +- [Key Mappings](#key-mappings) + + + +## Description + +The `mail` layer provides basic function to connected to mail server. +To use this configuration layer, add the following snippet to your custom configuration file. + +```toml +[[layers]] + name = "mail" +``` + +## Layer options + +1. `imap_host`: set the imap server host +2. `imap_port`: set the imap server port +3. `imap_login`: set the login of imap server +4. `imap_password`: set the password of imap server + +## Key Mappings + +| Key Bingding | Description | +| ------------ | ---------------- | +| `SPC a m` | open mail client |