examples: Reworked POP3 examples for additional upcoming POP3 examples

diff --git a/docs/examples/Makefile.inc b/docs/examples/Makefile.inc
index b6494f46d4339864e6176c4549914456b139f42c..d3ae10a390455204506763e0574b75b1d36253a6 100644 (file)
--- a/docs/examples/Makefile.inc
+++ b/docs/examples/Makefile.inc
@@ -5,7 +5,7 @@ check_PROGRAMS = 10-at-a-time anyauthput cookie_interface debug fileupload \
   persistant post-callback postit2 sepheaders simple simplepost simplessl  \
   sendrecv httpcustomheader certinfo chkspeed ftpgetinfo ftp-wildcard \
   smtp-multi smtp-send smtp-ssl smtp-tls smtp-vrfy smtp-expn rtsp \
-  externalsocket resolve progressfunc pop3s pop3slist imap-list imap-fetch \
+  externalsocket resolve progressfunc pop3-list pop3-ssl imap-list imap-fetch \
   imap-store imap-append imap-examine imap-search imap-create imap-delete \
   imap-copy imap-ssl imap-tls url2file sftpget ftpsget postinmemory
 

diff --git a/docs/examples/pop3slist.c b/docs/examples/pop3-list.c
similarity index 59%
rename from docs/examples/pop3slist.c
rename to docs/examples/pop3-list.c
index cc31bfd076957d46ae965e613d71a4455c837d8b..7e76d1ea0cf620c13ae3fcf03a837f28bc2b951b 100644 (file)
--- a/docs/examples/pop3slist.c
+++ b/docs/examples/pop3-list.c
@@ -22,10 +22,16 @@
 #include <stdio.h>
 #include <curl/curl.h>
 
+/* This is a simple example using libcurl's POP3 capabilities to list the
+ * contents of a mailbox.
+ *
+ * Note that this example requires libcurl 7.20.0 or above.
+ */
+
 int main(void)
 {
   CURL *curl;
-  CURLcode res;
+  CURLcode res = CURLE_OK;
 
   curl = curl_easy_init();
   if(curl) {
@@ -34,33 +40,9 @@ int main(void)
     curl_easy_setopt(curl, CURLOPT_PASSWORD, "secret");
 
     /* This will list every message of the given mailbox */
-    curl_easy_setopt(curl, CURLOPT_URL, "pop3s://user@pop.example.com/");
-
-#ifdef SKIP_PEER_VERIFICATION
-    /*
-     * If you want to connect to a site who isn't using a certificate that is
-     * signed by one of the certs in the CA bundle you have, you can skip the
-     * verification of the server's certificate. This makes the connection
-     * A LOT LESS SECURE.
-     *
-     * If you have a CA cert for the server stored someplace else than in the
-     * default bundle, then the CURLOPT_CAPATH option might come handy for
-     * you.
-     */
-    curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
-#endif
-
-#ifdef SKIP_HOSTNAME_VERFICATION
-    /*
-     * If the site you're connecting to uses a different host name that what
-     * they have mentioned in their server certificate's commonName (or
-     * subjectAltName) fields, libcurl will refuse to connect. You can skip
-     * this check, but this will make the connection less secure.
-     */
-    curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
-#endif
+    curl_easy_setopt(curl, CURLOPT_URL, "pop3://pop.example.com");
 
-    /* Perform the request, res will get the return code */
+    /* Perform the list */
     res = curl_easy_perform(curl);
 
     /* Check for errors */

diff --git a/docs/examples/pop3s.c b/docs/examples/pop3-ssl.c
similarity index 79%
rename from docs/examples/pop3s.c
rename to docs/examples/pop3-ssl.c
index 368d61f2ba4e56c334101f07362fac2d6f3138fa..cfdec10eccadc0a1d2e189a706e0e9ccbed43e77 100644 (file)
--- a/docs/examples/pop3s.c
+++ b/docs/examples/pop3-ssl.c
@@ -22,10 +22,16 @@
 #include <stdio.h>
 #include <curl/curl.h>
 
+/* This is a simple example showing how to retrieve mail using libcurl's POP3
+ * capabilities.
+ *
+ * Note that this example requires libcurl 7.20.0 or above.
+ */
+
 int main(void)
 {
   CURL *curl;
-  CURLcode res;
+  CURLcode res = CURLE_OK;
 
   curl = curl_easy_init();
   if(curl) {
@@ -33,34 +39,31 @@ int main(void)
     curl_easy_setopt(curl, CURLOPT_USERNAME, "user");
     curl_easy_setopt(curl, CURLOPT_PASSWORD, "secret");
 
-    /* This will only fetch the message with ID "1" of the given mailbox */
-    curl_easy_setopt(curl, CURLOPT_URL, "pop3s://user@pop.example.com/1");
+    /* This will retreive message 1 from the user's mailbox. Note the use of
+     * pop3s:// rather than pop3:// to request a SSL based connection. */
+    curl_easy_setopt(curl, CURLOPT_URL, "pop3s://pop.example.com/1");
 
-#ifdef SKIP_PEER_VERIFICATION
-    /*
-     * If you want to connect to a site who isn't using a certificate that is
+    /* If you want to connect to a site who isn't using a certificate that is
      * signed by one of the certs in the CA bundle you have, you can skip the
      * verification of the server's certificate. This makes the connection
      * A LOT LESS SECURE.
      *
      * If you have a CA cert for the server stored someplace else than in the
      * default bundle, then the CURLOPT_CAPATH option might come handy for
-     * you.
-     */
+     * you. */
+#ifdef SKIP_PEER_VERIFICATION
     curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
 #endif
 
-#ifdef SKIP_HOSTNAME_VERFICATION
-    /*
-     * If the site you're connecting to uses a different host name that what
+    /* If the site you're connecting to uses a different host name that what
      * they have mentioned in their server certificate's commonName (or
      * subjectAltName) fields, libcurl will refuse to connect. You can skip
-     * this check, but this will make the connection less secure.
-     */
+     * this check, but this will make the connection less secure. */
+#ifdef SKIP_HOSTNAME_VERFICATION
     curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
 #endif
 
-    /* Perform the request, res will get the return code */
+    /* Perform the retr */
     res = curl_easy_perform(curl);
 
     /* Check for errors */