svn: /pear/peardoc/trunk/en/package/ webservices/services-mailman/examples/list.php webservices/services-mailman/examples/subscribe.php webservices/services-mailman/examples/unsubscribe.php webservices/services-mailman/examples.xml webservices/services-mailman/getting-started.xml webservices/services-mailman.xml webservices-entities.xml
[email protected] (Christian Weiske) Sun, 12 Feb 2012 19:28:29 +0000
| Newsgroups | php.pear.doc |
|---|---|
| Message-ID | <[email protected]> |
--f00d88b6a002b266a15cfbfee370e0465bd1ca14
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 8bit
cweiske Sun, 12 Feb 2012 19:28:29 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=323165
Log:
services_mailman docs
Changed paths:
A pear/peardoc/trunk/en/package/webservices/services-mailman/
A pear/peardoc/trunk/en/package/webservices/services-mailman/examples/
A pear/peardoc/trunk/en/package/webservices/services-mailman/examples/list.php
A pear/peardoc/trunk/en/package/webservices/services-mailman/examples/subscribe.php
A pear/peardoc/trunk/en/package/webservices/services-mailman/examples/unsubscribe.php
A pear/peardoc/trunk/en/package/webservices/services-mailman/examples.xml
A pear/peardoc/trunk/en/package/webservices/services-mailman/getting-started.xml
A pear/peardoc/trunk/en/package/webservices/services-mailman.xml
U pear/peardoc/trunk/en/package/webservices-entities.xml
Added: pear/peardoc/trunk/en/package/webservices/services-mailman/examples/list.php
===================================================================
--- pear/peardoc/trunk/en/package/webservices/services-mailman/examples/list.php (rev 0)
+++ pear/peardoc/trunk/en/package/webservices/services-mailman/examples/list.php 2012-02-12 19:28:29 UTC (rev 323165)
@@ -0,0 +1,12 @@
+<?php
+require_once 'Services/Mailman.php';
+$mm = new Services_Mailman('http://example.org', '', 'adminpass');
+try {
+ $mailinglists = $mm->lists();
+ foreach ($mailinglists as $list) {
+ echo $list['name'] . "\n";
+ }
+} catch (Services_Mailman_Exception $e) {
+ die('Error: ' . $e->getMessage());
+}
+?>
Added: pear/peardoc/trunk/en/package/webservices/services-mailman/examples/subscribe.php
===================================================================
--- pear/peardoc/trunk/en/package/webservices/services-mailman/examples/subscribe.php (rev 0)
+++ pear/peardoc/trunk/en/package/webservices/services-mailman/examples/subscribe.php 2012-02-12 19:28:29 UTC (rev 323165)
@@ -0,0 +1,9 @@
+<?php
+require_once 'Services/Mailman.php';
+$mm = new Services_Mailman('http://example.org', 'foo-users', 'adminpass');
+try {
+ $mm->subscribe('[email protected]');
+} catch (Services_Mailman_Exception $e) {
+ die('Error: ' . $e->getMessage());
+}
+?>
Added: pear/peardoc/trunk/en/package/webservices/services-mailman/examples/unsubscribe.php
===================================================================
--- pear/peardoc/trunk/en/package/webservices/services-mailman/examples/unsubscribe.php (rev 0)
+++ pear/peardoc/trunk/en/package/webservices/services-mailman/examples/unsubscribe.php 2012-02-12 19:28:29 UTC (rev 323165)
@@ -0,0 +1,9 @@
+<?php
+require_once 'Services/Mailman.php';
+$mm = new Services_Mailman('http://example.org', 'foo-users', 'adminpass');
+try {
+ $mm->unsubscribe('[email protected]');
+} catch (Services_Mailman_Exception $e) {
+ die('Error: ' . $e->getMessage());
+}
+?>
Added: pear/peardoc/trunk/en/package/webservices/services-mailman/examples.xml
===================================================================
--- pear/peardoc/trunk/en/package/webservices/services-mailman/examples.xml (rev 0)
+++ pear/peardoc/trunk/en/package/webservices/services-mailman/examples.xml 2012-02-12 19:28:29 UTC (rev 323165)
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section xmlns="http://docbook.org/ns/docbook" version="lillet"
+ xml:id="package.webservices.services-mailman.examples"
+>
+ <info>
+ <title>Examples</title>
+ </info>
+
+
+ <example>
+ <info>
+ <title>List all available mailing lists on the server</title>
+ </info>
+
+ <programlisting role="php">
+ <xi:include parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ href="&package.webservices.services-mailman.examples.list.php;"
+ >
+ <xi:fallback>FIXME:MISSING XINCLUDE CONTENT</xi:fallback>
+ </xi:include>
+ </programlisting>
+ </example>
+
+
+ <example>
+ <info>
+ <title>Subscribing a user to a mailing list</title>
+ </info>
+
+ <programlisting role="php">
+ <xi:include parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ href="&package.webservices.services-mailman.examples.subscribe.php;"
+ >
+ <xi:fallback>FIXME:MISSING XINCLUDE CONTENT</xi:fallback>
+ </xi:include>
+ </programlisting>
+ </example>
+
+
+ <example>
+ <info>
+ <title>Unsubscribing a user from a mailing list</title>
+ </info>
+
+ <programlisting role="php">
+ <xi:include parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude"
+ href="&package.webservices.services-mailman.examples.unsubscribe.php;"
+ >
+ <xi:fallback>FIXME:MISSING XINCLUDE CONTENT</xi:fallback>
+ </xi:include>
+ </programlisting>
+ </example>
+
+</section>
Added: pear/peardoc/trunk/en/package/webservices/services-mailman/getting-started.xml
===================================================================
--- pear/peardoc/trunk/en/package/webservices/services-mailman/getting-started.xml (rev 0)
+++ pear/peardoc/trunk/en/package/webservices/services-mailman/getting-started.xml 2012-02-12 19:28:29 UTC (rev 323165)
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="utf-8"?>
+<section xmlns="http://docbook.org/ns/docbook" version="lillet"
+ xmlns:phd="http://www.php.net/ns/phd"
+ xml:id="package.webservices.services-mailman.getting-started"
+>
+ <info>
+ <title>Getting started</title>
+ </info>
+
+ <para>
+ To use Services_Mailman, you need to include it into your PHP file:
+ </para>
+ <programlisting role="php"><![CDATA[
+require_once 'Services/Mailman.php';
+ ]]></programlisting>
+
+ <para>
+ Then, create a
+ <phd:pearapi phd:package="Services_Mailman" phd:linkend="Services_Mailman"/>
+ object and supply the "Admin Links" URL and the admin password:
+ </para>
+ <programlisting role="php"><![CDATA[
+$mm = new Services_Mailman('http://example.org/mailman/admin', '', 'adminpass');
+ ]]></programlisting>
+
+ <para>
+ If you already know the mailing list you want to work on, specify it
+ as second constructor parameter:
+ </para>
+ <programlisting role="php"><![CDATA[
+$mm = new Services_Mailman(
+ 'http://example.org/mailman/admin',
+ 'foo-users',
+ 'adminpass'
+);
+ ]]></programlisting>
+
+
+ <section xml:id="package.webservices.services-mailman.getting-started.errors">
+ <info>
+ <title>Error handling</title>
+ </info>
+ <para>
+ If something goes wrong, Services_Mailman's methods will throw exceptions
+ of type
+ <phd:pearapi phd:package="Services_Mailman" phd:linkend="Services_Mailman_Exception"/>.
+ Using it's <literal>getMessage()</literal> method will give you
+ a human-readable error message.
+ </para>
+ </section>
+</section>
\ No newline at end of file
Added: pear/peardoc/trunk/en/package/webservices/services-mailman.xml
===================================================================
--- pear/peardoc/trunk/en/package/webservices/services-mailman.xml (rev 0)
+++ pear/peardoc/trunk/en/package/webservices/services-mailman.xml 2012-02-12 19:28:29 UTC (rev 323165)
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<book
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:phd="http://www.php.net/ns/phd"
+ version="lillet"
+ xml:id="package.webservices.services-mailman"
+>
+ <info>
+ <title>Services_Mailman</title>
+ <abstract>
+ <para>
+ <phd:pearapi phd:package="Services_Mailman"/>
+ provides a PHP API to Mailman, the GNU Mailing List Manager.
+ </para>
+ <para>
+ With it, you may suscribe and unsubscribe users to/from a mailing list,
+ enumerate all lists and list a list's members.
+ </para>
+ <para>
+ It utilizes Mailman's web interface via HTTP/HTTPS, so you do not need
+ to interface Python or the mailman binaries.
+ </para>
+ </abstract>
+ </info>
+
+ <chapter>
+ &package.webservices.services-mailman.getting-started;
+ &package.webservices.services-mailman.examples;
+ </chapter>
+</book>
Modified: pear/peardoc/trunk/en/package/webservices-entities.xml
===================================================================
--- pear/peardoc/trunk/en/package/webservices-entities.xml 2012-02-12 16:06:16 UTC (rev 323164)
+++ pear/peardoc/trunk/en/package/webservices-entities.xml 2012-02-12 19:28:29 UTC (rev 323165)
@@ -5,6 +5,7 @@
&package.webservices.services-ebay;
&package.webservices.services-geonames;
&package.webservices.services-google;
+&package.webservices.services-mailman;
&package.webservices.services-recaptcha;
&package.webservices.services-technorati;
&package.webservices.services-w3c-htmlvalidator;
--f00d88b6a002b266a15cfbfee370e0465bd1ca14--