Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve help text for Maildir folder #24

Open
jugmac00 opened this issue Dec 19, 2019 · 2 comments
Open

Improve help text for Maildir folder #24

jugmac00 opened this issue Dec 19, 2019 · 2 comments

Comments

@jugmac00
Copy link
Member

When your Queue directory is misconfigured, you see two messages in ZMI.

  1. This must be a Maildir folder directly below the input field
  2. n/a - /chosen/path/to/mailhost is not a maildir - please verify your configuration at the bottom of the page

I'd like to improve the wording and maybe also the exception handling, as the message is not really clear and possibly suggests you would have to know how to create a valid Maildir folder (with the typical subfolders yourself.

The new text should mention that the directory gets created automatically (as far as I remember) as long as you choose an existing path but a name for a directory which not exists.
Ie when /srv/spool exists you can enter /srv/spool/maildir but not /srv/spool/a/maildir.

If nobody pushes to the front, I'd like to go for it - in the new year, though.

Opinions?

@dataflake dataflake self-assigned this Jan 6, 2020
@dataflake
Copy link
Member

I am in the code right now and will incorporate several improvements to that page. As I want to create a MailHost release I will close this issue afterwards. Please reopen or create a new issue if there's still a problem.

@jugmac00
Copy link
Member Author

jugmac00 commented Jan 7, 2020

With @dataflake 's changes applied, and when you enter an invalid directory path and hit "Save Changes"...

  • you get a confirmation message with green background (suggests success) at the top; also see screenshot
    Screenshot from 2020-01-07 11-23-18

  • no more warning at the info box for "Queue directory"

  • at the bottom of the page you still see n/a - /chosen/path/to/mailhost is not a maildir - please verify your configuration

Some thoughts:

  • either prevent "deep" directories (where also parent directories have to be created, e.g. if /var/spool/ exists allow /var/spool/maildir but not /var/spool/parent/maildir which results in n/a - /chosen/path/to/mailhost is not a maildir - please verify your configuration) or update the underlying code to create "deep" directories similar to mkdir -p
  • depending on above bullet point, adjust the current message "otherwise the directory will be created for you" - as it only gets created if the parent directory exists
  • do not allow to set an invalid path at all - and show an error message instead of a green "success" message
  • or at least highlight the current "warning" n/a - /chosen/path/to/mailhost is not a maildir - please verify your configuration
  • provide a link from "Maildir" e.g. to Wikipedia https://en.wikipedia.org/wiki/Maildir

@jugmac00 jugmac00 reopened this Jan 7, 2020
@dataflake dataflake removed their assignment Nov 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants