ArnMail Logo

ArnMail API

How to use ArnMail API to your website and connecting it using the ArnMail Client.

Note: This is a step by step guide to how to use ArnMail API to your website. But first make sure you have your own website. Remember it's recommended to use a separate blank website.

1. Download ArnMail API

Probably the most important step is downloading the API itself. Click the button below to download the API files.

Download ArnMail API

Note: You can modify the API to whatever you like

2. Extracting the files

You can extract the files using some tools like 7-zip or WinRAR.

After extracting and opening it you should see a folder named ArnMail.API and a file named arnmail.sql

Note: You also need to have access to mysql

3. Configuring

After extracting you need to open the file called config.php located in the ArnMail.API folder. You can use notepad or code editors to open the file.

You need to edit this specific things:

  • define('DB_SERVER', 'Put your mysql server here');
  • define('DB_USERNAME', 'Put your mysql username here');
  • define('DB_PASSWORD', 'Put your mysql password here');
  • define('DB_NAME', 'Put your mysql database name here');

    • Note: There is this variable called '$ALLOW_SENDMAIL_WITHOUT_API_KEY' in request.php file which is set to 'false' by default. It allows whether your website should need an API Key to send mail or not.

    4. Uploading to the web

    After configuring you need to upload the ArnMail.API folder to your website. You need to exactly put it to the website's main directory

    5. Setting up Mysql

    After uploading it go to your mysql admin panel and select your database. After that go to the sql tab above then drag the file called arnmail.sql and press the Go button down below.

    After successfully entered you should see databases called arnmail_api, arnmail_incoming_mails, and arnmail_users. Go to the arnmail_api.

    After going to arnmail_api go to insert tab in the top menu and fill this only forms username and api_key.

    You can fill whatever text you want in the username and api_key but make sure to put a longer text in the api_key for security purposes.

    6. Adding Server to ArnMail Client

    After everything is done it's time to test it whether it works or not using the ArnMail Client. But first let's add it to the ArnMail Client to be able to log-in.

    To add it, simply download the ArnMail Client and open it.

    By default you only have one server which named ArnMail. Obviously this website's ArnMail Server.

    Press Add Server below the ArnMail and fill in the forms.

    Server Name which obviously you should put the server's name but you can put whatever you want.

    Server URL which obviously the servers url. (e.g. arnmail.my.to)

    Note: ArnMail Servers should have an SSL Certificate it's important

    Server API Key The one that you created above.

    7. Login

    After doing everything its time to test whether it's working or not.

    Start by registering an account using the ArnMail Client.

    To register or create an account simply press the created server and click the Create Now below the login button and next to Don't have an account?

    Make sure to fill out all the forms and then try loggin in