update docs, links and screenshots

27ef9263 · Hahn Axel (hahn) · 8d96801f · 27ef9263 · 27ef9263 · 27ef9263
Commit 27ef9263 authored 8 months ago by Hahn Axel (hahn)
--- a/classes/emailcatcher.class.php
+++ b/classes/emailcatcher.class.php
@@ -7,6 +7,7 @@
 * 
 * 👤 Author: Axel Hahn, Institute for Medical Education, University of Bern
 * 📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/php-emailcatcher>
+ * 📗 Docs: <https://os-docs.iml.unibe.ch/php-emailcatcher/>
 * 📜 License: GNU GPL 3.0
 * 
 * ----------------------------------------------------------------------

--- a/docs/30_Usage.md
+++ b/docs/30_Usage.md
@@ -6,7 +6,16 @@ To browse emails and view each message open <http://localhost/vendor/emailcatche

 You see a list of emails.

+![Screenshot: List of emails](images/screenshot_list_emails.png)
+
 Click an email to view details of it including header and body.
+
+![Screenshot: Show details of selected Email](images/screenshot_show_email.png)
+
+If an html email was selected then you get an additional button to preview as html.
+
+![Screenshot: Show details of an html message](images/screenshot_show_html_email.png)
+
 If an html email was detected then you get an additional button to preview as html.

 ### Delete emails

--- a/docs/_index.md
+++ b/docs/_index.md
@@ -6,6 +6,6 @@
 </html>

 👤 Author: Axel Hahn; Institute for Medical Education; University of Bern \
-📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/php-emailcatcher> \
 📜 License: GNU GPL 3.0 \
-📗 Docs: <https://os-docs.iml.unibe.ch/__NAME__/> (see the docs folder so far)
+📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/php-emailcatcher> \
+📗 Docs: <https://os-docs.iml.unibe.ch/php-emailcatcher/>
--- a/docs/images/screenshot_list_emails.png
+++ b/docs/images/screenshot_list_emails.png
--- a/docs/images/screenshot_show_email.png
+++ b/docs/images/screenshot_show_email.png
--- a/docs/images/screenshot_show_html_email.png
+++ b/docs/images/screenshot_show_html_email.png
--- a/php-sendmail.php
+++ b/php-sendmail.php
@@ -8,6 +8,7 @@
 * 
 * 👤 Author: Axel Hahn, Institute for Medical Education, University of Bern
 * 📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/php-emailcatcher>
+ * 📗 Docs: <https://os-docs.iml.unibe.ch/php-emailcatcher/>
 * 📜 License: GNU GPL 3.0
 * 
 * ----------------------------------------------------------------------

--- a/readme.md
+++ b/readme.md
@@ -4,7 +4,10 @@ A helper for a development environment: This PHP class fetches emails sent by ma

 Free software and Open Source from University of Bern :: IML - Institute of Medical Education

-📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/php-emailcatcher> \
 📜 License: GNU GPL 3.0 \
-📗 Docs: TODO (see the docs folder so far)
+📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/php-emailcatcher> \
+📗 Docs: <https://os-docs.iml.unibe.ch/php-emailcatcher/>
+
+## Screenshot

+![Screenshot: Show details of an html message](docs/images/screenshot_show_html_email.png)
--- a/viewer.css
+++ b/viewer.css
@@ -97,13 +97,19 @@ pre{
    width: 50%;
    border-bottom-left-radius: 2em;
 }
-#singlemessage table{
+#singlemessage .header{
    background-color: #cdc;
    background: linear-gradient(to right, #cec, #cee);
    width: 100%;
    padding: 0.5em;
    border-bottom: 4px solid rgba(0,0,0,0.05);
 }
+#singlemessage table{
+    width: 80%;
+}
+#singlemessage table td.small{
+    width: 7em;
+}
 #singlemessage .content{
    padding: 0.5em;
 }
\ No newline at end of file
--- a/viewer.php
+++ b/viewer.php
@@ -7,10 +7,12 @@
 * 
 * 👤 Author: Axel Hahn, Institute for Medical Education, University of Bern
 * 📄 Source: <https://git-repo.iml.unibe.ch/iml-open-source/php-emailcatcher>
+ * 📗 Docs: <https://os-docs.iml.unibe.ch/php-emailcatcher/>
 * 📜 License: GNU GPL 3.0
 * 
 * ----------------------------------------------------------------------
 * 2024-10-08  v0.1  initial version
+ * 2024-10-09  v0.1  add links
 * =======================================================================
 */
 require_once('classes/emailcatcher.class.php');
@@ -37,14 +39,14 @@ function showEmail($sId)

        $bIsHtml=strstr( $oMail->getBody(), '<html>');
        $sReturn.= '<div id="singlemessage">
-            <table>
-                <tr><td>🕜 DATE</td><td>'.$oMail->getField('date')
-                    .'<span class="right"><a href="?" class="button close">❌ Close</a></span>
-                </td></tr>
-                <tr><td>👤 TO</td><td>'.$oMail->getField('to').'</td></tr>
-                <tr><td colspan=2><strong>'.$oMail->getField('subject').'</strong></td></tr>
-            </table>
-            <br>
+            <div class="header">
+                <span class="right"><a href="?" class="button close">❌ Close</a>&nbsp;&nbsp;&nbsp;</span>
+                <table>
+                    <tr><td class="small">🕜 DATE</td><td>'.$oMail->getField('date').'</td></tr>
+                    <tr><td class="small">👤 TO</td><td>'.$oMail->getField('to').'</td></tr>
+                </table>
+                <strong>'.$oMail->getField('subject').'</strong>
+            </div>
            <div class="content">
                📜 Header:<br>
                <pre>'.$oMail->getHeader().'</pre>
@@ -97,8 +99,8 @@ if(!count($aEmails)){
        $sMessage=showEmail($sOpen);    
    }

+    // show list of emails
    $sOut='Messages: <strong>'.count($aEmails).'</strong><br>';
-
    foreach($aEmails as $aEmail){

        $sId=$aEmail['id'];
@@ -132,8 +134,8 @@ echo "<!doctype html>

    <footer>
        Email catcher
-        📄 <a href=\"\">source</a>
-        📗 <a href=\"\">docs</a>
+        📄 <a href=\"https://git-repo.iml.unibe.ch/iml-open-source/php-emailcatcher\" target=\"source\">source</a>
+        📗 <a href=\"https://os-docs.iml.unibe.ch/php-emailcatcher/\" target=\"docs\">docs</a>
    </footer>

    $sMessage