README
README.md
1# distribution Mail-Transport
2
3 * My extended documentation: <http://perl.overmeer.net/CPAN/>
4 * Development via GitHub: <https://github.com/markov2/perl5-Mail-Transport>
5 * Download from CPAN: <ftp://ftp.cpan.org/pub/CPAN/authors/id/M/MA/MARKOV/>
6 * Indexed from CPAN: <https://metacpan.org/release/Mail-Transport>
7
8Until release 3.0, this module was an integral part of the Mail-Box
9distribution. This distribution is dedicate to sending email messages
10via various Mail Transfer Agents (MTAs) like postfix or exim.
11
12It is part of the MailBox collection of modules, however: you are not
13limited to "Mail::Message" messages.
14
15## Development → Release
16
17Important to know, is that I use an extension on POD to write the manuals.
18The "raw" unprocessed version is visible on GitHub. It will run without
19problems, but does not contain manual-pages.
20
21Releases to CPAN are different: "raw" documentation gets removed from
22the code and translated into real POD and clean HTML. This reformatting
23is implemented with the OODoc distribution (A name I chose before OpenOffice
24existed, sorry for the confusion)
25
26Clone from github for the "raw" version. For instance, when you want
27to contribute a new feature.
28
29On github, you can find the processed version for each release. But the
30better source is CPAN; to get it installed simply run:
31
32```sh
33 cpan -i Mail::Transport
34```
35
36## Contributing
37
38When you want to contribute to this module, you do not need to provide
39a perfect patch... actually: it is nearly impossible to create a patch
40which I will merge without modification. Usually, I need to adapt the
41style of code and documentation to my own strict rules.
42
43When you submit an extension, please contribute a set with
44
451. code
46
472. code documentation
48
493. regression tests in t/
50
51**Please note:**
52When you contribute in any way, you agree to transfer the copyrights to
53Mark Overmeer (you will get the honors in the code and/or ChangeLog).
54You also automatically agree that your contribution is released under
55the same license as this project: licensed as perl itself.
56
57## Copyright and License
58
59This project is free software; you can redistribute it and/or modify it
60under the same terms as Perl itself.
61See <http://dev.perl.org/licenses/>
62