From 06b288a72d8db4814bf9eb98eba9be0ea6971a76 Mon Sep 17 00:00:00 2001 From: Steve Holme Date: Sun, 22 Nov 2015 11:55:10 +0000 Subject: examples: Added website parse-able descriptions to the e-mail examples --- docs/examples/imap-append.c | 4 +++- docs/examples/imap-copy.c | 8 +++++++- docs/examples/imap-create.c | 8 +++++++- docs/examples/imap-delete.c | 8 +++++++- docs/examples/imap-examine.c | 8 +++++++- docs/examples/imap-fetch.c | 8 +++++++- docs/examples/imap-list.c | 8 +++++++- docs/examples/imap-lsub.c | 8 +++++++- docs/examples/imap-multi.c | 6 ++++++ docs/examples/imap-noop.c | 8 +++++++- docs/examples/imap-search.c | 8 +++++++- docs/examples/imap-ssl.c | 8 +++++++- docs/examples/imap-store.c | 8 +++++++- docs/examples/imap-tls.c | 8 +++++++- docs/examples/pop3-dele.c | 8 +++++++- docs/examples/pop3-list.c | 8 +++++++- docs/examples/pop3-multi.c | 6 ++++++ docs/examples/pop3-noop.c | 8 +++++++- docs/examples/pop3-retr.c | 8 +++++++- docs/examples/pop3-ssl.c | 8 +++++++- docs/examples/pop3-stat.c | 8 +++++++- docs/examples/pop3-tls.c | 8 +++++++- docs/examples/pop3-top.c | 8 +++++++- docs/examples/pop3-uidl.c | 8 +++++++- docs/examples/smtp-expn.c | 10 ++++++++-- docs/examples/smtp-mail.c | 8 +++++++- docs/examples/smtp-multi.c | 8 +++++++- docs/examples/smtp-ssl.c | 8 +++++++- docs/examples/smtp-tls.c | 8 +++++++- docs/examples/smtp-vrfy.c | 10 ++++++++-- 30 files changed, 206 insertions(+), 30 deletions(-) diff --git a/docs/examples/imap-append.c b/docs/examples/imap-append.c index fb58b4b23..c2fe2ab1f 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 fe2d91c1b..0b283ea60 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 65ddede6c..26a86f730 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 5113be9ab..3f55562b4 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 a7b41c58a..45b7ccc45 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 831d0dcf3..4c833d381 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 4223052e4..ee97a12ad 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 8960b62b4..0a1b5b2e4 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 dc6f8ba3c..a890bce4d 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 71a557283..7b3b4b071 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 0c1d26734..b5e24cc3f 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 eec9b0e31..79b8df1b9 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 8f5e7d5b2..e900f4b49 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 c439864be..89fc2f6af 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 fab598f00..d0d2a49e9 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 aebcea6b6..49dd19ed3 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 feca2fa9b..85a36922d 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 4efe67152..7eda5ba2e 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 b5113fa99..c28cdc9c7 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 0bbec8d9d..bed2d5056 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 7b318fc22..d4297f251 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 58278a1e2..2c4f63577 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 21cee889a..831e7a5e8 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 debb17915..f947f1fa6 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 0322d2fc5..0454433c7 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 eea90b8a8..a1abaa352 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 4098c7d18..936c56b9c 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 a774403fc..bb77d68f7 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 4872dbdf1..c9f5c99c1 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 4e44cea96..9bd0cdf62 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: -- cgit v1.2.3