Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MLMMJ-WEBVIEW(1)	     General Commands Manual		MLMMJ-WEBVIEW(1)

NAME
     mlmmj-webview  --	CGI  handler for mlmmj mailing list subscribe and unsub-
     scribe requests

SYNOPSIS
     mlmmj-webview

DESCRIPTION
     The mlmmj-webview utility is a CGI program that handles subscribe	and  un-
     subscribe	requests for mlmmj mailing lists.  It only accepts POST requests
     on the /action endpoint.

     The following form fields are expected:

     ml 	  The name of the mailing list.

     email	  The email address of the subscriber.	The email  is  validated
		  for  correct	format using kcgi(3)'s built-in email validator,
		  and the domain part is  verified  to	resolve  via  DNS  using
		  getaddrinfo(3).

     Subscribe	  If present, a subscription request is created.

     Unsubscribe  If present, an unsubscription request is created.

     Upon  receiving  a  valid request, mlmmj-webview writes a temporary file in
     /var/spool/mlmmj-webview/subscribe/				      or
     /var/spool/mlmmj-webview/unsubscribe/  containing the mailing list name and
     email address.  A separate script is expected to process these files  on  a
     regular basis.

     Upon   completion,   mlmmj-webview   issues   an	HTTP   303  redirect  to
     /action_done.html, which is a static page that displays a confirmation mes-
     sage and redirects the user back to the main page after a few seconds.

     To prevent information leakage, mlmmj-webview always returns the same redi-
     rect regardless of  whether  the  request	was  successfully  processed  or
     silently dropped.

ENVIRONMENT
     mlmmj-webview  does not require any environment variables.  It is typically
     invoked by a web server via FastCGI or CGI.

FILES
     /var/spool/mlmmj-webview/subscribe/
	     Directory where subscription request files are created.

     /var/spool/mlmmj-webview/unsubscribe/
	     Directory where unsubscription request files are created.

     /action_done.html
	     Static page displayed after a request is  submitted.   It	shows  a
	     confirmation message and redirects the user to the main page.  This
	     file must be served by the web server at the document root.

EXIT STATUS
     The mlmmj-webview utility exits 0 on success, and >0 if an error occurs.

EXAMPLES
     Example  nginx configuration to proxy the /action endpoint to mlmmj-webview
     via FastCGI:

     location /action {
	 gzip off;
	 include fastcgi_params;
	 fastcgi_param GATEWAY_INTERFACE CGI/1.1;
	 fastcgi_param SCRIPT_FILENAME /usr/local/bin/mlmmj-webview;
	 fastcgi_param PATH_INFO $uri;
	 fastcgi_param QUERY_STRING $args;
	 fastcgi_pass unix:/var/run/fcgiwrap/fcgiwrap.sock;
     }

SEE ALSO
     mlmmj-genindex(1), getaddrinfo(3), kcgi(3)

FreeBSD ports 15.quarterly	 March 16, 2026 		MLMMJ-WEBVIEW(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mlmmj-webview&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help