Using cPanel API for creating email account and forwarders in your own PHP scripts

**David I** · 07-13-2011

Recently one of our clients asked: "Can I create email account within a php script?" Taking in consideration high possibilities of cPanel API we have decided to search for related requests on the Internet and have found out that many people are interested in this question.

What is this needed for? For example, we have an awesome domain and you want to become a mail service provider, but creating mailboxes manually is not going to work. You can create addon domains, redirects and other things in the same way.

We need following for the script:

1. Request form (file index.php can be found in the attachments).
2. cPanel XML API Client Class (file xmlapi.php can be found in the attachments).

Let's check script of the form in detail:

PHP Code:

 $ip = "127.0.0.1";                // should be server IP address or 127.0.0.1 if local server
$account = "username";            // cPanel user account name
$passwd ="password";            // cPanel user password
$port =2083;                    // cpanel secure authentication port
$email_domain = 'domain.com';   // email domain (usually same as cPanel domain)
$email_quota = 50;                // default amount of space in megabytes

Creating XMLAPI request:

PHP Code:

 
$xmlapi = new xmlapi($ip);

//set port number. cpanel client class allow you to access WHM as well using WHM port.
$xmlapi->set_port($port);                        

// authorization with password. Not as secure as hash.
$xmlapi->password_auth($account, $passwd);   

// cpanel email addpop function Parameters
$call = array(domain=>$email_domain, email=>$email_user,password=>$email_pass, quota=>$email_quota);

// cpanel email fwdopt function Parameters
$call_f  = array(domain=>$email_domain, email=>$email_user,
fwdopt=>"fwd", fwdemail=>$dest_email);

//output to error file  set to 1 to see
$xmlapi->set_debug(0);      
error_log.

// making call to cpanel api
$result = $xmlapi->api2_query($account, "Email", "addpop", 
$call);

//create a forward
$result_forward = $xmlapi->api2_query($account, "Email", "addforward",
$call_f);

And of course creating HTML form:

HTML Code:

<html>
<head>
<title>cPanel Email Account Creator</title>
</head>

<body>
<?php echo '<div style="color:red">'.$msg.'</div>'; ?>

<h1>cPanel Email Account Creator</h1>

<form name="frmEmail" method="post">
<table width="400" border="0">
    <tr>
        <td>Username:</td>
        <td><input name="user" size="20" type="text"/></td>
    </tr>    
    <tr>
        <td>Password:</td>
        <td><input name="pass" size="20" type="password"/></td>
    </tr>
    <tr>
        <td>Verify Password:</td>
        <td><input name="vpass" size="20"type="password" /></td>
    </tr>
    <tr>
        <td>Forwarde:</td>
        <td><input name="forward" size="20" type="text"/></td>
    </tr>
    <tr>
        <td colspan="2" align="center"><hr /><input name="submit" type="submit" value="Create Email" /></td>
    </tr>
</table>
</form>
</body>
</html>

Related links:

Creating multiple email account in cPanel with PHP and XMLAPI | Home Based Coder | Filipino Web Designer + Web Developer
Create Email Account using API
XMLAPI php class
Auto create email with PHP
cPanel XML and JSON APIs
xpl-api and cPanel APIs via PHP

**Alberto Moreno** · 07-13-2011

Hello Matt

Since I already have an index.php at public_html I am not sure about what to do about this file...

Should I create a new folder for instance (email_create), and then upload these three files in it? (xmlapi.php, index.php email_create.html)

Thanks
Alberto
regidordigital.com

**sergey** · 07-13-2011

You can rename the index.php to something else if you want to leave the files in public_html/ directory or you can place the files to a separate folder.

Please note that the entire code is in one file index.php. If you want the form to be a separate file then it needs to be recoded a bit.

**Pratima** · 07-14-2011

I am looking for good quality videos explaining design patterns. Can anyone recommend videos I can download and view on my PC. I am willing to pay for the videos.

**Matt** · 07-14-2011

You should probably start your own thread if you are looking for something specific.

**Alberto Moreno** · 07-14-2011

hhh

**Alberto Moreno** · 07-14-2011

Hello

I have created the form at

http://regidordigital.com/email_crea...il_create.html

But there must be something I am not doing properly...

............
Where it says I have put down muy cpanel username
and where it says password, the password...

where it says domain.com I have written regidordigital.com

I have protected the directory. I send you details to our private forum....

What could be wrong??

Thx
Alberto

**Matt** · 07-14-2011

Is there some error message on screen or in the error_log ?

**jcrimmel** · 09-11-2013

I everyone. I know how old this thread is so I am not entirely expecting a reply.

I am very new to Cpanel scripts and was able to set this up with no problems at all. I am using this to allow a client to create email address for themselves and their employees without having to take the extra step of requesting it through me. (I don't want to grant them direct Cpanel access)

I have found the Cpanel API2 script for changing passwords

Code:

$xmlapi = new xmlapi("Primary CPANEL domain"); 
$xmlapi->password_auth("username",$root_pass); 
$account = "Cpanel username"; 
$xmlapi->api2_query($account, "Email", "passwdpop", array( 'domain' => "domain name", 'email' => "user name", 'password' => "new password") );

and I am wondering if there would be anyway to incorporate this into the files posted in this thread. I would love to give my clients the option to change the email password if they needed to. But as I said before I am literally just learning about Cpanel APIs (12 hours now and counting!) so I'm not really sure how one would go about implementing this.

Anyone gracious enough to help out a very very green rookie?

Thanks in advance.
Jason

**Alexander** · 09-11-2013

Well, maybe I missed something, but they can change passwords for their email accounts in Webmail. There is an option for it on the very first page when accessing Webmail. Thus, API is not needed.

Thread: Using cPanel API for creating email account and forwarders in your own PHP scripts

LinkBack

Thread Tools

Search Thread

Display

Using cPanel API for creating email account and forwarders in your own PHP scripts

Email Create from fron end

Videos explaining design patterns.

Incorporate change password API2 script?

LinkBacks (?)

Help with an additional product

Similar Threads

default timezone

Single Account, Multiple Domains to WHM Account

Posting Permissions