"Fossies" - the Fresh Open Source Software Archive

Member "dacs-1.4.46/man/dacsemail.1.man" (8 Jun 2021, 10559 Bytes) of package /linux/www/dacs-1.4.46.txz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "dacsemail.1.man": 1.4.45_vs_1.4.46.

    1 DACSEMAIL(1)                 DACS Commands Manual                 DACSEMAIL(1)
    2 
    3 
    4 
    5 NAME
    6        dacsemail - Simple outgoing email agent
    7 
    8 SYNOPSIS
    9        dacsemail [-bcc addr] [{-bf | --bodyfile} path]
   10                  [{-bs | --bodystring} string] [-cc addr]
   11                  [-ct value] [{-f | --from} from] [-h | --help]
   12                  [-header name value]
   13                  [{-mailer | -mta} path] [{-mailer-flags | -mta-flags} string]
   14                  [-p | --prompt] [-save path] [{-s | --subject} subject]
   15                  [-sender sender] [{-t | --to} addr] [-transform] [-v |
   16                  --verbose] [-var name value]
   17 
   18        dacsemail --version
   19 
   20 DESCRIPTION
   21        This program is part of the DACS suite.
   22 
   23        The dacsemail utility is a simple agent for sending email messages. It
   24        is a stand-alone program that neither accepts the usual DACS command
   25        line options (dacsoptions[1]) nor accesses any DACS configuration
   26        files.
   27 
   28        dacsemail constructs an RFC 822[2] format message but does not transmit
   29        it. It requires an external mailer, such as sendmail(8)[3], to transfer
   30        the message. The mailer command and its arguments can be specified on
   31        the dacsemail command line (see -mailer) or at build time (see
   32        dacs.install(7)[4]).
   33 
   34 OPTIONS
   35        If the source for the message body is not specified on the command
   36        line, it will be read from the standard input. At least one recipient
   37        must be specified using -t, -cc, or -bcc.
   38 
   39        -bcc addr
   40            Send the message to the undisclosed recipient address addr. It is
   41            the responsibility of the mailer to delete these recipient
   42            addresses before transmitting the message. This flag may be
   43            repeated.
   44 
   45        -bf path
   46        --bodyfile path
   47            Read the message body from path. If path is -, the standard input
   48            is read.
   49 
   50        -bs string
   51        --bodystring string
   52            Use string as the message body.
   53 
   54        -cc addr
   55            Send the message to recipient addr as a carbon copy. This flag may
   56            be repeated.
   57 
   58        -ct value
   59            Add a Content-type header of MIME type value to the message. If
   60            value is multipart/alternative, an appropriate boundary variable
   61            will be created, unless one has already been specified on the
   62            command line with the -var flag. It is assumed that the message
   63            body has already been correctly formatted for this MIME type, or
   64            will be after it has been transformed (see -transform).
   65 
   66        -f from
   67        --from from
   68            Use from as the value of the message´s From header.
   69 
   70        -h
   71        --help
   72            Print usage information and then exit.
   73 
   74        -header name value
   75            Add a message header named name with value value. This flag should
   76            only be used for headers that do not have specific flags (-t, -ct,
   77            -f, and so on).
   78 
   79        -mailer path
   80        -mta path
   81            Use the message transfer agent command path (a full pathname)
   82            instead of the configured program. This program must read the
   83            message from its standard input and extract the list of recipients
   84            from the message´s To, Cc, and Bcc headers. (If such a mailer is
   85            unavailable, it will be necessary to write a small program to wrap
   86            a mailer and provide the required interface to dacsemail.) The
   87            default is to run sendmail(8)[3] with its -t flag.
   88 
   89        -mailer-flags string
   90        -mta-flags string
   91            Regardless of the mailer, use string for its command line flags.
   92 
   93        -p
   94        --prompt
   95            Just before the message is to be sent, display it (to stderr) and
   96            wait for the user to respond to a prompt. At the prompt, the user
   97            may abort the message or allow it to be sent.
   98 
   99        -save path
  100            Just before sending (or prompting), write a copy of the outgoing
  101            message to path, replacing any previous contents of the file.
  102 
  103        -s subject
  104        --subject subject
  105            Set the message´s Subject header to subject.
  106 
  107        -sender sender
  108            Set the message´s Sender header to sender.
  109 
  110        -t addr
  111        --to addr
  112            Add addr as a "To" recipient. This flag may be repeated.
  113 
  114        -transform
  115            The message body, regardless of how it is specified, is filtered
  116            through the DACS transformation function. Please refer to
  117            dacs_transform(8)[5] for details. No access control rules may be
  118            associated with any transformation; i.e., they are all
  119            unconditional. A similar effect can be obtained by piping the
  120            output of dacstransform(1)[6] into dacsemail.
  121 
  122        -v
  123        --verbose
  124            Enable verbose output for debugging.
  125 
  126        --version
  127            Display the program´s version information and then exit.
  128 
  129        -var name value
  130            Create a variable[7] named name set to value for the transform
  131            function. The variable´s value can be referenced within the message
  132            body in the DACS namespace as ${DACS::name}. The variable must not
  133            already be defined.
  134 
  135 EXAMPLES
  136        Suppose myfile contains the following text:
  137 
  138            <!--DACS expand="*" -->
  139            This is a multi-part message in MIME format.
  140 
  141            --${DACS::boundary}
  142            Content-Type: text/plain; charset=us-ascii
  143            Content-Disposition: inline
  144            Content-Transfer-Encoding: 7bit
  145 
  146            Hello, ${DACS::user}!
  147 
  148            --${DACS::boundary}
  149            Content-Type: text/html; charset=us-ascii
  150            Content-Disposition: inline
  151            Content-Transfer-Encoding: 7bit
  152 
  153            <p>
  154            <font color="red">Hello, ${DACS::user}!</font>
  155            </p>
  156            --${DACS::boundary}--
  157            <!--DACS end="*" -->
  158 
  159        The following command might be used to send a message with a
  160        multipart/alternative structured body:
  161 
  162            % dacsemail -ct multipart/alternative -f auggie@example.com \
  163                  -t harley@example.com -s "Hello" -transform -var user Auggie -bf myfile
  164 
  165        The resulting message will look something like the following:
  166 
  167            To: harley@example.com
  168            From: auggie@example.com
  169            Subject: Hello
  170            Content-type: multipart/alternative; boundary="_----------=_03885942562898683484"
  171            Date: Wed, 07 Apr 2010 16:48:41 -0700 (PDT)
  172            Content-transfer-encoding: 7bit
  173            X-mailer: DACS 1.4.24a
  174 
  175            This is a multi-part message in MIME format.
  176 
  177            --_----------=_03885942562898683484
  178            Content-Type: text/plain; charset=us-ascii
  179            Content-Disposition: inline
  180            Content-Transfer-Encoding: 7bit
  181 
  182            Hello, Auggie!
  183 
  184            --_----------=_03885942562898683484
  185            Content-Type: text/html; charset=us-ascii
  186            Content-Disposition: inline
  187            Content-Transfer-Encoding: 7bit
  188 
  189            <p>
  190            <font color="red">Hello, Auggie!</font>
  191            </p>
  192            --_----------=_03885942562898683484--
  193 
  194 
  195 FILES
  196        None.
  197 
  198 DIAGNOSTICS
  199        The program exits 0 if everything was fine, 1 if an error occurred.
  200        Error messages are printed to stderr. Errors and routine messages from
  201        the mailer are recorded wherever they are normally logged, outside of
  202        DACS
  203 
  204 BUGS
  205        This program´s primary purpose is for testing DACS functionality that
  206        is needed for internal purposes. No significant improvements are
  207        envisioned. You could throw a rock and hit a better email agent.
  208 
  209 SEE ALSO
  210        dacs.exprs(5)[8], dacs.install(7)[4], dacs_transform(8)[5],
  211        sendmail(8)[3]
  212 
  213 AUTHOR
  214        Distributed Systems Software (www.dss.ca[9])
  215 
  216 
  217 
  218 
  219 COPYING
  220        Copyright © 2003-2021 Distributed Systems Software. See the LICENSE[10]
  221        file that accompanies the distribution for licensing information.
  222 
  223 
  224 
  225 
  226 NOTES
  227         1. dacsoptions
  228            http://dacs.dss.ca/man/dacs.1.html#dacsoptions
  229 
  230         2. RFC 822
  231            https://www.rfc-editor.org/rfc/rfc822.txt
  232 
  233         3. sendmail(8)
  234            https://www.freebsd.org/cgi/man.cgi?query=sendmail&apropos=0&sektion=8&manpath=FreeBSD+12.0-RELEASE&format=html
  235 
  236         4. dacs.install(7)
  237            http://dacs.dss.ca/man/dacs.install.7.html#configure_options
  238 
  239         5. dacs_transform(8)
  240            http://dacs.dss.ca/man/dacs_transform.8.html
  241 
  242         6. dacstransform(1)
  243            http://dacs.dss.ca/man/dacstransform.1.html
  244 
  245         7. a variable
  246            http://dacs.dss.ca/man/dacs.exprs.5.html#variable_syntax
  247 
  248         8. dacs.exprs(5)
  249            http://dacs.dss.ca/man/dacs.exprs.5.html#transform
  250 
  251         9. www.dss.ca
  252            https://www.dss.ca
  253 
  254        10. LICENSE
  255            http://dacs.dss.ca/man/../misc/LICENSE
  256 
  257 
  258 
  259 DACS 1.4.46                       06/08/2021                      DACSEMAIL(1)