README

一个用于管理 cPanel 邮箱账户的 PHP Laravel 扩展包

• 获取所有邮箱账户的列表。
• 创建一个新的邮箱账户。
• 删除一个邮箱账户。
• 更改邮箱账户的密码。
• 更改邮箱账户的磁盘配额。

安装

composer require erdikoroglu/laravel-cpanel-email

如果你的 Laravel 版本低于 5.5，需要在 config/app.php 中添加服务提供者和别名

Under Providers:
\ErdiKoroglu\cPanelMail\cPanelServiceProvider::class,

Under aliases:
'cPanel' => \ErdiKoroglu\cPanelMail\Facades\cPanelMail::class,

将这些添加到你的 .env 文件中

CPANEL_DOMAIN=your_domain.com
CPANEL_HOST=https://your_domain.com
CPANEL_PORT=2083 // cPanel port Default is: 2083
CPANEL_VERSION=2 // cPanel api current version
CPANEL_USERNAME=your_cpanel_username
CPANEL_PASSWORD=your_cpanel_password

用法

创建一个类对象

$cpanel = new cPanel()

获取所有邮箱地址的列表

$cpanel->getEmailAddresses()

Response:
array:5 [
  0 => Email {#227 ▼
    +user: "abc"
    +domain: "domain.com"
    +email: "abc@domain.com"
    +_diskused: 0
    +_diskquota: 0
    +humandiskused: "None"
    +humandiskquota: "None"
    +suspended_incoming: 0
    +suspended_login: 0
    +mtime: 1539715896
   }
 ]

创建一个新的邮箱账户

$cpanel->create('username','password')

Response:
[
  "status" => "success"
  "message" => "Email address has been added successfully"
]

删除一个邮箱账户

$cpanel->delete('email_address')

Response:
[
  "status" => "success"
  "message" => "Email address has been deleted successfully"
]

更改邮箱账户的密码

$cpanel->changePassword('username','password')

Response:
[
  "status" => "success"
  "message" => "Password has been changed successfully"
]

更改邮箱账户的磁盘配额

$cpanel->changeQuota('username',500)//quota as a number or 0 to set it as unlimited

Response:
[
  "status" => "success"
  "message" => "Email disk quota has been changed successfully"
]

支持

erdi@w3.ist www.w3.ist

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 获取更多信息。