# Ressources FiveM

# Utilisez la tablette XelBob-tab

****XelBob-tab****<span style="white-space: pre-wrap;"> est le produit de l'association entre </span>[<span style="color: rgb(242, 169, 34);">Xelyos</span>](https://xelyos.fr/discord)<span style="color: rgb(242, 169, 34); white-space: pre-wrap;"> </span><span style="white-space: pre-wrap;">et </span>[<span style="color: rgb(45, 194, 107);">Bob's&amp;Co</span>](https://discord.gg/X36mxQTk5b). Cette tablette utilisable sur Fivem vous permet d'afficher le contenu de sites internet directement sur votre serveur.  
[Afficher plus d'info](https://wiki.xelyos.fr/books/xelbob-tab)

[![image.png](https://xelyos-wiki.s3.amazonaws.com/uploads/images/gallery/2025-04/scaled-1680-/JoQimage.png)](https://xelyos-wiki.s3.amazonaws.com/uploads/images/gallery/2025-04/JoQimage.png)

# Ressources GTA V - Installation

##### <span style="color: rgb(224, 62, 45);">Cette ressources n'est plus fonctionnelle pour le moment !</span>

## Installer la ressource

**Pour récupérer la clé vous permettant d'utiliser l'api de Mail RP, rendez vous sur la page :** [**Récupérer sa clé API**](https://wiki.xelyos.fr/books/api-mail-rp/page/presentation-de-lapi)

Voici deux méthodes pour installer la ressources sur votre serveur :

<u>****Avec git :****</u>

<span style="white-space: pre-wrap;">Rendez vous dans le dossier </span>`<span class="editor-theme-code">resources</span>`<span style="white-space: pre-wrap;"> de votre serveur, et utiliser la commande suivante :</span>

```ssh
git clone https://github.com/XelyosTeam/fivem-resources.git [xelyos]
```

<span style="white-space: pre-wrap;">Un dossier va allors de créer sous le nom </span>****\[xelyos\]****<span style="white-space: pre-wrap;">, vérifiez bien que dans ce répertoire vous trouverez le répertoire </span>****mailrp****.

<u>****Sans git :****</u>

<span style="white-space: pre-wrap;">Rendez vous sur le git : </span>[****Last releases Git Xelyos Resources FiveM****](https://github.com/XelyosTeam/fivem-resources/releases/latest/)<span style="white-space: pre-wrap;"> et télécharger le fichier </span>`<span class="editor-theme-code">.zip</span>`<span style="white-space: pre-wrap;">. Déplacez le fichier zip téléchargé dans votre répertoire </span>`<span class="editor-theme-code">resources</span>`<span style="white-space: pre-wrap;">, et faîtes </span>**extraire-ici**<span style="white-space: pre-wrap;">, renommer le nouveau fichier installer en </span>****\[xelyos\]****

---

## Activer la ressource

<u>****Lier à l'API :****</u>

<span style="white-space: pre-wrap;">Pour lié votre serveur FiveM avec l'api de Mail RP, vous devez vous rendre dans le fichier </span>`<span class="editor-theme-code">resources/[xelyos]/mailrp/server.lua</span>`<span style="white-space: pre-wrap;">, au niveau de la ligne 6, remplacez </span>****apiToken****<span style="white-space: pre-wrap;"> par votre clé.</span>

<u>****Activer la ressource :****</u>

<span style="white-space: pre-wrap;">Pour activer la ressource sur votre serveur, ajouter dans votre </span>`<span class="editor-theme-code">server.cfg</span>`<span style="white-space: pre-wrap;"> les lignes suivantes :</span>

```cfg
# Xelyos solutions
ensure mailrp
```

**Si vous utilisez déjà des ressources Xelyos, vous n'avez qu'à ajouter la ligne à la suite des autres.**

---

## Utiliser la ressource

<u>****La fonction callback :****</u>

```lua
function requestAction(statusCode, resultData)
  -- Action qui suit la requête
end
```

<span style="white-space: pre-wrap;">Lorsque vous allez faire appel à l'API, un résultat est envoyé en fonction de la requête que vous utilisez. Pour exploiter cette réponse, vous devrez utilisez une fonction </span>**callback**<span style="white-space: pre-wrap;">, dans cette fonction écrivez les actions qui devront suivre la requête. Vous pouvez renommer la fonction </span>**callback**<span style="white-space: pre-wrap;"> comme vous le voulez.</span>

<table id="bkmrk-variable-d%C3%A9finition-"><colgroup><col></col><col></col></colgroup><tbody><tr><th>Variable

</th><th>Définition

</th></tr><tr><td><span style="white-space: pre-wrap;">statusCode </span>

****(obligatoire)****

</td><td>Résultat du status de la requête (200 : réussite | 403 : échec)

</td></tr><tr><td><span style="white-space: pre-wrap;">resultData </span>

****(obligatoire)****

</td><td>Données retournées au format JSON

</td></tr></tbody></table>

<u>****Appelez le code depuis un fichier serveur :****</u>

Pour utiliser l'api depuis un fichier serveur, vous devez utiliser la structure suivante :

```lua
function requestAction(statusCode, ResultData)
  ...
end

TriggerEvent('xelyos:MailRP', function(mailRP)
    mailRP:methode(requestAction)
end)
```

[Afficher la liste des méthodes](https://wiki.xelyos.fr/books/api-mail-rp/page/ressources-gta-v-methodes)

**Vous trouverez la liste des méthodes ci-dessous !**

<u>****Appelez le code depuis un fichier client :****</u>

Pour utiliser l'api depuis un fichier serveur, vous devez utiliser la structure suivante :

```lua
function requestAction(statusCode, ResultData)
  ...
end

TriggerServerEvent('xelyos:MailRP', function(mailRP)
    mailRP:methode(requestAction)
end)
```

[Afficher la liste des méthodes](https://wiki.xelyos.fr/books/api-mail-rp/page/ressources-gta-v-methodes)

---

## Exemple d'utilisation - Récupérer le nom de son serveur

```lua
function showServerInfo(statusCode, resultData)
    print("Status", statusCode) -- Status de la requête
    print('Result', resultData) -- Informations retournées
  	print('Server name', resultData.name) -- Récupération du nom du serveur
    print('Server count api request', resultData.api.count) -- Récupérer le nombre de requêtes effectuées au total pour le serveur
end

AddEventHandler('onResourceStart', function(resourceName)
    if GetCurrentResourceName() == resourceName then
      	-- Lors de l'initialisation de la ressource
        TriggerEvent('xelyos:MailRP', function(mailRP)
            mailRP:getServer(showServerInfo)
        end)
    end
end)
```

# Ressources GTA V - Méthodes

##### <span style="color: rgb(224, 62, 45);">Cette ressources n'est plus fonctionnelle pour le moment !</span>

<span style="white-space: pre-wrap;">Chaque méthode possède dans ses paramètres une variable appelée </span>`<span class="editor-theme-code">callBack</span>`, cette variable correspond à la fonction que vous utilisez pour le traitement des données renvoyées par l'API. Chaque variable utilisée dans les différentes méthodes sont expliquées sur le document API.

---

## getServer()

<u>****Utilité :****</u><span style="white-space: pre-wrap;"> Récupérer les informations sur son serveur</span>

<u>****Doc API :****</u><span style="white-space: pre-wrap;"> </span>[Gestion du serveur - Informations générales](https://wiki.xelyos.fr/books/api-mail-rp/page/gestion-du-serveur)

<u>****Appel :****</u>

```lua
mailRP:getServer(callBack)
```

---

## findSubdomains()

<u>****Utilisé :****</u><span style="white-space: pre-wrap;"> Récupérer la liste des sous domaines de votre serveur</span>

<u>****Doc API :****</u><span style="white-space: pre-wrap;"> </span>[Gestion des sous domaines - Liste des sous domaines](https://wiki.xelyos.fr/link/170#bkmrk-liste-des-sous-domai)

<u>****Appel :****</u>

```lua
mailRP:findSubdomains(callBack)
```

---

## findSubdomain(name)

<u>****Utilisé :****</u><span style="white-space: pre-wrap;"> Récupérer les informations d'un sous domaine avec ses adresses mails</span>

<u>****Doc API :****</u><span style="white-space: pre-wrap;"> </span>[Gestion des sous domaines - Détails d'un sous domaine](https://wiki.xelyos.fr/link/170#bkmrk-d%C3%A9tails-d%27un-sous-do)

<u>****Appel :****</u>

```lua
mailRP:findSubdomain(callBack, name)
```

---

## addSubdomain(name, public, manager, carnet)

<u>****Utilisé :****</u><span style="white-space: pre-wrap;"> Créer un nouveau sous domaine</span>

<u>****Doc API :****</u><span style="white-space: pre-wrap;"> </span>[Gestion des sous domaines - Ajouter un sous domaine](https://wiki.xelyos.fr/link/170#bkmrk-ajouter-un-sous-doma)

<u>****Appel :****</u>

```lua
mailRP:addSubdomain(callBack, name, public, manager, carnet)
```

---

## findAddress(email)

<u>****Utilisé :****</u><span style="white-space: pre-wrap;"> Récupérer les informations d'une adresse mail</span>

<u>****Doc API :****</u><span style="white-space: pre-wrap;"> </span>[Gestion des adresses - Récupérer une adresse mail](https://wiki.xelyos.fr/link/171#bkmrk-r%C3%A9cup%C3%A9rer-une-adress)

<u>****Appel :****</u>

```lua
mailRP:findAddress(callBack, email)
```

---

## addAddress(name, firstname, email, password)

<u>****Utilisé :****</u><span style="white-space: pre-wrap;"> Créer une adresse mail</span>

<u>****Doc API :****</u><span style="white-space: pre-wrap;"> </span>[Gestion des adresses - Créer une adresse mail](https://wiki.xelyos.fr/link/171#bkmrk-cr%C3%A9er-une-adresse-ma)

<u>****Appel :****</u>

```lua
mailRP:addAddress(callBack, name, firstname, email, password)
```

---

## sendEmail(from, to, subject, content, confirmOpened, attachments)

<u>****Utilisé :****</u><span style="white-space: pre-wrap;"> Envoyer un mail depuis une adresses à un ou plusieurs destinataires</span>

<u>****Doc API :****</u><span style="white-space: pre-wrap;"> </span>[Gestion des mails - Envoyer un mail](https://wiki.xelyos.fr/link/172#bkmrk-envoyer-un-mail)

<u>****Appel :****</u>

```lua
mailRP:sendEmail(callBack, from, to, subject, content, confirmOpened, attachments)
```