1EMAIL2NCID(1)         User Contributed Perl Documentation        EMAIL2NCID(1)
2
3
4

NAME

6       email2ncid - convert an email to an NCID message
7

SYNOPSIS

9        email2ncid [--configfile    | -C <filename>]
10                   [--hostname-flag | -H <0|1>]
11                   [--help          | -h]
12                   [--man           | -m]
13                   [--notify        | -N <0|1>]
14                   [--ncidserver    | -n <[host][:port]>]
15                   [--test          | -t <1-9>]
16                   [--version       | -V]
17

DESCRIPTION

19       The email2ncid gateway sends the contents of an email to the NCID
20       server as one line.  It is called from a .procmailrc file when an email
21       contains the line: Subject: NCID Message
22
23       The email2ncid gateway has an option to only send an email subject line
24       to the NCID server.  It is called from a .procmailrc file when the
25       email address or name matches on the email "From:" line.
26
27       The email must be in either plain text, or HTML and plain text.  The
28       output of email2ncid is a one line NCID message sent to an NCID server.
29

OPTIONS

31       -C, --configfile <filename>
32           Specifies the configuration file to use.  The program will still
33           run if a configuration file is not found.
34
35       -H <0|1>, --hostname-flag <0|1>
36           When the hostname flag is set to 1, the IDENT string sent to a
37           server will include the hostname with the program name.
38
39           Default: 0
40
41       -h, --help
42           Displays the help message and exits.
43
44       -m, --man
45           Displays the manual page and exits.
46
47       -N <0|1>, --notify <0|1>
48           This option sends a message to NCID containing only the subject
49           line instead of the email contents as one line.  It is a
50           notification of some type:
51
52               * visitor arrived at a gate in a gated community
53               * an important email arrived
54
55       -n <[host][:port]>, --ncidserver <[host][:port]>
56           Specifies the NCID server.  Port may be specified by suffixing the
57           hostname with :<port>.
58
59           Input must be <host:port> or <host>, or <:host>
60
61       -t <1-9>, --test <1-9>
62           Test mode connects to the server and displays some information and
63           the message.  It does not send the message to the server.  Set the
64           level to a higher number for more information.  Levels range from 1
65           to 9, but not all levels are used.
66
67               test = 1: show some variables and generated message
68               test = 2: additionally show 2 or 3 lines returned by server
69               test = 3: additionally show the email message
70
71           Default: no test mode
72
73       -V, --version
74           Displays the version.
75

REQUIREMENTS

77       The NCID server
78           http://ncid.sourceforge.net/ncid/ncid.html
79
80       A dynamic DNS service:
81           ChangeIP (https://www.changeip.com/dns.php)
82
83           Dynu     (https://www.dynu.com)
84
85           DynDNS   (https://www.dyn.com)
86
87       A Mail Transport Agent (MTA):
88           exim, postfix, sendmail, etc.
89
90       firewall:
91           Forward port 25 TCP/UDP to the computer running the MTA
92
93       procmail:
94           $HOME/.procmailrc must be created or updated to call email2ncid.
95
96           Execute the following command to automate this process:
97
98               ncid-setup email2ncid
99
100       Perl
101           perl 5.6 or higher, perl(Config::Simple)
102

FILES

104       /etc/ncid/email2ncid.conf
105
106       $HOME/.procmailrc
107

SEE ALSO

109       email2ncid.conf.5, ncid-email2ncid-setup.1, ncidd.8, ncid.conf.5,
110       ncid_gateways.7
111
112
113
114perl v5.36.1                      2023-10-03                     EMAIL2NCID(1)
Impressum