Debian Codegraph @

doc/html/_sources/imap/reference/manpages/systemcommands/fud.rst.txt

raw
1 .. cyrusman:: fud(8)
2
3 .. author: Nic Bernstein (Onlight)
4
5 .. _imap-reference-manpages-systemcommands-fud:
6
7 =======
8 **fud**
9 =======
10
11 Provide information about user mailboxes
12
13 Synopsis
14 ========
15
16 .. parsed-literal::
17
18 **fud** [ **-C** *config-file* ] [ **-U** *uses* ] [ **-T** *timeout* ] [ **-D** ]
19
20 Description
21 ===========
22
23 **fud** is a long lived datagram daemon started from master that
24 provides information about when a user last read their mail, when mail
25 last arrived in a user's mailbox, and how many messages are recent for
26 that user.
27
28 **fud** |default-conf-text|
29
30 **fud** will automatically proxy any and all FUD requests to the
31 appropriate backend server if it is running on a Cyrus Murder frontend
32 machine.
33
34 To set up the FUD daemon, add this to your cyrus.conf:
35
36 ``fud cmd="fud" listen="fud" prefork=1 proto="udp"``
37
38 and to /etc/services:
39
40 ``fud 4201/udp # Cyrus IMAP FUD Daemon``
41
42 Client
43 ------
44
45 There is no specific FUD client. This shows how one might access FUD.
46
47 ::
48
49 #!/usr/bin/perl
50
51 use Socket;
52
53 print( "Enter fud hostname: " );
54 $hostname = <>;
55 chomp( $hostname );
56
57 print( "Enter username to query: " );
58 $username = <>;
59 chomp( $username );
60
61 socket( FUD, PF_INET, SOCK_DGRAM, getprotobyname( "udp" ) )
62 or die( "failed to create udp socket: $!" );
63
64 $ipaddr = inet_aton( $hostname );
65 $portaddr = sockaddr_in( '4201', $ipaddr );
66
67 $fud_query = $username . '|user.' . $username;
68
69 send( FUD, "$fud_query", 0, $portaddr ) == length( $fud_query )
70 or die( "failed to send fud query: $!" );
71
72 recv( FUD, $fud_response, 512, 0 )
73 or die( "recv() failed: $!" );
74
75 print( "FUD responded: $fud_response\n" );
76
77 exit( 0 );
78
79
80 Options
81 =======
82
83 .. program:: fud
84
85 .. option:: -C config-file
86
87 |cli-dash-c-text|
88
89 .. option:: -U uses
90
91 The maximum number of times that the process should be used for new
92 connections before shutting down. The default is 250.
93
94 .. option:: -T timeout
95
96 The number of seconds that the process will wait for a new
97 connection before shutting down. Note that a value of 0 (zero)
98 will disable the timeout. The default is 60.
99
100 .. option:: -D
101
102 Run external debugger specified in debug_command.
103
104 Files
105 =====
106
107 /etc/imapd.conf,
108 /etc/cyrus.conf
109
110 Bugs
111 ====
112
113 Though not really a bug, **fud** will silently ignore any requests that
114 it does not consider valid.
115
116 Also not really a bug, **fud** requires that the anonymous user has the
117 0 (zero) right on the mailbox in question. This is only a "bug" because
118 0 is not a standard IMAP ACL bit.
119
120 **fud** is an experimental interface meant to provide information to
121 build a finger-like service around. Eventually it should be superseded
122 by a more standards-based protocol.
123
124
125 See Also
126 ========
127
128 :cyrusman:`imapd.conf(5)`,
129 :cyrusman:`cyrus.conf(5)`