delete-notes/README.md

<div id="top"></div>

<!-- PROJECT LOGO -->
<br />
<div align="center">
  <a href="https://github.com/FreeScout-shop/delete-notes">
    <img src="Public/assets/icon.modern.png" alt="Logo" width="700" height="700">
  </a>

<h1 align="center">FreeScout Module: Delete Notes</h1>

  <p align="center">
    The Module allows FreeScout users ("support agents") to delete their own notes on conversations.
    <br />
    <br />
    <a href="https://freescout.shop/downloads/freescout-module-delete-notes/">View on FreeScout.shop</a>
    ·
    <a href="https://github.com/FreeScout-shop/delete-notes/issues">Report Bug</a>
    ·
    <a href="https://github.com/FreeScout-shop/delete-notes/issues">Request Feature</a>
  </p>
  <h6 align="center">
    <p>Required FreeScout version: <strong>1.8.22</strong></p>
    <p><strong>Translations included:</strong>
    <span class="ar">🇪🇬 Arabic</span> <span class="zh-CN">🇨🇳 Chinese (simp.)</span> <span class="zh-TW">🇨🇳 Chinese (trad.)</span><br/><span class="hr">🇭🇷 Croatian</span> <span class="cz">🇨🇿 Czech</span> <span class="nl">🇳🇱 Dutch</span> <span class="gb">🇬🇧 English</span> <span class="fr">🇫🇷 French</span><br/><span class="de">🇩🇪 German</span> <span class="hi">🇮🇳 Hindi</span> <span class="it">🇮🇹 Italian</span> <span class="ja">🇯🇵 Japanese</span> <span class="pl">🇵🇱 Polish</span><br/><span class="ru">🇷🇺 Russian</span> <span class="sk">🇸🇰 Slovak</span> <span class="es">🇪🇸 Spanish</span> <span class="sv">🇸🇪 Swedish</span></p>
  </h6>
  <p>
    <hr/>
    <strong>🎁 This FreeScout Module is free of charge for private and commecial use.</strong><br />
    <small><em>We appreciate if you consider buying one of our <a href="https://freescout.shop/paid-freescout-modules/" target="_blank">other modules</a> though! 🙃</em></small>
    <hr/>
  </p>
</div>



<!-- TABLE OF CONTENTS -->
<details>
  <summary>Table of Contents</summary>
  <ol>
    <li>
      <a href="#about-the-project">About The Project</a>
      <ul>
        <li><a href="#built-with">Built with</a></li>
      </ul>
    </li>
    <li>
      <a href="#getting-started">Getting Started</a>
      <ul>
        <li><a href="#prerequisites">Prerequisites</a></li>
        <li><a href="#installation">Installation</a></li>
      </ul>
    </li>
    <li><a href="#contact">Contact</a></li>
  </ol>
</details>



<!-- ABOUT THE PROJECT -->
## About The Project

The Delete Notes Module allows FreeScout users to delete their own notes, a feature that has been mentioned before, but was never implemented into FreeScout.

In order to delete notes, the user is required to have acces to the (new) "Users are allowed to delete their own notes" permission:

<p align="center"><img class="wp-image-1113 size-full" src="http://freescout.shop/wp-content/uploads/edd/2022/05/screen.permissions.png" alt="FreeScout user permissions dialog with new &quot;Users are allowed to delete their own notes&quot; option." width="600" height="318" />
<br/><small><em>Not all users have to be able to delete notes.</em></small>
</p>

When the permission is granted, a new entry in the thread dropdown menu will appear:

<p align="center">
<img class="wp-image-1134 size-full" src="http://freescout.shop/wp-content/uploads/edd/2022/05/screen.menu_.png" alt="A FreeScout note with the dropdown menu opened, displaying a new option to delete the note." width="600" height="274" />
<br/><small><em>How to delete a FreeScout note?</em></small>
</p>

And after a simple prompt - who would've guessed - the note is gone for good.

Other users will see an action text, informing them about the deletion and date:


<p align="center">
<img class="wp-image-1134 size-full" src="http://freescout.shop/wp-content/uploads/edd/2022/10/screen.action.png" alt="A FreeScout note with the dropdown menu opened, displaying a new option to delete the note." width="785" height="165" />
<br/><small><em>When an admin deletes a note, the action text is omitted.</em></small>
</p>

<p align="right">(<a href="#top">back to top</a>)</p>


### Built With

* [PHP](https://php.net/)
* [Laravel](https://laravel.com/)
* [FreeScout](https://freescout.net/)

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- GETTING STARTED -->
## Getting Started

TLDR; unpack [Module ZIP](https://freescout.shop/downloads/freescout-module-delete-notes/) into `/Module` folder.

### Prerequisites

- Make sure you have write access to the `Modules` directory of your FreeScout installation.
- The required FreeScout Version is <strong>1.8.15</strong>. Go to "Manage" > "System" to see your current version.

### Installation

1. Download the module file (for free) from <kbd><strong>[FreeScout.shop](https://freescout.shop/downloads/freescout-module-delete-notes/)</strong></kbd>
2. Open the FreeScout `Modules` folder, usually located at `/var/www/html/Modules`
3. Unzip the downloaded module file into the `/Modules` folder
4. Remove the ZIP file
5. In FreeScout, go to "Manage" > "Modules"
6. Click on "Activate" to enable the module
7. Clear the FreeScout cache via `Manage` > `System` > `Tools` > `Clear cache`

<p align="right">(<a href="#top">back to top</a>)</p>



<!-- CONTACT -->
## Contact

[FreeScout.shop](https://freescout.shop) - service@freescout.shop

Download Link: [https://freescout.shop/downloads/freescout-module-delete-notes/](https://freescout.shop/downloads/freescout-module-delete-notes/)

Repository Link: [https://github.com/FreeScout-shop/delete-notes](https://github.com/FreeScout-shop/delete-notes)

<p align="right">(<a href="#top">back to top</a>)</p>