diff options
Diffstat (limited to 'docs/source/configuration/accounts_table')
| -rw-r--r-- | docs/source/configuration/accounts_table | 182 |
1 files changed, 91 insertions, 91 deletions
diff --git a/docs/source/configuration/accounts_table b/docs/source/configuration/accounts_table index 33c554a3..0fca90ff 100644 --- a/docs/source/configuration/accounts_table +++ b/docs/source/configuration/accounts_table @@ -13,24 +13,6 @@ :type: string -.. _realname: - -.. describe:: realname - - used to format the (proposed) From-header in outgoing mails - - :type: string - -.. _aliases: - -.. describe:: aliases - - used to clear your addresses/ match account when formatting replies - - :type: string list - :default: , - - .. _alias-regexp: .. describe:: alias_regexp @@ -41,28 +23,29 @@ :default: None -.. _sendmail-command: +.. _aliases: -.. describe:: sendmail_command +.. describe:: aliases - sendmail command. This is the shell command used to send out mails via the sendmail protocol + used to clear your addresses/ match account when formatting replies - :type: string - :default: "sendmail -t" + :type: string list + :default: , -.. _sent-box: +.. _case-sensitive-username: -.. describe:: sent_box +.. describe:: case_sensitive_username - where to store outgoing mails, e.g. `maildir:///home/you/mail/Sent`. - You can use mbox, maildir, mh, babyl and mmdf in the protocol part of the URL. + Whether the server treats the address as case-senstive or + case-insensitve (True for the former, False for the latter) - .. note:: If you want to add outgoing mails automatically to the notmuch index - you must use maildir in a path within your notmuch database path. + .. note:: The vast majority (if not all) SMTP servers in modern use + treat usernames as case insenstive, you should only set + this if you know that you need it. - :type: mail_container - :default: None + :type: boolean + :default: False .. _draft-box: @@ -80,59 +63,6 @@ :default: None -.. _sent-tags: - -.. describe:: sent_tags - - list of tags to automatically add to outgoing messages - - :type: string list - :default: sent, - - -.. _signature: - -.. describe:: signature - - path to signature file that gets attached to all outgoing mails from this account, optionally - renamed to :ref:`signature_filename <signature-filename>`. - - :type: string - :default: None - - -.. _signature-as-attachment: - -.. describe:: signature_as_attachment - - attach signature file if set to True, append its content (mimetype text) - to the body text if set to False. - - :type: boolean - :default: False - - -.. _signature-filename: - -.. describe:: signature_filename - - signature file's name as it appears in outgoing mails if - :ref:`signature_as_attachment <signature-as-attachment>` is set to True - - :type: string - :default: None - - -.. _sign-by-default: - -.. describe:: sign_by_default - - Outgoing messages will be GPG signed by default if this is set to True. - - :type: boolean - :default: False - - .. _encrypt-by-default: .. describe:: encrypt_by_default @@ -184,17 +114,87 @@ :default: None -.. _case-sensitive-username: +.. _realname: -.. describe:: case_sensitive_username +.. describe:: realname - Whether the server treats the address as case-senstive or - case-insensitve (True for the former, False for the latter) + used to format the (proposed) From-header in outgoing mails - .. note:: The vast majority (if not all) SMTP servers in modern use - treat usernames as case insenstive, you should only set - this if you know that you need it. + :type: string + +.. _sendmail-command: + +.. describe:: sendmail_command + + sendmail command. This is the shell command used to send out mails via the sendmail protocol + + :type: string + :default: "sendmail -t" + + +.. _sent-box: + +.. describe:: sent_box + + where to store outgoing mails, e.g. `maildir:///home/you/mail/Sent`. + You can use mbox, maildir, mh, babyl and mmdf in the protocol part of the URL. + + .. note:: If you want to add outgoing mails automatically to the notmuch index + you must use maildir in a path within your notmuch database path. + + :type: mail_container + :default: None + + +.. _sent-tags: + +.. describe:: sent_tags + + list of tags to automatically add to outgoing messages + + :type: string list + :default: sent, + + +.. _sign-by-default: + +.. describe:: sign_by_default + + Outgoing messages will be GPG signed by default if this is set to True. :type: boolean :default: False + +.. _signature: + +.. describe:: signature + + path to signature file that gets attached to all outgoing mails from this account, optionally + renamed to :ref:`signature_filename <signature-filename>`. + + :type: string + :default: None + + +.. _signature-as-attachment: + +.. describe:: signature_as_attachment + + attach signature file if set to True, append its content (mimetype text) + to the body text if set to False. + + :type: boolean + :default: False + + +.. _signature-filename: + +.. describe:: signature_filename + + signature file's name as it appears in outgoing mails if + :ref:`signature_as_attachment <signature-as-attachment>` is set to True + + :type: string + :default: None + |