|
Check-in Number:
|
1011 | |
| Date: |
2001-Sep-14 15:26:16 (local)
2001-Sep-14 13:26:16 (UTC) |
| User: | rse |
| Branch: | |
| Comment: |
provide documentation for SMTP channel |
| Tickets: |
|
| Inspections: |
|
| Files: |
|
ossp-pkg/l2/l2.pod 1.4 -> 1.5
--- l2.pod 2001/08/15 10:36:03 1.4
+++ l2.pod 2001/09/14 13:26:16 1.5
@@ -49,5 +49,66 @@
The following functions are provided by the B<L2> API:
+=head1 AVAILABLE CHANNEL HANDLERS
+
+=head2 SMTP Output Channel Handler (l2_handler_smtp)
+
+The SMTP output channel handler C<l2_channel_smtp> sends the incoming
+message via Simple Mail Transfer Protocol (SMTP) as an Email to a remote
+mail service. It conforms to RFC 2821 (Simple Mail Transfer Protocol; J.
+Klensin; April 2001) and RFC 2822 (Internet Message Format; P. Resnick;
+April 2001).
+
+It provides the following channel parameters:
+
+=over 4
+
+=item B<progname> (optional, C<char *>)
+
+Arbitrary string identifying the program using B<OSSP L2>.
+Default is C<NULL> which means no program identification.
+
+=item B<localhost> (optional, C<char *>)
+
+Hostname of the underlying machine.
+Default is set through uname(3) or C<localhost>.
+
+=item B<localuser> (optional, C<char *>)
+
+Username corresponding to the UID of the underlying process.
+Default is set through resolving getuid(2) or C<uid#N>.
+
+=item B<from> (optional, C<char *>)
+
+Sender Email address for outgoing mails.
+Default is set through B<localuser> and B<localhost>.
+
+=item B<rcpt> (I<mandatory>, C<char *>)
+
+Recipient Email address for outgoing mails.
+No default exists, user has to provide value.
+
+=item B<subject> (optional, C<char *>)
+
+Arbitrary string identifying the generated Email message.
+Default is C<[L2] log channel output on {localhost}>.
+
+=item B<host> (I<mandatory>, C<char *>)
+
+Host name or IP address of the remote SMTP service.
+No default exists, user has to provide value.
+
+=item B<port> (optional, C<char *>)
+
+Port name or number of the remote SMTP service.
+Default is C<smtp> (25).
+
+=item B<timeout> (optional, C<int>)
+
+Timeout in seconds for all I/O operations.
+Default is C<30>.
+
+=back
+
=cut
|
|
