From: Steve Holme Date: Sun, 22 Nov 2015 11:55:10 +0000 (+0000) Subject: examples: Added website parse-able descriptions to the e-mail examples X-Git-Tag: curl-7_46_0~25 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=06b288a72d8db4814bf9eb98eba9be0ea6971a76;p=thirdparty%2Fcurl.git examples: Added website parse-able descriptions to the e-mail examples --- diff --git a/docs/examples/imap-append.c b/docs/examples/imap-append.c index fb58b4b23a..c2fe2ab1f7 100644 --- a/docs/examples/imap-append.c +++ b/docs/examples/imap-append.c @@ -19,10 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + /* - * Simple IMAP APPEND use + * IMAP example showing how to send e-mails * */ + #include #include #include diff --git a/docs/examples/imap-copy.c b/docs/examples/imap-copy.c index fe2d91c1be..0b283ea600 100644 --- a/docs/examples/imap-copy.c +++ b/docs/examples/imap-copy.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example showing how to copy an e-mail from one folder to another + * + */ + #include #include diff --git a/docs/examples/imap-create.c b/docs/examples/imap-create.c index 65ddede6ca..26a86f7301 100644 --- a/docs/examples/imap-create.c +++ b/docs/examples/imap-create.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example showing how to create a new folder + * + */ + #include #include diff --git a/docs/examples/imap-delete.c b/docs/examples/imap-delete.c index 5113be9ab5..3f55562b43 100644 --- a/docs/examples/imap-delete.c +++ b/docs/examples/imap-delete.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example showing how to delete a folder + * + */ + #include #include diff --git a/docs/examples/imap-examine.c b/docs/examples/imap-examine.c index a7b41c58aa..45b7ccc453 100644 --- a/docs/examples/imap-examine.c +++ b/docs/examples/imap-examine.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example showing how to obtain information about a folder + * + */ + #include #include diff --git a/docs/examples/imap-fetch.c b/docs/examples/imap-fetch.c index 831d0dcf3f..4c833d3816 100644 --- a/docs/examples/imap-fetch.c +++ b/docs/examples/imap-fetch.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example showing how to retreieve e-mails + * + */ + #include #include diff --git a/docs/examples/imap-list.c b/docs/examples/imap-list.c index 4223052e41..ee97a12adf 100644 --- a/docs/examples/imap-list.c +++ b/docs/examples/imap-list.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example to list the folders within a mailbox + * + */ + #include #include diff --git a/docs/examples/imap-lsub.c b/docs/examples/imap-lsub.c index 8960b62b4f..0a1b5b2e4b 100644 --- a/docs/examples/imap-lsub.c +++ b/docs/examples/imap-lsub.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example to list the subscribed folders + * + */ + #include #include diff --git a/docs/examples/imap-multi.c b/docs/examples/imap-multi.c index dc6f8ba3c0..a890bce4df 100644 --- a/docs/examples/imap-multi.c +++ b/docs/examples/imap-multi.c @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example using the multi interface + * + */ + #include #include #include diff --git a/docs/examples/imap-noop.c b/docs/examples/imap-noop.c index 71a5572835..7b3b4b0713 100644 --- a/docs/examples/imap-noop.c +++ b/docs/examples/imap-noop.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example showing how to perform a noop + * + */ + #include #include diff --git a/docs/examples/imap-search.c b/docs/examples/imap-search.c index 0c1d267349..b5e24cc3f6 100644 --- a/docs/examples/imap-search.c +++ b/docs/examples/imap-search.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example showing how to search for new e-mails + * + */ + #include #include diff --git a/docs/examples/imap-ssl.c b/docs/examples/imap-ssl.c index eec9b0e314..79b8df1b97 100644 --- a/docs/examples/imap-ssl.c +++ b/docs/examples/imap-ssl.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example using SSL + * + */ + #include #include diff --git a/docs/examples/imap-store.c b/docs/examples/imap-store.c index 8f5e7d5b2e..e900f4b494 100644 --- a/docs/examples/imap-store.c +++ b/docs/examples/imap-store.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example showing how to modify the properties of an e-mail + * + */ + #include #include diff --git a/docs/examples/imap-tls.c b/docs/examples/imap-tls.c index c439864be2..89fc2f6afa 100644 --- a/docs/examples/imap-tls.c +++ b/docs/examples/imap-tls.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * IMAP example using TLS + * + */ + #include #include diff --git a/docs/examples/pop3-dele.c b/docs/examples/pop3-dele.c index fab598f008..d0d2a49e93 100644 --- a/docs/examples/pop3-dele.c +++ b/docs/examples/pop3-dele.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * POP3 example showing how to delete e-mails + * + */ + #include #include diff --git a/docs/examples/pop3-list.c b/docs/examples/pop3-list.c index aebcea6b66..49dd19ed3d 100644 --- a/docs/examples/pop3-list.c +++ b/docs/examples/pop3-list.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * POP3 example to list the contents of a mailbox + * + */ + #include #include diff --git a/docs/examples/pop3-multi.c b/docs/examples/pop3-multi.c index feca2fa9b9..85a36922d7 100644 --- a/docs/examples/pop3-multi.c +++ b/docs/examples/pop3-multi.c @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * POP3 example using the multi interface + * + */ + #include #include #include diff --git a/docs/examples/pop3-noop.c b/docs/examples/pop3-noop.c index 4efe67152d..7eda5ba2e8 100644 --- a/docs/examples/pop3-noop.c +++ b/docs/examples/pop3-noop.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * POP3 example showing how to perform a noop + * + */ + #include #include diff --git a/docs/examples/pop3-retr.c b/docs/examples/pop3-retr.c index b5113fa99c..c28cdc9c7c 100644 --- a/docs/examples/pop3-retr.c +++ b/docs/examples/pop3-retr.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * POP3 example showing how to retrieve e-mails + * + */ + #include #include diff --git a/docs/examples/pop3-ssl.c b/docs/examples/pop3-ssl.c index 0bbec8d9da..bed2d5056d 100644 --- a/docs/examples/pop3-ssl.c +++ b/docs/examples/pop3-ssl.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * POP3 example using SSL + * + */ + #include #include diff --git a/docs/examples/pop3-stat.c b/docs/examples/pop3-stat.c index 7b318fc224..d4297f2515 100644 --- a/docs/examples/pop3-stat.c +++ b/docs/examples/pop3-stat.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * POP3 example showing how to obtain message statistics + * + */ + #include #include diff --git a/docs/examples/pop3-tls.c b/docs/examples/pop3-tls.c index 58278a1e2a..2c4f635772 100644 --- a/docs/examples/pop3-tls.c +++ b/docs/examples/pop3-tls.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * POP3 example using TLS + * + */ + #include #include diff --git a/docs/examples/pop3-top.c b/docs/examples/pop3-top.c index 21cee889a5..831e7a5e8a 100644 --- a/docs/examples/pop3-top.c +++ b/docs/examples/pop3-top.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * POP3 example showing how to retreive only the headers of an e-mail + * + */ + #include #include diff --git a/docs/examples/pop3-uidl.c b/docs/examples/pop3-uidl.c index debb179154..f947f1fa6c 100644 --- a/docs/examples/pop3-uidl.c +++ b/docs/examples/pop3-uidl.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * POP3 example to list the contents of a mailbox by unique ID + * + */ + #include #include diff --git a/docs/examples/smtp-expn.c b/docs/examples/smtp-expn.c index 0322d2fc5a..0454433c74 100644 --- a/docs/examples/smtp-expn.c +++ b/docs/examples/smtp-expn.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,11 +19,17 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * SMTP example showing how to expand an e-mail mailing list + * + */ + #include #include #include -/* This is a simple example showing how to expand an email mailing list. +/* This is a simple example showing how to expand an e-mail mailing list. * * Notes: * diff --git a/docs/examples/smtp-mail.c b/docs/examples/smtp-mail.c index eea90b8a87..a1abaa352c 100644 --- a/docs/examples/smtp-mail.c +++ b/docs/examples/smtp-mail.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * SMTP example showing how to send e-mails + * + */ + #include #include #include diff --git a/docs/examples/smtp-multi.c b/docs/examples/smtp-multi.c index 4098c7d189..936c56b9c8 100644 --- a/docs/examples/smtp-multi.c +++ b/docs/examples/smtp-multi.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * SMTP example using the multi interface + * + */ + #include #include diff --git a/docs/examples/smtp-ssl.c b/docs/examples/smtp-ssl.c index a774403fcb..bb77d68f7a 100644 --- a/docs/examples/smtp-ssl.c +++ b/docs/examples/smtp-ssl.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * SMTP example using SSL + * + */ + #include #include #include diff --git a/docs/examples/smtp-tls.c b/docs/examples/smtp-tls.c index 4872dbdf11..c9f5c99c1b 100644 --- a/docs/examples/smtp-tls.c +++ b/docs/examples/smtp-tls.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,6 +19,12 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * SMTP example using TLS + * + */ + #include #include #include diff --git a/docs/examples/smtp-vrfy.c b/docs/examples/smtp-vrfy.c index 4e44cea968..9bd0cdf620 100644 --- a/docs/examples/smtp-vrfy.c +++ b/docs/examples/smtp-vrfy.c @@ -5,7 +5,7 @@ * | (__| |_| | _ <| |___ * \___|\___/|_| \_\_____| * - * Copyright (C) 1998 - 2014, Daniel Stenberg, , et al. + * Copyright (C) 1998 - 2015, Daniel Stenberg, , et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -19,11 +19,17 @@ * KIND, either express or implied. * ***************************************************************************/ + +/* + * SMTP example showing how to verify an e-mail address + * + */ + #include #include #include -/* This is a simple example showing how to verify an email address from an +/* This is a simple example showing how to verify an e-mail address from an * SMTP server. * * Notes: