Update README.md to satisfy PiPy

This commit is contained in:
Stuart D. Gathman
2021-12-31 00:49:54 -05:00
parent 102e042a38
commit c73b533acb
2 changed files with 20 additions and 19 deletions
+19 -19
View File
@@ -36,9 +36,9 @@ milter used in production.
[a] This is for a quick test. Your sendmail.cf in most distros will get [a] This is for a quick test. Your sendmail.cf in most distros will get
overwritten whenever sendmail.mc is updated. To make a milter permanent, overwritten whenever sendmail.mc is updated. To make a milter permanent,
add something like: add something like:
```
INPUT_MAIL_FILTER(`pythonfilter', `S=local:/home/username/pythonsock, F=T, T=C:5m;S:20s;R:5m;E:5m') INPUT_MAIL_FILTER(`pythonfilter', `S=local:/home/username/pythonsock, F=T, T=C:5m;S:20s;R:5m;E:5m')
```
to sendmail.mc instead. to sendmail.mc instead.
# Not-so-quick Installation # Not-so-quick Installation
@@ -79,11 +79,11 @@ NB: The name is specified in two places: here, in sendmail's cf file, and
in the milter itself. Make sure the two match. in the milter itself. Make sure the two match.
NB: The above lines can be added in your .mc file with this line: NB: The above lines can be added in your .mc file with this line:
```
INPUT_MAIL_FILTER(`pythonfilter', `S=local:/home/username/pythonsock') INPUT_MAIL_FILTER(`pythonfilter', `S=local:/home/username/pythonsock')
```
For versions of sendmail prior to 8.12, you will need to enable For versions of sendmail prior to 8.12, you will need to enable
_FFR_MILTER for the cf macros. For example, `_FFR_MILTER` for the cf macros. For example,
m4 -D_FFR_MILTER ../m4/cf.m4 myconfig.mc > myconfig.cf m4 -D_FFR_MILTER ../m4/cf.m4 myconfig.mc > myconfig.cf
@@ -94,9 +94,9 @@ and if sendmail was compiled with IPv6 support. To determine if your
sendmail supports IPv6, run "sendmail -d0" and check for the NETINET6 sendmail supports IPv6, run "sendmail -d0" and check for the NETINET6
compilation option. To compile sendmail with IPv6 support, add this compilation option. To compile sendmail with IPv6 support, add this
declaration to your site.config.m4 before building it: declaration to your site.config.m4 before building it:
```
APPENDDEF(`confENVDEF', `-DNETINET6=1') APPENDDEF(`confENVDEF', `-DNETINET6=1')
```
IPv6 support can show up in two places; the communications socket IPv6 support can show up in two places; the communications socket
between the milter and sendmail processes and in the host address between the milter and sendmail processes and in the host address
argument to the connect() callback method. argument to the connect() callback method.
@@ -107,10 +107,10 @@ want to allow both IPv4 and IPv6 connections, some operating systems
will require that each listens to different port numbers. For an will require that each listens to different port numbers. For an
IPv6-only setup, your sendmail configuration should contain a line IPv6-only setup, your sendmail configuration should contain a line
similar to (first line is for sendmail.mc, second is sendmail.cf): similar to (first line is for sendmail.mc, second is sendmail.cf):
```
DAEMON_OPTIONS(`Name=MTA-v6, Family=inet6, Modify=C, Port=25') DAEMON_OPTIONS(`Name=MTA-v6, Family=inet6, Modify=C, Port=25')
O DaemonPortOptions=Name=MTA-v6, Family=inet6, Modify=C, Port=25 O DaemonPortOptions=Name=MTA-v6, Family=inet6, Modify=C, Port=25
```
To allow sendmail and the milter process to communicate with each To allow sendmail and the milter process to communicate with each
other over IPv6, you may use the "inet6" socket name prefix, as in: other over IPv6, you may use the "inet6" socket name prefix, as in:
@@ -122,19 +122,19 @@ that the type of this value is dependent upon the protocol family, and
is not compatible with IPv4 connections. Therefore you should always is not compatible with IPv4 connections. Therefore you should always
check the family argument before attempting to use the hostaddr check the family argument before attempting to use the hostaddr
argument. A quick example showing this follows: argument. A quick example showing this follows:
```
import socket import socket
...
class ipv6awareMilter(Milter.Milter): class ipv6awareMilter(Milter.Milter):
...
def connect(self,hostname,family,hostaddr): def connect(self,hostname,family,hostaddr):
if family==socket.AF_INET: if family==socket.AF_INET:
ipaddress, port = hostaddr ipaddress, port = hostaddr
elif family==socket.AF_INET6: elif family==socket.AF_INET6:
ip6address, port, flowinfo, scopeid = hostaddr ip6address, port, flowinfo, scopeid = hostaddr
elif family==socket.AF_UNIX: elif family==socket.AF_UNIX:
socketpath = hostaddr socketpath = hostaddr
```
The hostname argument is always safe to use without interpreting the The hostname argument is always safe to use without interpreting the
protocol family. For IPv6 connections for which the hostname can not protocol family. For IPv6 connections for which the hostname can not
be determined the hostname will appear similar to the string be determined the hostname will appear similar to the string
+1
View File
@@ -20,6 +20,7 @@ modules = ["mime"]
setup(name = "pymilter", version = '1.0.5', setup(name = "pymilter", version = '1.0.5',
description="Python interface to sendmail milter API", description="Python interface to sendmail milter API",
long_description=long_description, long_description=long_description,
long_description_content_type='text/markdown',
author="Jim Niemira", author="Jim Niemira",
author_email="urmane@urmane.org", author_email="urmane@urmane.org",
maintainer="Stuart D. Gathman", maintainer="Stuart D. Gathman",