XMail server quick start guide

¿How start the XMail server ?
Add a new administrator for the XMail server
Create the main domain
Add a domain
List the existent domains
Delete a domain
Create a new user
Delete an user
List the users of a domain
Change the password of an user
Obtain the statistical of an user

¿How start the XMail server ?
For  start the XMail server follow the procedure :

Windows : 
Execute the XMail server like a service, manual or automatic of agreement to the option selected during the installation.

Linux/Solaris/FreeBSD/OpenBSD : 
After installing properly the XMail server following the instructions of the file Readme.html, simply reboot the system. If it wishes start XMail without reboot the system can execute the following command :

#/etc/rc.d/init.d/xmail start

For more details on this subject consult the file Readme.html.


Add a new administrator for the XMail server
For add a new administrator for the XMail serve, can  use the editor of administrators "xmail_administrators"  or edit the file "ctrlaccounts.tab" manually. 

To use the editor of administrators, simply execute it from "{sysfile}\MailRoot\bin" in systems Windows or "/var/MailRoot/bin" in systems Unix if "xmail_administrators" is not installed then you has to compile and install it manually in "/var/MailRoot/bin"  to do this consult the file "install_xmail_administrators.txt" included with the code source of "xmail_administrators".
 


To edit the file "ctrlaccounts.tab" you has to open it with an editor of texts and add a name of administrator between quotes a character TAB(Ascii #9)  a password between quotes previously encrypted with XMCrypt, and a car return for example :

XMCrypt 123456789 

545756515053525d5c

The password 123456789 convert  in the value encrypted 545756515053525d5c that has to  write together with the name of the administrator inside the file "ctrlaccounts.tab", for example :

"xmail_admin" "545756515053525d5c"

For more details on this subject consult the file Readme.html.


Create the main domain
To create the main domain has to  edit manually  the file "server.tab" that contains the main variables of the server. For example to create the domain "first.domain.com" have to follow the following steps :

1)Stop the XMail server
2)Edit the file "server.tab" and modify the variables of configuration 
3)Start the XMail server

In this case the variables of configuration have to be edited of the following way :

#
# Example configuration file.
# Note : remember to use _REAL_ TABs and " to format this file
#
"RootDomain" "first.domain.com"
"SmtpServerDomain" "first.domain.com"
"POP3Domain" "first.domain.com"
"HeloDomain" "first.domain.com"
"PostMaster" "root@first.domain.com"
"ErrorsAdmin" "root@first.domain.com"
#"TempErrorsAdmin" "send-failures@xmailserver.test"
#"DefaultSMTPGateways" "192.168.1.2,192.168.1.15"
"RemoveSpoolErrors" "0"
#"NoSenderBounce" "1"
#"DisableEmitAuthUser" "1"
#"NotifyMsgLinesExtra" "8"
#"NotifySendLogToSender" "0"
#"NotifyTryPattern" "1"
"MaxMTAOps" "16"
"ReceivedHdrType" "0"
"FetchHdrTags" "+X-Deliver-To,+Received,To,Cc"
#"SMTP-TLS" "0"
#"EnableCTRL-TLS" "1"
#"EnableSMTP-TLS" "1"
#"EnablePOP3-TLS" "1"
#"SmtpMsgIPBanSpammers" "550 Denied due inclusion of your IP in our spam lists"
#"SmtpMsgIPBanSpamAddress" "550 Denied due inclusion of your email address in our spam lists"
#"SmtpMsgIPBanMaps" "550 Denied due inclusion of your IP in the following map"
#"CustomSMTPMessage" "Please open http://www.xmailserver.test/smtp_errors.html to get more information about this error"
#"MaxMessageSize" "20000"
#"EnableAuthSMTP-POP3" "0"
#"Pop3SyncErrorAccount" "psync-errors@xmailserver.test"
#"AllowNullSender" "1"
#"AllowSmtpVRFY" "1"
#"AllowSmtpETRN" "1"
#"SMTP-MaxErrors" "4"
#"SmtpMinDiskSpace" "100000"
#"SmtpMinVirtMemSpace" "64000"
#"Pop3MinVirtMemSpace" "64000"
#"CustMapsList" "list.dsbl.org.:1,blackholes.mail-abuse.org.:1,dialups.mail-abuse.org.:0"
#"SMTP-RDNSCheck" "1"
#"CheckMailerDomain" "1"
#"SmartDNSHost" "dns.home.bogus.net:tcp,192.168.1.1:udp"
#"DynDnsSetup" "www.dns4ever.com,80,/sys/u.cgi?d=MYDOMAIN&u=MYUSERNAME&p=MYPASSWORD&i=%s"
#"DynDnsSetup" "members.dyndns.org,80,/nic/dyndns?action=edit&started=1&hostname=YES&host_id=yourhost.
ourdomain.ext&myip=%s&wildcard=OFF&mx=mail.exchanger.ext&backmx=NO,foouser,foopasswd"
#"SmtpConfig" "mail-auth"
#"SmtpConfig-192.168.0.1" "mail-auth"
"DefaultSmtpPerms" "MRVZ

Something very important is that after edit the file "server.tab", has to  add the domain "first.domain.com" using the same procedure that use  for add any domain :

CtrlClnt -s localhost -u xmail_admin -p 123456789 domainadd first.domain.com

To know more about how add domains consult the subject "add a domain", for more details on this subject consult the file Readme.html.


Add a domain
For example to add a domain that have the name "additional.domain.com" has to  follow the following procedure :

1)Start the XMail server if this stopped
2)From a terminal with privileges of administrator, use the tool CtrlClnt,  an account of administrator, and the address where the server is installed for add the new domain of the following way :

CtrlClnt -s localhost -u xmail_admin -p 123456789 domainadd additional.domain.com

The tool CtrlClnt can be found in "{sysfile}\MailRoot\bin" in systems Windows or "/var/MailRoot/bin" in systems Unix , for more details on this subject consult the file Readme.html.


List the existent domains
To obtain the list of the existent domains in the server, have to realize the following steps :

1)Start the XMail server if this stopped
2)From a terminal with privileges of administrator, use the tool CtrlClnt,  an account of administrator, and the address where the server is installed to obtain the list of existent domains of the following way :

CtrlClnt -s localhost -u xmail_admin -p 123456789 domainlist

"xmailserver.test"
"additional.domain.com"
"first.domain.com" 

For more details on this subject consult the file Readme.html.


Delete a domain
To delete any domain has to  follow the following procedure :

1)Start the XMail server if this stopped
2)From a terminal with privileges of administrator, use the tool CtrlClnt,  an account of administrator, and the address where the server is installed to delete a domain of the following way :

CtrlClnt -s localhost -u xmail_admin -p 123456789 domaindel xmailserver.test

In this example the domain "xmailserver.test" is erased, how this domain is only an example there is not problem. It has to have a lot of care when erasing domains, before erasing any domain has to  consult with the ones of more administrators of the XMail server. 

For more details on this subject consult the file Readme.html.


Create a new user
To create an user have to  follow the following steps :

1)Start the XMail server if this stopped
2)From a terminal with privileges of administrator, use the tool CtrlClnt,  an account of administrator,  the address where the server is installed and  the domain where created the user of the following way :

CtrlClnt -s localhost -u xmail_admin -p 123456789 useradd first.domain.com paco 01020304 U

In this case are add a new account (the parameter "U" indicates that it is an account of user) to the domain "first.domain.com", the name of the account is "paco" and the password is 01020304 in this case the password is entered without encrypted and "CtrlClnt" encrypt this automatically the account created would remain of the following form : 

Name of the account  : paco@first.domain.com 
Name of user         : paco 
Password             : 01020304

Something very important is that the name of user has to  write with all and the symbol @  more the name of the domain, if it is that the user that are creating does not form part of the main domain. For example if we created to the user "paco" in another domain that is not the main domain as for example in "additional.domain.com"  then the data of the account would remain of the following way :

Name of the account  : paco@additional.domain.com 
Name of user         : paco@additional.domain.com 
Password             : 01020304

Is very important to remember this detail when we configured a client of mail like Microsoft Outlook or Evolution. For more details on this subject consult the file Readme.html.


Delete an user
To delete an user has to  follow the following procedure :

1)Start the XMail server if this stopped
2)From a terminal with privileges of administrator, use the tool CtrlClnt,  an account of administrator,  the address where the server is installed and  the domain in which delete an user of the following way :

CtrlClnt -s localhost -u xmail_admin -p 123456789 userdel first.domain.com paco

In this example the account "paco@first.domain.com" is erased ,  has to  have a lot of care when deleting users, before deleting to any user has to  consult with the ones of more administrators of the XMail server. 

For more details on this subject consult the file Readme.html.


List the users of a domain
To obtain the list of users of a domain have to realize the following steps :

1)Start the XMail server if this stopped
2)From a terminal with privileges of administrator, use the tool CtrlClnt,  an account of administrator, and the address where the server is installed to obtain the list of users of a domain  of the following way :

CtrlClnt -s localhost -u xmail_admin -p 123456789 userlist first.domain.com

"first.domain.com"      "paco"  "01020304"      "U"

The result is the list of users of the domain selected. For more details on this subject consult the file Readme.html.


Change the password of an user
To change the password of an user have to realize the following procedure :

1)Start the XMail server if this stopped
2)From a terminal with privileges of administrator, use the tool CtrlClnt,  an account of administrator,  the address where the server is installed, the user name, domain and the new password to realize the change of the following form  :

CtrlClnt -s localhost -u xmail_admin -p 123456789 userpasswd first.domain.com paco 11121314

In this case assigned him to the account "paco@first.domain.com" the new password 11121314. It is very important that when changing the password, inform him to the user affected immediately or of the contrary can not access to his messages. 

For more details on this subject consult the file Readme.html.


Obtain the statistical of an user
The statistical of the user is a group of information that serves of reference about the activities realized by the user. To obtain the statistical of an user have to  follow the following steps :

1)Start the XMail server if this stopped
2)From a terminal with privileges of administrator, use the tool CtrlClnt,  an account of administrator,  the address where the server is installed, the user name and domain to obtain the statistical of the following form  :

CtrlClnt -s localhost -u xmail_admin -p 123456789 userstat first.domain.com paco

"RealAddress"   "paco@first.domain.com"
"MailboxSize"   "0"
"MailboxMessages"       "0"
"LastLoginTimeDate"     "Fri, 15 Oct 2010 11:10:32 -0600"
"LastLoginIP"   "0.0.0.0"

Between the information returned finds  the name of the account, the size and the last direction from where the user connect  with the account, this information generally is useful for the administrators. 

For more details on this subject consult the file Readme.html.