1 \chapter{Introduction}

2 \label{chap:introduction}

3

4 << say what you want to say >>

5

6 << the overall goal of the document >>

7

8

9

10 \section{The \masqmail\ project}

11 \label{sec:masqmail}

12

13 << about masqmail (some history) >>

14

15 (include history of email, definition of MTA and sendmail-compatibility in text)

16

17 The \masqmail\ program was written by \person{Oliver Kurth}, starting in 1999. His aim was to create a small \mta\ which is especially focused on computers with dial-up connections to the internet. \masqmail\ is easy configurable for situations which are rarely solveable with the common \MTA{}s.

18

19 \masqmail\ queues mail for destinations outside the local network if no connection to the internet is online. If the machine goes online, this mail is sent. Mail to local machines is sent immediately.

20

21 While the other \MTA{}s are more general purpose \MTA{}s, \masqmail\ aims on special situations only. Nevertheless can it handle ordinary mail transfers too.

22

23 \masqmail\ is released under the \GPL, which makes it \freesw. The latest stable version is 0.2.21 from November 2005.

24

25 The program's new homepage \citeweb{masqmail:homepage} provides further information about this \MTA.

26

27

28 \subsubsection{Target field}

29 Its original author, \person{Oliver Kurth}, sees \masqmail\ so:

30 \begin{quote}

31 MasqMail is a mail server designed for hosts that do not have a permanent internet connection eg. a home network or a single host at home. It has special support for connections to different ISPs. It replaces sendmail or other MTAs such as qmail or exim.

32 \end{quote}

33

34 \masqmail\ is inteded to cover a specific niche: non-permanent internet connection and different \NAME{ISP}s.

35

36 Although it can basically replace other \MTA{}s, it is not generally aimed to do so. The package description of \debian\citeweb{packages.debian:masqmail} states this more clearly by changing the last sentence to:

37 \begin{quote}

38 In these cases, MasqMail is a slim replacement for full-blown MTAs such as sendmail, exim, qmail or postfix.

39 \end{quote}

40 \masqmail\ is a good replacement ``in these cases'', but not generally, since is lacks features essential for running on mail servers. It is primarily not secure enough for being accessable from untrusted locations.

41

42 The program is best used in home networks, which are non-permanently connected to the internet. \masqmail\ sends mail to local destinations, like users on the same machine and on other machines in the local net, immediately. Email to recipients outside the local net are queued when offline and sent when a online connection gets established.

43

44 Further more does \masqmail\ respect online connections through different \NAME{ISP}s; a common thing for dial-up connections. In particular can different sender addresses be set, dependent on the \NAME{ISP} that is used. This prevents mail to be likely classified as spam.

45

46

47

48 \subsubsection{Typical usage}

49 This section describes situations that make senseful use of \masqmail.

50

51 A home network consisting of some workstations without a server. The network is connected to the internet by dial-up or broadband. Going online is initiated by computers inside the local net. \NAME{IP} addresses change at least once every day.

52

53 Every workstation would be equiped with \masqmail. Mail transfer within the same machine or within the local net works straight forward. Outgoing mail to the internet is sent, to the concerning \NAME{ISP} for relaying, whenever the router goes online. Receiving of mail from outside needs to be done by a mail fetch program, like the \masqmail\ internal \NAME{POP3} client or \name{fetchmail} for example. The configuration for \masqmail\ would be the same on every computer, except the hostname.

54

55 For the same network but having a server, one could have \masqmail\ running on the server and using simple forwarders (see \ref{subsec:relay-only}) to the server on the workstations. This setup does only support mail transfer to the server, but not back to a workstation; also sending mail to another user on the same workstation is not possible.

56

57 A better setup is to run \masqmail\ on every machine %FIXME

58

59

60 ---

61

62 As \masqmail\ is focused on non-permanent Internet connections, online state can be queried by three methods: reading from a file, reading the output of a command, or by asking an \name{mserver}. Each method may return a string indicating one of the available routes being online, or returning nothing to indicate offline state.

63

64 Delivery to recipients on the local host or in local nets is done at once; delivery to recipients on the Internet is only done when being online, and queued otherwise. Each online route may have a different mail server to which mail is relayed. Return address headers are modified appropriate if wished.

65

66 ---

67

68

69 \subsubsection{What makes it special}

70

71 As main advantage, \masqmail\ makes it easy to set up an \MTA\ on workstations or notebooks without the need to do complex configuration or to be an mail server expert.

72

73 Workstations use %FIXME

74

75 \textbf{Alternatives?}

76 % http://anfi.homeunix.org/sendmail/dialup10.html

77

78

79

80 << explain why masqmail is old and why it is interesting/important however! >> %FIXME

81

82

83

84 \section{Problems to solve}

85

86 << what problems has masqmail? >> %FIXME

87

88 << what's the intention of this document? >> %FIXME

89

90 << why is it worth the effort? >> %FIXME

91

92

93

94

95 \section{How to read this document}

96

97 \subsubsection*{Conventions used}

98 %TODO: check if this tells what is really used!

99 %FIXME: make it complete!

100 %FIXME: remove everything not needed. Maybe write only a few sentences text.

101 The following typographic conventions are used in this book:

102

103 \begin{tabular}{ p{0.15\textwidth} p{0.8\textwidth} }

104 \emph{Italic} &

105 is used for names, including command names, file name, hostnames, usernames and email addresses.

106 Further more it is used to emphasize text.

107 \\ &\\

108

109 \texttt{Constant Width} &

110 is used for source code, contents of files and output from programs.

111 \\ &\\

112

113 \texttt{\$} &

114 indicates the the user shell prompt.

115 \\ &\\

116

117 \texttt{\#} &

118 indicates the the root shell prompt.

119 \\

120 \end{tabular}

121

122

123

124

125 \section{Further reading}

126

127 << specify the really important external documents here >> %FIXME

128

129 << write about the bundled CD, and tell what's included >> %FIXME

130

131 \NAME{RFC}s, other books, source code, websites

132

133

134