etrn(1m) - osol9

1etrn(1M)                System Administration Commands                etrn(1M)
2
3
4

NAME

6       etrn - start mail queue run
7

SYNOPSIS

9       etrn [-b] [-v] server-host [client-hosts]
10
11

DESCRIPTION

13       SMTP's  ETRN command allows an SMTP client and server to interact, giv‐
14       ing the server an opportunity to start the processing of its queues for
15       messages  to  go  to a given host. This is meant to be used in start-up
16       conditions, as well as for mail nodes that have  transient  connections
17       to their service providers.
18
19
20       The  etrn  utility  initiates an SMTP session with the host server-host
21       and sends one or more ETRN commands as follows: If no client-hosts  are
22       specified, etrn looks up every host name for which sendmail(1M) accepts
23       email and, for each name, sends an ETRN command with that name  as  the
24       argument. If any client-hosts are specified, etrn uses each of these as
25       arguments for successive ETRN commands.
26

OPTIONS

28       The following options are supported:
29
30       -b    System boot special case. Make sure localhost is  accepting  SMTP
31             connections before initiating the SMTP session with server-host.
32
33             This option is useful because it prevents race conditions between
34             sendmail(1M) accepting connections and server-host attempting  to
35             deliver  queued mail. This check is performed automatically if no
36             client-hosts are specified.
37
38
39       -v    The normal mode of operation for etrn is to do all  of  its  work
40             silently.  The  -v  option makes it verbose, which causes etrn to
41             display its conversations with the remote SMTP server.
42
43

ENVIRONMENT VARIABLES

45       No  environment  variables  are  used.  However,  at  system  start-up,
46       svc:/network/smtp:sendmail  reads  /etc/default/sendmail. In this file,
47       if the variable ETRN_HOSTS is  set,  svc:/network/smtp:sendmail  parses
48       this  variable  and invokes etrn appropriately. ETRN_HOSTS should be of
49       the form:
50
51         "s1:c1.1,c1.2        s2:c2.1 s3:c3.1,c3.2,c3.3"
52
53
54
55
56       That is, white-space separated groups of server:client where client can
57       be  one  or  more  comma-separated names. The :client part is optional.
58       server is the name of the server to prod; a mail queue run is requested
59       for each client name. This is comparable to running:
60
61         /usr/lib/sendmail -qR client
62
63
64
65
66       on the host server.
67

EXAMPLES

69       Example 1 Using etrn
70
71
72       Inserting the line:
73
74
75         ETRN_HOSTS="s1.domain.com:clnt.domain.com s2.domain.com:clnt.domain.com"
76
77
78
79
80       in /etc/default/sendmail results in svc:/network/smtp:sendmail invoking
81       etrn such that  ETRN  commands  are  sent  to  both  s1.domain.com  and
82       s2.domain.com, with both having clnt.domain.com as the ETRN argument.
83
84
85
86       The line:
87
88
89         ETRN_HOSTS="server.domain.com:client1.domain.com,client2.domain.com"
90
91
92
93
94       results  in two ETRN commands being sent to server.domain.com, one with
95       the  argument  client1.domain.com,  the   other   with   the   argument
96       client2.domain.com.
97
98
99
100       The line:
101
102
103         ETRN_HOSTS="server1.domain.com server2.domain.com"
104
105
106
107
108       results in set of a ETRN commands being sent to both server1.domain.com
109       and server2.domain.com; each set contains one  ETRN  command  for  each
110       host  name for which sendmail(1M) accepts email, with that host name as
111       the argument.
112
113

FILES

115       /etc/mail/sendmail.cf    sendmail configuration file
116
117
118       /etc/default/sendmail    Variables used by svc:/network/smtp:sendmail
119
120

ATTRIBUTES

122       See attributes(5) for descriptions of the following attributes:
123
124
125
126
127       ┌─────────────────────────────┬─────────────────────────────┐
128       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
129       ├─────────────────────────────┼─────────────────────────────┤
130       │Availability                 │SUNWsndmu                    │
131       ├─────────────────────────────┼─────────────────────────────┤
132       │Interface Stability          │Stable                       │
133       └─────────────────────────────┴─────────────────────────────┘
134

NOTES

142       Not all SMTP servers support ETRN.
143
144
145
146SunOS 5.11                        10 Aug 2004                         etrn(1M)