PHP code example of ocolin / open-srs-mail

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

ocolin / open-srs-mail example snippets

// Manually setting vars for demonstration purposes
$_ENV['OPENSRS_MAIL_HOST'] = 'https://admin.test.hostedemail.com/api';
$_ENV['OPENSRS_MAIL_USERNAME'] = '[email protected]';
$_ENV['OPENSRS_MAIL_PASSWORD'] = '12345abc!@#';
// OPTIONAL PARAMETERS
$_ENV['OPENSRS_MAIL_MODE'] = 'TOKEN';
$_ENV['OPENSRS_MAIL_TOKEN_EXPIRATION'] = '600';
$_ENV['OPENSRS_MAIL_CACHE_PATH'] = '/tmp/';

$opensrs = new Ocolin\OpenSrsMail\Client();

$opensrs = new Ocolin\OpenSrsMail\Client( 
    client: new Ocolin\OpenSrsMail\Config(
        host: 'https://admin.test.hostedemail.com/api',
        username: '[email protected]',
        password: '12345abc!@#',
        // OPTIONAL
        mode: 'TOKEN',
        token_expiration: 600,
        cache_path: '/tmp/'
    )
);

$opensrs = new Ocolin\OpenSrsMail\Client( 
    client: new Ocolin\OpenSrsMail\Config(
        options: [ 'timeout' => 60, 'verify'] => false 
    )
);

$response = $opensrs->request(
    method: 'get_company',
    params: [ 'company' => 'myCompanyName' ]
);

$output = $opensrs->changeUser(...);

$output = $opensrs->deleteUser(...);

$output = $opensrs->generateToken(...);

$output = $opensrs->getDeletedContacts(...);

$output = $opensrs->getDeletedMessages(...);

$output = $opensrs->getUser(...);

$output = $opensrs->getUserAttributeHistory(...);

$output = $opensrs->getUserChanges(...);

$output = $opensrs->getUserFolders(...);

$output = $opensrs->getUserMessages(...);

$output = $opensrs->logoutUser(...);

$output = $opensrs->moveUserMessages(...);

$output = $opensrs->reindex(...);

$output = $opensrs->renameUser(...);

$output = $opensrs->restoreDeletedContacts(...);

$output = $opensrs->restoreDeletedMessages(...);

$output = $opensrs->restoreUser(...);

$output = $opensrs->searchUsers(...);

$output = $opensrs->setRole(...);

$output = $opensrs->userNotify(...);

$output = $opensrs->userDisable2fa(...);

$output = $opensrs->appPassword(...);

$output = $opensrs->resetEmailTest(...);

$output = $opensrs->getSieve(...);

$output = $opensrs->setSieve(...);

$output = $opensrs->statsList(...);

$output = $opensrs->statsSnapshot(...);

$output = $opensrs->statsSummary(...);

$output = $opensrs->changeDomain(...);

$output = $opensrs->changeDomainBulletin(...);

$output = $opensrs->deleteDomain(...);

$output = $opensrs->getDomain(...);

$output = $opensrs->getDomainBulletin(...);

$output = $opensrs->postDomainBulletin(...);

$output = $opensrs->restoreDomain(...);

$output = $opensrs->searchDomains(...);

$output = $opensrs->pushDomain(...);

$output = $opensrs->changeCompany(...);

$output = $opensrs->changeCompanyBulletin(...);

$output = $opensrs->getCompany(...);

$output = $opensrs->getCompanyBulletin(...);

$output = $opensrs->getCompanyChanges(...);

$output = $opensrs->postCompanyBulletin(...);

$output = $opensrs->searchBrands(...);

$output = $opensrs->searchBrandMembers(...);

$output = $opensrs->createWorkgroup(...);

$output = $opensrs->deleteWorkgroup(...);

$output = $opensrs->searchWorkgroups(...);

$output = $opensrs->authenticate(...);

$output = $opensrs->echo(...);

$output = $opensrs->migrationAdd(...);

$output = $opensrs->migrationJobs(...);

$output = $opensrs->migrationStatus(...);

$output = $opensrs->migrationTrace(...);