README

使用这个扩展，您将能够通过yii2应用程序编程式地创建、更新、删除cPanel电子邮件账户。

使用此组件，您可以

• 创建新的电子邮件账户

• 更改现有账户的磁盘配额

• 更改现有账户的密码

• 删除账户

安装

安装此扩展的首选方式是通过 composer。

运行以下命令之一

php composer.phar require --prefer-dist filipajdacic/yii2-cpanel-email-creator "*"

或者将以下内容添加到您的 composer.json 文件的 require 部分中。

"filipajdacic/yii2-cpanel-email-creator": "*"

使用

使用

安装扩展后，只需在您的配置中添加以下内容即可使用它

'components' => array(
    ...
    'cpanelemailcreator' => array(
        'class' => 'filipajdacic\cpanelemailcreator\EmailCreator',
        'ip' => 'YOUR_CPANEL_SERVER/HOST_IP_ADDRESS',
        'port' => '2083', // it can be also 2086
        'cpanel_username' => 'YOUR_CPANEL_USERNAME',
        'cpanel_password' => 'YOUR_CPANEL_PASSWORD'
    ),
    ...
);

配置组件后，您可以使用它如下

1. 创建一个新的邮件账户

$domain = "mywebsite.com";
$email_username = "john.doe";
$email_password = "myaccountpassword123!";
$email_quota = 500; // in MB

$create_mail_account_result = Yii::$app->cpanelemailcreator->createNewAccount(
	$domain, 
	$email_username, 
	$email_password, 
	$email_quota
);

if($create_mail_account_result) {
	$result =  "Mail account ".$email_username."@".$domain." is created.";
} else {
	$result =  "Mail account is not created. Reason:".$create_mail_account_result;
}

echo $result;

注意，密码强度策略在WHM（Web Host Manager）中定义。

2. 更改现有电子邮件账户的密码

$domain = "mywebsite.com";
$email_username = "john.doe";
$email_new_password = "mynewaccountpassword123$";


$change_password_result = 	Yii::$app->cpanelemailcreator->changeAccountPassword( 
										$domain, 
							            $email_username, 
							            $email_new_password
							);

if($change_password_result) {
	$result = "Mail account password for ".$email_username." is changed.";
} else {
	$result = "Password is not changed. Reason:".$change_password_result;
}

echo $result;

3. 更改现有电子邮件账户的磁盘配额

$domain = "mywebsite.com";
$email_username = "john.doe";
$email_new_quota = "10000"; // in MB

$change_mail_quota_result = 	Yii::$app->cpanelemailcreator->changeEmailQuota( 
										$domain, 
							            $email_username, 
							            $email_new_quota
								);

if($change_mail_quota_result) {
	$result = "Mail quota for ".$email_username." is changed to ".$email_new_quota." MB.";
} else {
	$result = "Mail quota is not changed. Reason:".$change_password_result;
}

echo $result;

4. 删除现有电子邮件账户

$domain = "mywebsite.com";
$email_username = "john.doe";

$delete_mail_result = 	Yii::$app->cpanelemailcreator->deleteMailAccount( 
										$domain, 
							            $email_username, 
							            $email_new_quota
						);

if($delete_mail_result) {
	$result = "Mail account ".$email_username."@".$domain." is deleted."; 
} else {
	$result = "Mail account is not deleted. Reason:".$change_password_result;
}

echo $result;

资源

Yii框架扩展页面

如果您有任何问题，请随时提问！