use AcyMailing\Classes\ListClass;
​
$listClass = new ListClass;
$allLists = $listClass->getAll();
 
// You can then do a foreach on this variable (which contains an array of objects) and use ->name
// You can get a specific list like this
 
$myList = $listClass->getOneById(34);
 
// Or multiple lists like this
 
$myLists = $listClass->getListsByIds([22, 48]);

use AcyMailing\Classes\UserClass;
​
$myUser = new stdClass();
$myUser->email = 'emailaddressoftheuser';
$myUser->name = 'myname'; // this information is optional
 
// If you require a confirmation but don't want the user to have to confirm his subscription, you can set the confirmed field to 1:
// $myUser->confirmed = 1;
 
// You can add as many extra fields as you want if you already created them in AcyMailing
$customFields = [];
$customFields[custom_field_id] = 'france'; // the custom field id can be found in the Custom fields list of the AcyMailing admin page
//...
 
$userClass = new UserClass();
$userClass->sendConf = true; // Or false if you don't want a confirmation email to be sent
$userId = $userClass->save($myUser, $customFields); // this function will return you the ID of the user inserted in the AcyMailing table

use AcyMailing\Classes\UserClass;
​
$userClass = new UserClass();
 
// Get the AcyMailing user from his email address
$user = $userClass->getOneByEmail($email);
 
// Or you can get the AcyMailing user from his site user ID
$user = $userClass->getOneByCMSId($userID);
 
// Get subscription
$userSubscriptions = $userClass->getUserSubscriptionById($user->id);
 
// If you need a simpler result, you can use this method
$userSubscriptions = $userClass->getSubscriptionStatus($user->id);

use AcyMailing\Classes\UserClass;
​
$subscribe = [2,4,6]; // Id of the lists you want the user to be subscribed to (can be empty)
$unsubscribe = [1,3]; // Id of the lists you want the user to be unsubscribe from (can be empty)
$acyUserId = '23'; // you can use the previous example code to get the user by its site user id or its email address
 
$userClass = new UserClass();
 
$newSubscription = [];
if(!empty($subscribe)){
    $userClass->subscribe($acyUserId, $subscribe);
}
 
if(!empty($remove)){
 $userClass->unsubscribe($acyUserId, $unsubscribe);
}

use AcyMailing\Classes\MailClass;
use AcyMailing\Classes\CampaignClass;
​
// Lists you want to attach the campaign to
$listIds = [3,5,8];
 
// We create the Campaign element that we will save in the database.
// You can use all fields from the database the same way we do it with subject and body.
 
$mail = new stdClass();
$mail->subject = 'your subject'; // Subject of your email
$mail->name = 'your campaign name'; // Name of the campaign
$mail->body = 'Hi folks, we have a big announcement...'; // Body of your email
$mail->bcc = 'example@test.com' // BCC for your campaign
 
$mailClass = new MailClass();
$mailId = $mailClass->save($mail);
 
$campaign = new stdClass();
$campaign->draft = 1; // Create as a draft
$campaign->mail_id = $mailId;
 
$campaignClass = new CampaignClass();
$campaignId = $campaignClass->save($campaign);
$campaignClass->manageListsToCampaign($listIds, $mailId);

use AcyMailing\Classes\QueueClass;
​
// The purpose of this code is to let AcyMailing send an e-mail to a specific user at a specific time.
// You just have to add an entry in the queue and AcyMailing will take care of the rest.
 
$acyUserId = '23';
$mailId = '45'; // ID of the email you want to add in the queue
$senddate = time(); //When do you want the e-mail to be sent to this user? you should specify a timestamp here (time() is the current time)
 
$queueClass = new QueueClass();
$queueClass->addQueue($acyUserId, $mailId, $senddate);
 
// If you want to send a campaign to all the users in its attached lists, you can use this:
$queueClass->queue($mailId, $senddate);

use AcyMailing\Helpers\MailerHelper;
​
$mailer = new MailerHelper();
$mailer->report = true; // set it to true or false if you want Acy to display a confirmation message or not (message successfully sent to...)
$mailer->trackEmail = true; // set it to true or false if you want Acy to track the message or not (it will be inserted in the statistics table)
$mailer->autoAddUser = false; // set it to true if you want Acy to automatically create the user if it does not exist in AcyMailing
$mailer->addParam('var1', 'Value of the variable 1'); // Acy will automatically replace the tag {var1} by the value specified in the second parameter... you can use this function several times to replace tags in your email
$mailer->sendOne(67, 'user@example.com'); // The first parameter is the ID of the email you want to send

use AcyMailing\Classes\ListClass;
​
$newlist = new stdClass();
$newlist->name = 'Your list name';
$newlist->active = 1;
$newList->welcome_id = 43; // Optional. This is the Id of the mail you want to send as welcome email
$newList->unsubscribe_id = 52; // Optional. This is the Id of the mail you want to send when a user unsubscribes
$newList->color = '#3366ff'; // Optional. This is the color of the list
 
$listClass = new ListClass();
$listId = $listClass->save($newlist); // This function will create the list and return the ID of the created list

use AcyMailing\Classes\ListClass;
​
// This code will detach the list from your campaigns, delete the user subscriptions to that list then delete the list
 
$listClass = new ListClass();
$listClass->delete(43); // You should replace 43 by the ID of the list you want to delete