1 2 3 NEW SENDMAIL CONFIGURATION FILES 4 5 Eric Allman <eric@CS.Berkeley.EDU> 6 7 @(#)README 8.22 (Berkeley) 01/26/94 8 9 10This document describes the sendmail configuration files being used 11at Berkeley. These use features in the new (R8) sendmail, and although 12there is an ``OLDSENDMAIL'' mode, they haven't really been tested on 13old versions of sendmail and cannot be expected to work well. 14 15These configuration files are probably not as general as previous 16versions, and don't handle as many of the wierd cases automagically. 17I was able to simplify by them for two reasons. First, the network 18has become more consistent -- for example, at this point, everyone 19on the internet is supposed to be running a name server, so hacks to 20handle NIC-registered hosts can go away. Second, I assumed that a 21subdomain would be running SMTP internally -- UUCP is presumed to be 22a long-haul protocol. I realize that this is not universal, but it 23does describe the vast majority of sites with which I am familiar, 24including those outside the US. 25 26Of course, the downside of this is that if you do live in a wierd 27world, things are going to get wierder for you. I'm sorry about that, 28but at the time we at Berkeley had a problem, and it seemed like the 29right thing to do. 30 31This package requires a post-V7 version of m4; if you are running the 324.2bsd, SysV.2, or 7th Edition version, I suggest finding a friend with 33a newer version. You can m4-expand on their system, then run locally. 34SunOS's /usr/5bin/m4 or BSD-Net/2's m4 both work. GNU m4 version 1.1 35also works. Unfortunately, I'm told that the M4 on BSDI 1.0 doesn't 36work -- you'll have to use a Net/2 or GNU version. 37 38IF YOU DON'T HAVE A BERKELEY MAKE, don't despair! Just run 39"m4 foo.mc > foo.cf" -- that should be all you need. There is also 40a fairly crude (but functional) Makefile.dist that works on the 41old version of make. 42 43To get started, you may want to look at tcpproto.mc (for TCP-only 44sites), uucpproto.mc (for UUCP-only sites), and clientproto.mc (for 45clusters of clients using a single mail host). Others are versions 46that we use at Berkeley, although not all are in current use. For 47example, ucbarpa has gone away, but I've left ucbarpa.mc in because 48it demonstrates some interesting techniques. 49 50I'm not pretending that this README describes everything that these 51configuration files can do; clever people can probably tweak them 52to great effect. But it should get you started. 53 54******************************************************************* 55*** BE SURE YOU CUSTOMIZE THESE FILES! They have some *** 56*** Berkeley-specific assumptions built in, such as the name *** 57*** of our UUCP-relay. You'll want to create your own domain *** 58*** description, and use that in place of domain/Berkeley.m4. *** 59******************************************************************* 60 61 62+--------------------------+ 63| INTRODUCTION AND EXAMPLE | 64+--------------------------+ 65 66Configuration files are contained in the subdirectory "cf", with a 67suffix ".mc". They must be run through "m4" to produce a ".cf" file. 68 69Let's examine a typical .mc file (cf/cs-exposed.mc): 70 71 divert(-1) 72 # 73 # Copyright (c) 1983 Eric P. Allman 74 # Copyright (c) 1988 The Regents of the University of California. 75 # All rights reserved. 76 # 77 # Redistribution and use in source and binary forms are permitted 78 # provided that the above copyright notice and this paragraph are 79 # duplicated in all such forms and that any documentation, 80 # advertising materials, and other materials related to such 81 # distribution and use acknowledge that the software was developed 82 # by the University of California, Berkeley. The name of the 83 # University may not be used to endorse or promote products derived 84 # from this software without specific prior written permission. 85 # THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR 86 # IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED 87 # WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. 88 # 89 90The divert(-1) will delete the crud in the resulting output file. 91The copyright notice is what your lawyers require. Our lawyers require 92the one that I've included in my files. A copyleft is a copyright by 93another name. 94 95The next line MUST be 96 97 include(`../m4/cf.m4') 98 99This will pull in the M4 macros you will need to make sense of 100everything else. As the saying goes, don't think about it, just 101do it. If you don't do it, don't bother reading the rest of this 102file. 103 104 VERSIONID(`<SCCS or RCS version id>') 105 106VERSIONID is a macro that stuffs the version information into the 107resulting file. We use SCCS; you could use RCS, something else, or 108omit it completely. This is not the same as the version id included 109in SMTP greeting messages -- this is defined in m4/version.m4. 110 111 DOMAIN(cs.exposed) 112 113This example exposes the host inside of the CS subdomain -- that is, 114it doesn't try to hide the name of the workstation to the outside 115world. Changing this to DOMAIN(cs.hidden) would have made outgoing 116messages refer to "<username>@CS.Berkeley.EDU" instead of using the 117local hostname. Internally this is effected by using 118"MASQUERADE_AS(CS.Berkeley.EDU)". 119 120 MAILER(smtp) 121 122These describe the mailers used at the default CS site site. The 123local mailer is always included automatically. 124 125 126+--------+ 127| OSTYPE | 128+--------+ 129 130Note that cf/cs-exposed.mc omits an OSTYPE macro -- this assumes 131default Computer Science Division environment. There are several 132explicit environments available: bsd4.3, bsd4.4, hpux, irix, osf1, 133riscos4.5, sunos3.5, sunos4.1, and ultrix4.1. These change things 134like the location of the alias file and queue directory. Some of 135these files are identical to one another. 136 137Operating system definitions are easy to write. They may define 138the following variables (everything defaults, so an ostype file 139may be empty). 140 141ALIAS_FILE [/etc/aliases] The location of the text version 142 of the alias file(s). It can be a comma-separated 143 list of names. 144HELP_FILE [/usr/lib/sendmail.hf] The name of the file 145 containing information printed in response to 146 the SMTP HELP command. 147QUEUE_DIR [/var/spool/mqueue] The directory containing 148 queue files. 149STATUS_FILE [/etc/sendmail.st] The file containing status 150 information. 151LOCAL_MAILER_PATH [/bin/mail] The program used to deliver local mail. 152LOCAL_MAILER_FLAGS [rmn] The flags used by the local mailer. The 153 flags lsDFM are always included. 154LOCAL_MAILER_ARGS [mail -d $u] The arguments passed to deliver local 155 mail. 156LOCAL_SHELL_PATH [/bin/sh] The shell used to deliver piped email. 157LOCAL_SHELL_FLAGS [eu] The flags used by the shell mailer. The 158 flags lsDFM are always included. 159LOCAL_SHELL_ARGS [sh -c $u] The arguments passed to deliver "prog" 160 mail. 161USENET_MAILER_PATH [/usr/lib/news/inews] The name of the program 162 used to submit news. 163USENET_MAILER_FLAGS [rlsDFMmn] The mailer flags for the usenet mailer. 164USENET_MAILER_ARGS [-m -h -n] The command line arguments for the 165 usenet mailer. 166USENET_MAILER_MAX [100000] The maximum size of messages that will 167 be accepted by the usenet mailer. 168SMTP_MAILER_FLAGS [undefined] Flags added to SMTP mailer. Default 169 flags are `mDFMUX' (and `a' for esmtp mailer). 170SMTP_MAILER_MAX [undefined] The maximum size of messages that will 171 be transported using the smtp or esmtp mailers. 172UUCP_MAILER_FLAGS [undefined] Flags added to UUCP mailer. Default 173 flags are `DFMhuU' (and `m' for suucp mailer, minus 174 `U' for uucp-dom mailer). 175UUCP_MAILER_ARGS [uux - -r -z -a$f -gC $h!rmail ($u)] The arguments 176 passed to the UUCP mailer. 177UUCP_MAX_SIZE [100000] The maximum size message accepted for 178 transmission by the UUCP mailers. 179FAX_MAILER_PATH [/usr/local/lib/fax/mailfax] The program used to 180 submit FAX messages. 181FAX_MAILER_MAX [100000] The maximum size message accepted for 182 transmission by FAX. 183HOSTMAP_SPEC [dbm -o /etc/hostmap] The value for the builtin 184 hostmap key definition. You can redefine this 185 to change the class, flags, and filename of 186 the hostmap. The default flag (-o) makes this 187 map optional. 188 189+---------+ 190| DOMAINS | 191+---------+ 192 193You will probably want to collect domain-dependent defines into one 194file, referenced by the DOMAIN macro. For example, our Berkeley 195domain file includes definitions for several internal distinguished 196hosts: 197 198UUCP_RELAY The host that will forward UUCP-addressed email. 199 If not defined, all UUCP sites must be directly 200 connected. 201BITNET_RELAY The host that will forward BITNET-addressed email. 202 If not defined, the .BITNET pseudo-domain won't work. 203LOCAL_RELAY The site that will handle unqualified names -- that 204 is, names with out an @domain extension. If not set, 205 they are assumed to belong on this machine. This 206 allows you to have a central site to store a 207 company- or department-wide alias database. This 208 only works at small sites, and there are better 209 methods. 210 211Each of these can be either ``mailer:hostname'' (in which case the 212mailer is the internal mailer name, such as ``suucp'' and the hostname 213is the name of the host as appropriate for that mailer) or just a 214``hostname'', in which case a default mailer type (usually ``relay'', 215a variant on SMTP) is used. WARNING: if you have a wildcard MX 216record matching your domain, you probably want to define these to 217have a trailing dot so that you won't get the mail diverted back 218to yourself. 219 220The domain file can also be used to define a domain name, if needed 221(using "DD<domain>") and set certain site-wide features. If all hosts 222at your site masquerade behind one email name, you could also use 223MASQUERADE_AS here. 224 225You do not have to define a domain -- in particular, if you are a 226single machine sitting off somewhere, it is probably more work than 227it's worth. This is just a mechanism for combining "domain dependent 228knowledge" into one place. 229 230+---------+ 231| MAILERS | 232+---------+ 233 234There are fewer mailers supported in this version than the previous 235version, owing mostly to a simpler world. 236 237local The local and prog mailers. You will almost always 238 need these; the only exception is if you relay ALL 239 your mail to another site. This mailer is included 240 automatically. 241 242smtp The Simple Mail Transport Protocol mailer. This does 243 not hide hosts behind a gateway or another other 244 such hack; it assumes a world where everyone is 245 running the name server. This file actually defines 246 three mailers: "smtp" for regular (old-style) SMTP to 247 other servers, "esmtp" for extended SMTP to other 248 servers, and "relay" for transmission to our 249 RELAY_HOST or MAILER_HUB. 250 251uucp The Unix-to-Unix Copy Program mailer. Actually, this 252 defines two mailers, "uucp" and "suucp". The latter 253 is for when you know that the UUCP mailer at the other 254 end can handle multiple recipients in one transfer. 255 When you invoke this, sendmail looks for all names in 256 the $=U class and sends them to the uucp-old mailer; all 257 names in the $=Y class are sent to uucp-new; and all 258 names in the $=Z class are sent to uucp-uudom. Note that 259 this is a function of what version of rmail runs on 260 the receiving end, and hence may be out of your control. 261 If smtp is defined, it also defines "uucp-dom" and 262 "uucp-uudom" mailers that use domain-style rewriting. 263 See the section below describing UUCP mailers in more 264 detail. 265 266usenet Usenet (network news) delivery. If this is specified, 267 an extra rule is added to ruleset 0 that forwards all 268 local email for users named ``group.usenet'' to the 269 ``inews'' program. Note that this works for all groups, 270 and may be considered a security problem. 271 272fax Facsimile transmission. This is experimental and based 273 on Sam Leffler's FlexFAX software. For more information, 274 see below. 275 276pop Post Office Protocol. 277 278 279+----------+ 280| FEATURES | 281+----------+ 282 283Special features can be requested using the "FEATURE" macro. For 284example, the .mc line: 285 286 FEATURE(use_cw_file) 287 288tells sendmail that you want to have it read an /etc/sendmail.cw 289file to get values for class $=w. The FEATURE may contain a single 290optional parameter -- for example: 291 292 FEATURE(mailertable, dbm /usr/lib/mailertable) 293 294Available features are: 295 296use_cw_file Read the file /etc/sendmail.cw file to get alternate 297 names for this host. This might be used if you were 298 on a host that MXed for a dynamic set of other 299 hosts. If the set is static, just including the line 300 "Cw<name1> <name2> ..." is probably superior. 301 The actual filename can be overridden by redefining 302 confCW_FILE. 303 304redirect Reject all mail addressed to "address.REDIRECT" with 305 a ``551 User not local; please try <address>'' message. 306 If this is set, you can alias people who have left 307 to their new address with ".REDIRECT" appended. 308 309nouucp Don't do anything special with UUCP addresses at all. 310 311nocanonify Don't pass addresses to $[ ... $] for canonification. 312 This would generally only be used by sites that only 313 act as mail gateways or which have user agents that do 314 full canonification themselves. You may also want to 315 use "define(`confBIND_OPTS',`-DNSRCH -DEFNAMES')" to 316 turn off the usual resolver options that do a similar 317 thing. 318 319notsticky By default, email sent to "user@local.host" are marked 320 as "sticky" -- that is, the local addresses aren't 321 matched against UDB and don't go through ruleset 5. 322 This features disables this treatment. It would 323 normally be used on network gateway machines. 324 325mailertable Include a "mailer table" which can be used to override 326 routing for particular domains. The argument of the 327 FEATURE may be the key definition. If none is specified, 328 the definition used is: 329 hash -o /etc/mailertable 330 Keys in this database are fully qualified domain names 331 or partial domains preceded by a dot -- for example, 332 "vangogh.CS.Berkeley.EDU" or ".CS.Berkeley.EDU". 333 Values must be of the form: 334 mailer:domain 335 where "mailer" is the internal mailer name, and "domain" 336 is where to send the message. These maps are not 337 reflected into the message header. 338 339domaintable Include a "domain table" which can be used to provide 340 full domains on unqualified (single word) hosts. The 341 argument of the FEATURE may be the key definition. If 342 none is specified, the definition used is: 343 hash -o /etc/domaintable 344 The key in this table is the unqualified host name; the 345 value is the fully qualified domain. Anything in the 346 domaintable is reflected into headers; that is, this 347 is done in ruleset 3. 348 349bitdomain Look up bitnet hosts in a table to try to turn them into 350 internet addresses. The table can be built using the 351 bitdomain program contributed by John Gardiner Myers. 352 The argument of the FEATURE may be the key definition; if 353 none is specified, the definition used is: 354 hash -o /etc/bitdomain.db 355 Keys are the bitnet hostname; values are the corresponding 356 internet hostname. 357 358uucpdomain Similar feature for UUCP hosts. The default map definition 359 is: 360 hash -o /etc/uudomain.db 361 At the moment there is no automagic tool to build this 362 database. 363 364always_add_domain 365 Include the local host domain even on locally delivered 366 mail. Normally it is not added unless it is already 367 present. 368 369allmasquerade If masquerading is enabled (using MASQUERADE_AS), this 370 feature will cause recipient addresses to also masquerade 371 as being from the masquerade host. Normally they get 372 the local hostname. Although this may be right for 373 ordinary users, it can break local aliases. For example, 374 if you send to "localalias", the originating sendmail will 375 find that alias and send to all members, but send the 376 message with "To: localalias@masqueradehost". Since that 377 alias likely does not exist, replies will fail. Use this 378 feature ONLY if you can guarantee that the ENTIRE 379 namespace on your masquerade host supersets all the 380 local entries. 381 382nodns We aren't running DNS at our site (for example, 383 we are UUCP-only connected). It's hard to consider 384 this a "feature", but hey, it had to go somewhere. 385 386nullclient This is a special case -- it creates a stripped down 387 configuration file containing nothing but support for 388 forwarding all mail to a central hub via a local 389 SMTP-based network. The argument is the name of that 390 hub. 391 392 The only other feature that should be used in conjunction 393 with this one is "nocanonify" (this causes addresses to 394 be sent unqualified via the SMTP connection; normally 395 they are qualifed with the masquerade name, which 396 defaults to the name of the hub machine). No mailers 397 should be defined. No aliasing or forwarding is done. 398 399 400+-------+ 401| HACKS | 402+-------+ 403 404Some things just can't be called features. To make this clear, 405they go in the hack subdirectory and are referenced using the HACK 406macro. These will tend to be site-dependent. The release 407includes the Berkeley-dependent "cssubdomain" hack (that makes 408sendmail accept local names in either Berkeley.EDU or CS.Berkeley.EDU; 409this is intended as a short-term aid while we move hosts into 410subdomains. 411 412 413+--------------------+ 414| SITE CONFIGURATION | 415+--------------------+ 416 417Complex sites will need more local configuration information, such as 418lists of UUCP hosts they speak with directly. This can get a bit more 419tricky. For an example of a "complex" site, see cf/ucbvax.mc. 420 421The SITECONFIG macro allows you to indirectly reference site-dependent 422configuration information stored in the siteconfig subdirectory. For 423example, the line 424 425 SITECONFIG(uucp.ucbvax, ucbvax, U) 426 427reads the file uucp.ucbvax for local connection information. The 428second parameter is the local name (in this case just "ucbvax" since 429it is locally connected, and hence a UUCP hostname) and the name of 430the class in which to store the host information. Another SITECONFIG 431line reads 432 433 SITECONFIG(uucp.ucbarpa, ucbarpa.Berkeley.EDU, W) 434 435This says that the file uucp.ucbarpa contains the list of UUCP sites 436connected to ucbarpa.Berkeley.EDU. The $=W class will be used to 437store this list. [The machine ucbarpa is gone now, but I've left 438this out-of-date configuration file around to demonstrate how you 439might do this.] 440 441The siteconfig file (e.g., siteconfig/uucp.ucbvax.m4) contains nothing 442more than a sequence of SITE macros describing connectivity. For 443example: 444 445 SITE(cnmat) 446 SITE(sgi olympus) 447 448The second example demonstrates that you can use two names on the 449same line; these are usually aliases for the same host (or are at 450least in the same company). 451 452 453+--------------------+ 454| USING UUCP MAILERS | 455+--------------------+ 456 457It's hard to get UUCP mailers right because of the extremely ad hoc 458nature of UUCP addressing. These config files are really designed 459for domain-based addressing, even for UUCP sites. 460 461There are four UUCP mailers available. The choice of which one to 462use is partly a matter of local preferences and what is running at 463the other end of your UUCP connection. Unlike good protocols that 464define what will go over the wire, UUCP uses the policy that you 465should do what is right for the other end; if they change, you have 466to change. This makes it hard to do the right thing, and discourages 467people from updating their software. In general, if you can avoid 468UUCP, please do. 469 470The major choice is whether to go for a domainized scheme or a 471non-domainized scheme. This depends entirely on what the other 472end will recognize. If at all possible, you should encourage the 473other end to go to a domain-based system -- non-domainized addresses 474don't work entirely properly. 475 476The four mailers are: 477 478 uucp-old (obsolete name: "uucp") 479 This is the oldest, the worst (but the closest to UUCP) way of 480 sending messages accros UUCP connections. It does bangify 481 everything and prepends $U (your UUCP name) to the sender's 482 address (which can already be a bang path itself). It can 483 only send to one address at a time, so it spends a lot of 484 time copying duplicates of messages. Avoid this if at all 485 possible. 486 487 uucp-new (obsolete name: "suucp") 488 The same as above, except that it assumes that in one rmail 489 command you can specify several recipients. It still has a 490 lot of other problems. 491 492 uucp-dom 493 This UUCP mailer keeps everything as domain addresses. 494 Basically, it uses the SMTP mailer rewriting rules. 495 496 Unfortunately, a lot of UUCP mailer transport agents require 497 bangified addresses in the envelope, although you can use 498 domain-based addresses in the message header. (The envelope 499 shows up as the From_ line on UNIX mail.) So.... 500 501 uucp-uudom 502 This is a cross between uucp-new (for the envelope addresses) 503 and uucp-dom (for the header addresses). It bangifies the 504 envelope sender (From_ line in messages) without adding the 505 local hostname, unless there is no host name on the address 506 at all (e.g., "wolf") or the host component is a UUCP host name 507 instead of a domain name ("somehost!wolf" instead of 508 "some.dom.ain!wolf"). 509 510Examples: 511 512We are on host grasp.insa-lyon.fr (UUCP host name "grasp"). The 513following summarizes the sender rewriting for various mailers. 514 515Mailer sender rewriting in the envelope 516------ ------ ------------------------- 517uucp-{old,new} wolf grasp!wolf 518uucp-dom wolf wolf@grasp.insa-lyon.fr 519uucp-uudom wolf grasp.insa-lyon.fr!wolf 520 521uucp-{old,new} wolf@fr.net grasp!fr.net!wolf 522uucp-dom wolf@fr.net wolf@fr.net 523uucp-uudom wolf@fr.net fr.net!wolf 524 525uucp-{old,new} somehost!wolf grasp!somehost!wolf 526uucp-dom somehost!wolf somehost!wolf@grasp.insa-lyon.fr 527uucp-uudom somehost!wolf grasp.insa-lyon.fr!somehost!wolf 528 529If you are using one of the domainized UUCP mailers, you really want 530to convert all UUCP addresses to domain format -- otherwise, it will 531do it for you (and probably not the way you expected). For example, 532if you have the address foo!bar!baz (and you are not sending to foo), 533the heuristics will add the @uucp.relay.name or @local.host.name to 534this address. However, if you map foo to foo.host.name first, it 535will not add the local hostname. You can do this using the uucpdomain 536feature. 537 538 539+-------------------+ 540| TWEAKING RULESETS | 541+-------------------+ 542 543For more complex configurations, you can define special rules. 544The macro LOCAL_RULE_3 introduces rules that are used in canonicalizing 545the names. Any modifications made here are reflected in the header. 546 547A common use is to convert old UUCP addreses to SMTP addresses using 548the UUCPSMTP macro. For example: 549 550 LOCAL_RULE_3 551 UUCPSMTP(decvax, decvax.dec.com) 552 UUCPSMTP(research, research.att.com) 553 554will cause addresses of the form "decvax!user" and "research!user" 555to be converted to "user@decvax.dec.com" and "user@research.att.com" 556respectively. 557 558This could also be used to look hosts in a database map: 559 560 LOCAL_RULE_3 561 R$* < @ $+ > $* $: $1 < @ $(hostmap $2 $) > $3 562 563This map would be defined in the LOCAL_CONFIG portion, as shown below. 564 565Similarly, LOCAL_RULE_0 can be used to introduce new parsing rules. 566For example, new rules are needed to parse hostnames that you accept 567via MX records. For example, you might have: 568 569 LOCAL_RULE_0 570 R$+ < @ cnmat.Berkeley.EDU > $#uucp $@ cnmat $: $1 571 572You would use this if you had installed an MX record for cnmat.Berkeley.EDU 573pointing at this host; this rule catches the message and forwards it on 574using UUCP. 575 576You can also tweak rulesets 1 and 2 using LOCAL_RULE_1 and LOCAL_RULE_2. 577These rulesets are normally empty. 578 579A similar macro is LOCAL_CONFIG. This introduces lines added after the 580boilerplate option setting but before rulesets, and can be used to 581declare local database maps or whatever. For example: 582 583 LOCAL_CONFIG 584 Khostmap hash /etc/hostmap.db 585 Kyplocal nis -m hosts.byname 586 587 588+---------------------------+ 589| MASQUERADING AND RELAYING | 590+---------------------------+ 591 592You can have your host masquerade as another using 593 594 MASQUERADE_AS(host.domain) 595 596This causes outgoing SMTP mail to be labelled as coming from the 597indicated domain, rather than $j. One normally masquerades as one 598of your own subdomains (for example, it's unlikely that I would 599choose to masquerade as an MIT site). 600 601The masquerade name is not normally canonified, so it is important 602that it be your One True Name, that is, fully qualified and not a 603CNAME. 604 605there are always users that need to be "exposed" -- that is, their 606internal site name should be displayed instead of the masquerade name. 607Root is an example. You can add users to this list using 608 609 EXPOSED_USER(usernames) 610 611This adds users to class E; you could also use something like 612 613 FE/etc/sendmail.cE 614 615You can also arrange to relay all unqualified names (that is, names 616without @host) to a relay host. For example, if you have a central 617email server, you might relay to that host so that users don't have 618to have .forward files or aliases. You can do this using 619 620 define(`LOCAL_RELAY', mailer:hostname) 621 622The ``mailer:'' can be omitted, in which case the mailer defaults to 623"smtp". There are some user names that you don't want relayed, perhaps 624because of local aliases. A common example is root, which may be 625locally aliased. You can add entries to this list using 626 627 LOCAL_USER(usernames) 628 629This adds users to class L; you could also use something like 630 631 FL/etc/sendmail.cL 632 633If you want all incoming mail sent to a centralized hub, as for a 634shared /var/spool/mail scheme, use 635 636 define(`MAIL_HUB', mailer:hostname) 637 638Again, ``mailer:'' defaults to "smtp". If you define both LOCAL_RELAY 639and MAIL_HUB, unqualified names and names in class L will be sent to 640the LOCAL_RELAY and other local names will be sent to MAIL_HUB. For 641example, if are on machine mastodon.CS.Berkeley.EDU, the following 642combinations of settings will have the indicated effects: 643 644email sent to.... eric eric@mastodon.CS.Berkeley.EDU 645 646LOCAL_RELAY set to mail.CS.Berkeley.EDU (delivered locally) 647mail.CS.Berkeley.EDU 648 649MAIL_HUB set to mammoth.CS.Berkeley.EDU mammoth.CS.Berkeley.EDU 650mammoth.CS.Berkeley.EDU 651 652Both LOCAL_RELAY and mail.CS.Berkeley.EDU mammoth.CS.Berkeley.EDU 653MAIL_HUB set as above 654 655If you want all outgoing mail to go to a central relay site, define 656SMART_HOST as well. Briefly: 657 658 LOCAL_RELAY applies to unqualifed names (e.g., "eric"). 659 MAIL_HUB applies to names qualified with the name of the 660 local host (e.g., "eric@mastodon.CS.Berkeley.EDU"). 661 SMART_HOST applies to names qualified with other hosts. 662 663However, beware that other relays (e.g., UUCP_RELAY, BITNET_RELAY, and 664FAX_RELAY) take precedence over SMART_HOST, so if you really want 665absolutely everything to go to a single central site you will need to 666unset all the other relays -- or better yet, find or build a minimal 667config file that does this. 668 669 670+-------------------------------+ 671| NON-SMTP BASED CONFIGURATIONS | 672+-------------------------------+ 673 674These configuration files are designed primarily for use by SMTP-based 675sites. I don't pretend that they are well tuned for UUCP-only or 676UUCP-primarily nodes (the latter is defined as a small local net 677connected to the rest of the world via UUCP). However, there is one 678hook to handle some special cases. 679 680You can define a ``smart host'' that understands a richer address syntax 681using: 682 683 define(`SMART_HOST', mailer:hostname) 684 685In this case, the ``mailer:'' defaults to "relay". Any messages that 686can't be handled using the usual UUCP rules are passed to this host. 687 688If you are on a local SMTP-based net that connects to the outside 689world via UUCP, you can use LOCAL_NET_CONFIG to add appropriate rules. 690For example: 691 692 define(`SMART_HOST', suucp:uunet) 693 LOCAL_NET_CONFIG 694 R$* < @ $* .$m. > $* $#smtp $@ $2.$m. $: $1 < @ $2.$m. > $3 695 696This will cause all names that end in your domain name ($m) via 697SMTP; anything else will be sent via suucp (smart UUCP) to uunet. 698If you have FEATURE(nocanonify), you may need to omit the dots after 699the $m. If you are running a local DNS inside your domain which is 700not otherwise connected to the outside world, you probably want to 701use: 702 703 define(`SMART_HOST', smtp:fire.wall.com) 704 LOCAL_NET_CONFIG 705 R$* < @ $* . > $* $#smtp $@ $2. $: $1 < @ $2. > $3 706 707That is, send directly only to things you found in your DNS lookup; 708anything else goes through SMART_HOST. 709 710If you are not running DNS at all, it is important to use 711FEATURE(nodns) to avoid having sendmail queue everything waiting 712for the name server to come up. 713 714 715+-----------+ 716| WHO AM I? | 717+-----------+ 718 719Normally, the $j macro is automatically defined to be your fully 720qualified domain name (FQDN). Sendmail does this by getting your 721host name using gethostname and then calling gethostbyname on the 722result. For example, in some environments gethostname returns 723only the root of the host name (such as "foo"); gethostbyname is 724supposed to return the FQDN ("foo.bar.com"). In some (fairly rare) 725cases, gethostbyname may fail to return the FQDN. In this case 726you MUST define confDOMAIN_NAME to be your fully qualified domain 727name. This is usually done using: 728 729 Dmbar.com 730 define(`confDOMAIN_NAME', `$w.$m')dnl 731 732 733+--------------------+ 734| USING MAILERTABLES | 735+--------------------+ 736 737To use FEATURE(mailertable), you will have to create an external 738database containing the routing information for various domains. 739For example, a mailertable file in text format might be: 740 741 .my.domain xnet:%1.my.domain 742 uuhost1.my.domain suucp:uuhost1 743 .bitnet smtp:relay.bit.net 744 745This should normally be stored in /etc/mailertable. The actual 746database version of the mailertable is built using: 747 748 makemap hash /etc/mailertable.db < /etc/mailertable 749 750The semantics are simple. Any LHS entry that does not begin with 751a dot matches the full host name indicated. LHS entries beginning 752with a dot match anything ending with that domain name -- that is, 753they can be thought of as having a leading "*" wildcard. Matching 754is done in order of most-to-least qualified -- for example, even 755though ".my.domain" is listed first in the above example, an entry 756of "uuhost1.my.domain" will match the second entry since it is 757more explicit. 758 759The RHS should always be a "mailer:host" pair. The mailer is the 760configuration name of a mailer (that is, an `M' line in the 761sendmail.cf file). The "host" will be the hostname passed to 762that mailer. In domain-based matches (that is, those with leading 763dots) the "%1" may be used to interpolate the wildcarded part of 764the host name. For example, the first line above sends everything 765addressed to "anything.my.domain" to that same host name, but using 766the (presumably experimental) xnet mailer. 767 768 769+--------------------------------+ 770| USING USERDB TO MAP FULL NAMES | 771+--------------------------------+ 772 773The user database was not originally intended for mapping full names 774to login names (e.g., Eric.Allman => eric), but some people are using 775it that way. (I would recommend that you set up aliases for this 776purpose instead -- since you can specify multiple alias files, this 777is fairly easy.) The intent was to locate the default maildrop at 778a site, but allow you to override this by sending to a specific host. 779 780If you decide to set up the user database in this fashion, it is 781imperative that you also specify FEATURE(notsticky) -- otherwise, 782e-mail sent to Full.Name@local.host.name will be rejected. 783 784To build the internal form of the user databae, use: 785 786 makemap btree /usr/data/base.db < /usr/data/base.txt 787 788 789+------------------+ 790| FlexFAX SOFTWARE | 791+------------------+ 792 793Sam Leffler's FlexFAX software is still in beta test -- but he expects a 794public version out "later this week" [as of 3/1/93]. The following 795blurb is direct from Sam: 796 797 $Header: /usr/people/sam/fax/RCS/HOWTO,v 1.14 93/05/24 11:42:16 sam Exp $ 798 799 How To Obtain This Software (in case all you get is this file) 800 -------------------------------------------------------------- 801 The source code is available for public ftp on 802 sgi.com sgi/fax/v2.1.src.tar.Z 803 (192.48.153.1) 804 805 You can also obtain inst'able images for Silicon Graphics machines from 806 sgi.com sgi/fax/v2.1.inst.tar 807 (192.48.153.1) 808 809 For example, 810 % ftp -n sgi.com 811 .... 812 ftp> user anonymous 813 ... <type in password> 814 ftp> cd sgi/fax 815 ftp> binary 816 ftp> get v2.1.src.tar.Z 817 818 In general, the latest version of the 2.1 release of the software is 819 always available as "v2.1.src.tar.Z" or "v2.1.inst.tar" in the ftp 820 directory. This file is a link to the appropriate released version (so 821 don't waste your time retrieving the linked file as well!) Any files of 822 the form v2.1.*.patch are shell scripts that can be used to patch older 823 versions of the source code. For example, the file v2.1.0.patch would 824 contain patches to update v2.1.0.tar.Z. (Note to beta testers: this is 825 different than the naming conventions used during beta testing.) Patch 826 files only work to go between consecutive versions, so if you are 827 multiple versions behind the latest release, you will need to apply 828 each patch file between your current version and the latest. 829 830 831 Obtaining the Software by Electronic Mail 832 ----------------------------------------- 833 Do not send me requests for the software; they will be ignored (without 834 response). If you cannot use FTP at all, there is a service called 835 "ftpmail" available from gatekeeper.dec.com: you can send e-mail to 836 this machine and it will use FTP to retrieve files for you and send you 837 the files back again via e-mail. To find out more about the ftpmail 838 service, send a message to "ftpmail@gatekeeper.dec.com" whose body 839 consists of the single line "help". 840 841 842 Obtaining the Software Within Silicon Graphics 843 ---------------------------------------------- 844 Internal to Silicon Graphics there are inst'able images on the host 845 flake.asd in the directory /usr/dist. Thus you can do something like: 846 847 % inst -f flake.asd.sgi.com:/usr/dist/flexfax 848 849 to install the latest version of the software on your machine. 850 851 852 What to do Once You've Retrieved Stuff 853 -------------------------------------- 854 The external distributions come in a compressed or uncompressed tar 855 file. To extract the source distribution: 856 857 % zcat v2.1.src.tar.Z | tar xf - 858 859 (uncompress and extract individual files in current directory). To 860 unpack and install the client portion of the inst'able distribution: 861 862 % mkdir dist 863 % cd dist; tar xf ../v2.1.inst.tar; cd .. 864 % inst -f dist/flexfax 865 ... 866 inst> go 867 868 (Note, the dist subdirectory is because some versions of inst fail if 869 the files are in the current directory.) Server binaries are also 870 included in the inst'able images as flexfax.server.*. They are not 871 installed by default, so to get them also you need to do: 872 873 % inst -f flexfax 874 ... 875 inst> install flexfax.server.* 876 inst> go 877 878 The SGI binaries were built for Version 4.0.5H of the IRIX operating 879 system. They should work w/o problem on earlier versions of the 880 system, but I have not fully tested this. Also, note that to install a 881 server on an SGI machine, you need to have installed the Display 882 PostScript execution environment product (dps_eoe). Otherwise, the fax 883 server will not be able to convert PostScript to facsimile for 884 transmission. 885 886 If you are working from the source distribution, look at the file 887 README in the top of the source tree. If you are working from the inst 888 images, the subsystem flexfax.man.readme contains the README file and 889 other useful pieces of information--the installed files are placed in 890 the directory /usr/local/doc/flexfax). Basically you will need to run 891 the faxaddmodem script to setup and configure your fax modem. Consult 892 the README file and the manual page for faxaddmodem for information. 893 894 895 FlexFAX Mail List 896 ----------------- 897 A mailing list for users of this software is located on sgi.com. 898 If you want to join this mailing list or have a list-related request 899 such as getting your name removed from it, send a request to 900 901 majordomo@whizzer.wpd.sgi.com 902 903 For example, to subscribe, send the line "subscribe flexfax" in 904 the body of your message. The line "help" will return a list of 905 the commands understood by the mailing list management software. 906 907 Submissions (including bug reports) should be directed to: 908 909 flexfax@sgi.com 910 911 When corresponding about this software please always specify what 912 version you have, what system you're running on, and, if the problem is 913 specific to your modem, identify the modem and firmware revision. 914 915 916+--------------------------------+ 917| TWEAKING CONFIGURATION OPTIONS | 918+--------------------------------+ 919 920There are a large number of configuration options that don't normally 921need to be changed. However, if you feel you need to tweak them, you 922can define the following M4 variables. This list is shown in four 923columns: the name you define, the default value for that definition, 924the option or macro that is affected (either Ox for an option or Dx 925for a macro), and a brief description. Greater detail of the semantics 926can be found in the Installation and Operations Guide. 927 928Some options are likely to be deprecated in future versions -- that is, 929the option is only included to provide back-compatibility. These are 930marked with "*". 931 932Remember that these options are M4 variables, and hence may need to 933be quoted. In particular, arguments with commas will usually have to 934be ``double quoted, like this phrase'' to avoid having the comma 935confuse things. This is common for alias file definitions and for 936the read timeout. 937 938M4 Variable Name Default Mac/Opt Description 939================ ======= ======= =========== 940confMAILER_NAME MAILER-DAEMON Dn The sender name used for 941 internally generated 942 outgoing messages. 943confFROM_LINE From $g $d Dl The From_ line used when 944 sending to files or programs. 945confFROM_HEADER $?x$x <$g>$|$g$. The format of an internally 946 Dq generated From: address. 947confOPERATORS .:%@!^/[] Do Address operator characters. 948confSMTP_LOGIN_MSG $j Sendmail $v/$Z ready at $b 949 De The initial (spontaneous) 950 SMTP greeting message. 951confSEVEN_BIT_INPUT False O7 Force input to seven bits? 952confALIAS_WAIT 10 Oa Wait (in minutes) for alias 953 file rebuild. 954confMIN_FREE_BLOCKS 4 Ob Minimum number of free blocks 955 on queue filesystem to accept 956 SMTP mail. 957confBLANK_SUB . OB Blank (space) substitution 958 character. 959confCON_EXPENSIVE False Oc Avoid connecting immediately 960 to mailers marked expensive? 961confCHECKPOINT_INTERVAL 10 OC Checkpoint queue files 962 every N recipients. 963confDELIVERY_MODE background Od Default delivery mode. 964confAUTO_REBUILD False OD Automatically rebuild 965 alias file if needed. 966confERROR_MODE (undefined) Oe Error message mode. 967confERROR_MESSAGE (undefined) OE Error message header/file. 968confSAVE_FROM_LINES False Of Save extra leading 969 From_ lines. 970confTEMP_FILE_MODE 0600 OF Temporary file mode. 971confDEF_GROUP_ID 1 Og Default group id. 972confMATCH_GECOS False OG Match GECOS field. 973confMAX_HOP 17 Oh Maximum hop count. 974confIGNORE_DOTS False Oi * Ignore dot as terminator 975 for incoming messages? 976confBIND_OPTS (empty) OI Default options for BIND. 977confMIME_FORMAT_ERRORS True Oj * Send error messages as MIME- 978 encapsulated messages per 979 RFC 1344. 980confFORWARD_PATH (undefined) OJ The colon-separated list of 981 places to search for .forward 982 files. 983confMCI_CACHE_SIZE 2 Ok Size of open connection cache. 984confMCI_CACHE_TIMEOUT 5m OK Open connection cache timeout. 985confUSE_ERRORS_TO False Ol * Use the Errors-To: header to 986 deliver error messages. This 987 should not be necessary because 988 of general acceptance of the 989 envelope/header distinction. 990confLOG_LEVEL 9 OL Log level. 991confME_TOO False Om Include sender in group 992 expansions. 993confCHECK_ALIASES True On Check RHS of aliases when 994 running newaliases. 995confOLD_STYLE_HEADERS True Oo * Assume that headers without 996 special chars are old style. 997confDAEMON_OPTIONS (undefined) OO SMTP daemon options. 998confPRIVACY_FLAGS authwarnings Op Privacy flags. 999confCOPY_ERRORS_TO (undefined) OP Address for additional copies 1000 of all error messages. 1001confQUEUE_FACTOR (undefined) Oq Slope of queue-only function 1002confREAD_TIMEOUT (undefined) Or SMTP read timeouts. 1003confSAFE_QUEUE True Os * Commit all messages to disk 1004 before forking. 1005confMESSAGE_TIMEOUT 5d/4h OT Timeout for messages before 1006 sending error/warning message. 1007confTIME_ZONE USE_SYSTEM Ot Time zone info -- can be 1008 USE_SYSTEM to use the system's 1009 idea, USE_TZ to use the user's 1010 TZ envariable, or something 1011 else to force that value. 1012confDEF_USER_ID 1 Ou Default user id. 1013confUSERDB_SPEC (undefined) OU User database specification. 1014confFALLBACK_MX (undefined) OV Fallback MX host. 1015confTRY_NULL_MX_LIST False Ow If we are the best MX for a 1016 host and haven't made other 1017 arrangements, try connecting 1018 to the host directly; normally 1019 this would be a config error. 1020confQUEUE_LA 8 Ox Load average at which queue-only 1021 function kicks in. 1022confREFUSE_LA 12 OX Load average at which incoming 1023 SMTP connections are refused. 1024confWORK_RECIPIENT_FACTOR 1025 (undefined) Oy Cost of each recipient. 1026confSEPARATE_PROC False OY Run all deliveries in a 1027 separate process. 1028confWORK_CLASS_FACTOR (undefined) Oz Priority multiplier for class. 1029confWORK_TIME_FACTOR (undefined) OZ Cost of each delivery attempt. 1030confCW_FILE /etc/sendmail.cw Name of file used to get the 1031 Fw local additions to the $=w 1032 class. 1033confSMTP_MAILER smtp - The mailer name used when 1034 SMTP connectivity is required. 1035 Either "smtp" or "esmtp". 1036confLOCAL_MAILER local - The mailer name used when 1037 local connectivity is required. 1038 Almost always "local". 1039confRELAY_MAILER relay - The default mailer name used 1040 for relaying any mail (e.g., 1041 to a BITNET_RELAY, a 1042 SMART_HOST, or whatever). 1043 This can reasonably be "suucp" 1044 if you are on a UUCP-connected 1045 site. 1046confDOMAIN_NAME (undefined) Dj If defined, sets $j. 1047 1048 1049+-----------+ 1050| HIERARCHY | 1051+-----------+ 1052 1053Within this directory are several subdirectories, to wit: 1054 1055m4 General support routines. These are typically 1056 very important and should not be changed without 1057 very careful consideration. 1058 1059cf The configuration files themselves. They have 1060 ".mc" suffixes, and must be run through m4 to 1061 become complete. The resulting output should 1062 have a ".cf" suffix. 1063 1064ostype Definitions describing a particular operating 1065 system type. These should always be referenced 1066 using the OSTYPE macro in the .mc file. Examples 1067 include "bsd4.3", "bsd4.4", "sunos3.5", and 1068 "sunos4.1". 1069 1070domain Definitions describing a particular domain, referenced 1071 using the DOMAIN macro in the .mc file. These are 1072 site dependent; for example, we contribute "cs.exposed.m4" 1073 and "cs.hidden.m4" which both describe hosts in the 1074 CS.Berkeley.EDU subdomain; the former displays the local 1075 hostname (e.g., mammoth.CS.Berkeley.EDU), whereas the 1076 latter does its best to hide the identity of the local 1077 workstation inside the CS subdomain. 1078 1079mailer Descriptions of mailers. These are referenced using 1080 the MAILER macro in the .mc file. 1081 1082sh Shell files used when building the .cf file from the 1083 .mc file in the cf subdirectory. 1084 1085feature These hold special orthogonal features that you might 1086 want to include. They should be referenced using 1087 the FEATURE macro. 1088 1089hack Local hacks. These can be referenced using the HACK 1090 macro. They shouldn't be of more than voyeuristic 1091 interest outside the .Berkeley.EDU domain, but who knows? 1092 We've all got our own peccadilloes. 1093 1094siteconfig Site configuration -- e.g., tables of locally connected 1095 UUCP sites. 1096 1097 1098+------------------------+ 1099| ADMINISTRATIVE DETAILS | 1100+------------------------+ 1101 1102The following sections detail usage of certain internal parts of the 1103sendmail.cf file. Read them carefully if you are trying to modify 1104the current model. If you find the above descriptions adequate, these 1105should be {boring, confusing, tedious, ridiculous} (pick one or more). 1106 1107RULESETS (* means built in to sendmail) 1108 1109 0 * Parsing 1110 1 * Sender rewriting 1111 2 * Recipient rewriting 1112 3 * Canonicalization 1113 4 * Post cleanup 1114 5 * Local address rewrite (after aliasing) 1115 1x mailer rules (sender qualification) 1116 2x mailer rules (recipient qualification) 1117 3x mailer rules (sender header qualification) 1118 4x mailer rules (recipient header qualification) 1119 5x mailer subroutines (general) 1120 6x mailer subroutines (general) 1121 7x mailer subroutines (general) 1122 8x reserved 1123 90 Mailertable host stripping 1124 96 Bottom half of Ruleset 3 (ruleset 6 in old sendmail) 1125 97 Hook for recursive ruleset 0 call (ruleset 7 in old sendmail) 1126 98 Local part of ruleset 0 (ruleset 8 in old sendmail) 1127 1128 1129MAILERS 1130 1131 0 local, prog local and program mailers 1132 1 [e]smtp, relay SMTP channel 1133 2 uucp-* UNIX-to-UNIX Copy Program 1134 3 netnews Network News delivery 1135 4 fax Sam Leffler's FlexFAX software 1136 1137 1138MACROS 1139 1140 A 1141 B Bitnet Relay 1142 C 1143 D The local domain -- usually not needed 1144 E 1145 F FAX Relay 1146 G 1147 H mail Hub (for mail clusters) 1148 I 1149 J 1150 K 1151 L 1152 M Masquerade (who I claim to be) 1153 N 1154 O 1155 P 1156 Q 1157 R Relay (for unqualified names) 1158 S Smart Host 1159 T 1160 U my UUCP name (if I have a UUCP connection) 1161 V UUCP Relay (class V hosts) 1162 W UUCP Relay (class W hosts) 1163 X UUCP Relay (class X hosts) 1164 Y UUCP Relay (all other hosts) 1165 Z Version number 1166 1167 1168CLASSES 1169 1170 A 1171 B 1172 C 1173 D 1174 E addresses that should not seem to come from $M 1175 F hosts we forward for 1176 G 1177 H 1178 I 1179 J 1180 K 1181 L addresses that should not be forwarded to $R 1182 M 1183 N 1184 O operators that indicate network operations (cannot be in local names) 1185 P top level pseudo-domains: BITNET, FAX, UUCP, etc. 1186 Q 1187 R 1188 S 1189 T 1190 U locally connected UUCP hosts 1191 V UUCP hosts connected to relay $V 1192 W UUCP hosts connected to relay $W 1193 X UUCP hosts connected to relay $X 1194 Y locally connected smart UUCP hosts 1195 Z locally connected domain-ized UUCP hosts 1196 . the class containing only a dot 1197 1198 1199M4 DIVERSIONS 1200 1201 1 Local host detection and resolution 1202 2 Local Ruleset 3 additions 1203 3 Local Ruleset 0 additions 1204 4 UUCP Ruleset 0 additions 1205 5 locally interpreted names (overrides $R) 1206 6 local configuration (at top of file) 1207 7 mailer definitions 1208 8 special local name recognition (late in ruleset 3) 1209 9 special local rulesets (1 and 2) 1210