Issue #11: implement mailnames fetching operations

Author: sibprogrammer

src/Api/Operator/Mail.php

@@ -53,4 +53,47 @@ public function delete($field, $value, $siteId)
 
         return 'ok' === (string) $response->status;
     }
+
+    /**
+     * @param string $name
+     * @param int $siteId
+     *
+     * @return Struct\GeneralInfo
+     */
+    public function get($name, $siteId)
+    {
+        $items = $this->getAll($siteId, $name);
+
+        return reset($items);
+    }
+
+    /**
+     * @param int $siteId
+     * @param string|null $name
+     *
+     * @return Struct\GeneralInfo[]
+     */
+    public function getAll($siteId, $name = null)
+    {
+        $packet = $this->_client->getPacket();
+        $getTag = $packet->addChild($this->_wrapperTag)->addChild('get_info');
+
+        $filterTag = $getTag->addChild('filter');
+        $filterTag->addChild('site-id', $siteId);
+        if (!is_null($name)) {
+            $filterTag->addChild('name', $name);
+        }
+
+        $response = $this->_client->request($packet, \PleskX\Api\Client::RESPONSE_FULL);
+        $items = [];
+        foreach ($response->xpath('//result') as $xmlResult) {
+            if (!isset($xmlResult->mailname)) {
+                continue;
+            }
+            $item = new Struct\GeneralInfo($xmlResult->mailname);
+            $items[] = $item;
+        }
+
+        return $items;
+    }
 }

src/Api/Struct/Mail/GeneralInfo.php

@@ -0,0 +1,25 @@
+<?php
+// Copyright 1999-2021. Plesk International GmbH.
+
+namespace PleskX\Api\Struct\Mail;
+
+class GeneralInfo extends \PleskX\Api\Struct
+{
+    /** @var int */
+    public $id;
+
+    /** @var string */
+    public $name;
+
+    /** @var string */
+    public $description;
+
+    public function __construct($apiResponse)
+    {
+        $this->_initScalarProperties($apiResponse, [
+            'id',
+            'name',
+            'description',
+        ]);
+    }
+}

tests/MailTest.php

@@ -54,4 +54,31 @@ public function testDelete()
         $result = static::$_client->mail()->delete('name', $mailname->name, static::$webspace->id);
         $this->assertTrue($result);
     }
+
+    public function testGet()
+    {
+        $mailname = static::$_client->mail()->create('test', static::$webspace->id);
+
+        $mailnameInfo = static::$_client->mail()->get('test', static::$webspace->id);
+        $this->assertEquals('test', $mailnameInfo->name);
+
+        static::$_client->mail()->delete('name', $mailname->name, static::$webspace->id);
+    }
+
+    public function testGetAll()
+    {
+        $mailname = static::$_client->mail()->create('test', static::$webspace->id);
+
+        $mailnamesInfo = static::$_client->mail()->getAll(static::$webspace->id);
+        $this->assertCount(1, $mailnamesInfo);
+        $this->assertEquals('test', $mailnamesInfo[0]->name);
+
+        static::$_client->mail()->delete('name', $mailname->name, static::$webspace->id);
+    }
+
+    public function testGetAllWithoutMailnames()
+    {
+        $mailnamesInfo = static::$_client->mail()->getAll(static::$webspace->id);
+        $this->assertCount(0, $mailnamesInfo);
+    }
 }