alx/mu4e
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mu4e-folders: update docstrings

Browse Source
This commit is contained in:
Dirk-Jan C. Binnema
2025-04-23 07:45:34 +03:00
parent 9cd4d73212
commit ddc5d00efc
1 changed files with 21 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
mu4e/mu4e-folders.el
View File

@ -1,6 +1,6 @@
;;; mu4e-folders.el --- Maildirs & folders -*- lexical-binding: t -*- ;;; mu4e-folders.el --- Maildirs & folders -*- lexical-binding: t -*-
;; Copyright (C) 2021-2024 Dirk-Jan C. Binnema ;; Copyright (C) 2021-2025 Dirk-Jan C. Binnema
;; Author: Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> ;; Author: Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
;; Maintainer: Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> ;; Maintainer: Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
@ -36,36 +36,40 @@
(defcustom mu4e-drafts-folder "/drafts" (defcustom mu4e-drafts-folder "/drafts"
"Folder for draft messages, relative to the root maildir. "Folder for draft messages, relative to the root maildir.
For instance, \"/drafts\". For instance, \"/drafts\".
Instead of a string, may also be a function that takes a Instead of a string, can also be a function that takes a
message (a msg plist, see `mu4e-message-field'), and returns a message (a msg plist, see `mu4e-message-field'), and returns a
folder. Note, the message parameter refers to the original folder. Note, the message parameter refers to the original
message being replied to / being forwarded / re-edited and is nil message being replied to / being forwarded / re-edited and is nil
otherwise. `mu4e-drafts-folder' is only evaluated once. otherwise.
The form of draft messages is not necessarily compatible with `mu4e-drafts-folder' is only evaluated once.
other e-mail programs, e.g. when it involves attachments and the
like. Note: the format of draft messages is not necessarily fully
" compatible with other e-mail programs, e.g. when it involves
attachments or other MIME-parts."
:type '(choice :type '(choice
(string :tag "Folder name") (string :tag "Folder name")
(function :tag "Function return folder name")) (function :tag "Function which returns a folder name"))
:group 'mu4e-folders) :group 'mu4e-folders)
(defcustom mu4e-refile-folder "/archive" (defcustom mu4e-refile-folder "/archive"
"Folder for refiling messages, relative to the root maildir. "Folder for refiling, relative to the root maildir.
For instance \"/Archive\". Instead of a string, may also be a For instance \"/Archive\". Instead of a string, may also be a
function that takes a message (a msg plist, see function that takes a message (a msg plist, see
`mu4e-message-field'), and returns a folder. Note that the `mu4e-message-field'), and returns a folder. Note that the
message parameter refers to the message-at-point." message parameter refers to the message-at-point."
:type '(choice :type '(choice
(string :tag "Folder name") (string :tag "Folder name")
(function :tag "Function return folder name")) (function :tag "Function which returns a folder name"))
:group 'mu4e-folders) :group 'mu4e-folders)
(defcustom mu4e-sent-folder "/sent" (defcustom mu4e-sent-folder "/sent"
"Folder for sent messages, relative to the root maildir. "Folder for sent messages, relative to the root maildir.
For instance, \"/Sent Items\". Instead of a string, may also be a For instance, \"/Sent Items\". Instead of a string, may also be a
function that takes a message (a msg plist, see function that takes a message (a msg plist, see
`mu4e-message-field'), and returns a folder. Note that the `mu4e-message-field'), and returns a folder. Note that the
@ -73,23 +77,25 @@ message parameter refers to the original message being replied to
/ being forwarded / re-edited, and is nil otherwise." / being forwarded / re-edited, and is nil otherwise."
:type '(choice :type '(choice
(string :tag "Folder name") (string :tag "Folder name")
(function :tag "Function return folder name")) (function :tag "Function which returns a folder name"))
:group 'mu4e-folders) :group 'mu4e-folders)
(defcustom mu4e-trash-folder "/trash" (defcustom mu4e-trash-folder "/trash"
"Folder for trashed messages, relative to the root maildir. "Folder for trashed messages, relative to the root maildir.
For instance, \"/trash\". Instead of a string, may also be a For instance, \"/trash\". Instead of a string, may also be a
function that takes a message (a msg plist, see function that takes a message (a msg plist, see
`mu4e-message-field'), and returns a folder. When using `mu4e-message-field'), and returns a folder.
`mu4e-trash-folder' in the headers view (when marking messages
for trash). Note that the message parameter refers to the When using `mu4e-trash-folder' in the headers view (when marking
messages for trash), the message parameter refers to the
message-at-point. When using it when composing a message (see message-at-point. When using it when composing a message (see
`mu4e-sent-messages-behavior'), this refers to the original `mu4e-sent-messages-behavior'), this refers to the original
message being replied to / being forwarded / re-edited, and is message being replied to / being forwarded / re-edited, and is
nil otherwise." nil otherwise."
:type '(choice :type '(choice
(string :tag "Folder name") (string :tag "Folder name")
(function :tag "Function return folder name")) (function :tag "Function which returns a folder name"))
:group 'mu4e-folders) :group 'mu4e-folders)
(defcustom mu4e-maildir-shortcuts nil (defcustom mu4e-maildir-shortcuts nil