Opened 7 years ago

Closed 7 years ago

Last modified 3 years ago

#5922 enhancement closed fixed (fixed)

twistd mail needs better usage doc

Reported by: Matt Owned by:
Priority: normal Milestone:
Component: mail Keywords:
Cc: Branch: branches/mail-tap-usage-5922
branch-diff, diff-cov, branch-cov, buildbot
Author: jerub

Description

twistd mail --help doesn't make it obvious how domains work or how to get a useful smtp server running. A simple example would probably help a lot.

Attachments (2)

twistd-mail-usage.patch (772 bytes) - added by Matt 7 years ago.
improved twistd mail doc
twistd-mail-usage-5922.patch (1.6 KB) - added by Richard Wall 7 years ago.
A slightly more verbose documentation update

Download all attachments as: .zip

Change History (9)

Changed 7 years ago by Matt

Attachment: twistd-mail-usage.patch added

improved twistd mail doc

comment:1 Changed 7 years ago by Thijs Triemstra

Component: coremail

Changed 7 years ago by Richard Wall

A slightly more verbose documentation update

comment:2 Changed 7 years ago by Richard Wall

This started as a code review of the first patch, but it was interesting to use the twistd mail plugin for the first time and I have ended up creating a second patch.

I certainly think that the first patch makes the mail plugin easier to use.

I have added an Example heading and added an example of running a simple mail relay.

Also added some documentation directly to the --maildirdbmdomain option explaining the format of the required argument.

comment:3 Changed 7 years ago by Stephen Thorne

Author: jerub
Branch: branches/mail-tap-usage-5922

(In [35759]) New branch for bug #5922.

comment:4 Changed 7 years ago by Stephen Thorne

(In [35761]) Apply twistd-mail-usage-5922.patch from #5922 by rwall based on magmatt's original patch.

Refs #5922

comment:5 Changed 7 years ago by Stephen Thorne

(In [35765]) Update example commandlines for the 'mail' twistd plugin to use the long format descriptions.

Refs #5922

comment:6 Changed 7 years ago by Stephen Thorne

Resolution: fixed
Status: newclosed

(In [35767]) Merge mail-tap-usage-5922: Update documentation on 'mail' twistd plugin

Author: magmatt, rwall Reviewer: jerub Fixes: #5922

twistd mail --help output now gives some helpful example usage.

comment:7 Changed 3 years ago by hawkowl

Keywords: review removed

[mass edit] Removing review from closed tickets.

Note: See TracTickets for help on using tickets.