lcidral/mail2easy-pro

Client library for interfacing with the Mail2EasyPRO API.

dev-master 2017-11-20 12:37 UTC

Requires

• php: ^5.6 || ^7.0
• guzzlehttp/guzzle: ~6.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.7
• phpunit/phpunit: 6.4

MIT

• Leonardo Cidral

• api
• mail2easy

README

Client library for interfacing with the Mail2EasyPRO API.

Note: This package is in development, use for your own risk. Needs improvements, refactory and rewrite Tests.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist lcidral/mail2easy-pro "dev-master"

or add

"lcidral/mail2easy-pro": "dev-master"

to the require section of your composer.json file.

Configuration

Export evironment variable with Mail2Easy User Credentials:

$ export MAIL2EASYPRO_CREDENTIALS='{"user":"[e-mail]","password":"y0urp455w0rd","client_code":"999999"}'

To persist this, you need to add this line in the .bash_profile file inside your home directory.

And run composer install.

Usage

Once the extension is installed, simply use it in your code by:

Get contact list Code

$contactList = Mail2EasyPRO::create(getenv("MAIL2EASYPRO_CREDENTIALS"), ContactList::class);
$contactListCode = $contactList->getContactListCode("TESTS - Lista de Contatos - Email");

Add new Contact in Contact List

$contact = Mail2EasyPRO::create(getenv("MAIL2EASYPRO_CREDENTIALS"), Contact::class);
$response = $contact->add($contactListCode, "[e-mail]", "Fulano XPTO", "Mail2EasyPRO-0000");

Update list of values, adding Tag

$contactListCode = 61;
$contactCode = 4;

$fieldLovCode = $this->contactListOfValues->getFieldLovCode($contactListCode, $contactCode, "Yout TAG Name in Contact List");
$response = $this->contact->update($contactListCode, $contactCode, null, null, [
    "cmp4" => [
        $fieldLovCode
    ]
]);