Guide To Quarantine

From Catglobe Wiki
Jump to: navigation, search


Quarantine Module

Quarantine is used for controlling email or sms sending. System will check if recipients, under a bulkmail or bulk SMS, are in quarantine before sending the bulkmail/ bulk SMS. If some of the recipients are in quarantine then these recipients won't receive email or SMS.

I. USE GUI

1. Create a new quarantine

Quarantine1.png

The place where you create, search, edit and delete a quarantine. Once we create or open a quarantine. A window will be shown the relevant fields.

Quarantine2.png

Name: Name of the Quarantine resource
Duration days: Number of days the quarantine is enforced in days
Duration hh:mm: Number of hours and minutes the quarantine is enforced in hours and minutes
Path: the path is where the quarantine will be saved

A Quarantine class can be used to create, edit and get values to/of a quarantine: for infomation click here;

2. Add quarantines for bulkmail/SMS resource template

At Quarantine tab, you can add or delete quarantines.

Quarantine3.png

Qurantine: select a quarantine you would like to add
Check if in quarantine before sending: if this option is checked, the recipients of the bulkmail/SMS will be checked towards quarantines before sending. 
If some of the recipients are in quarantine, they won't get an email or SMS.
Add to Quarantine after sending: if this option is checked, the recipients of the bulkmail/SMS are added to that quarantine.

You can select one or both properties. We can add to more than one quarantine on a bulkmail/SMS resource template

3. Create a bulkmail/SMS from bulkmail/SMS resource template, which was added to one or more quarantines

Quarantine4.png

User will not receive email or SMS if the user is in any quarantine in the quarantines list.

4. Check and remove quarantines for a user

Quarantine5.png

II. Use CGScript

1. Specified users are added to that quarantine.

for infomation click here;

2. Specified users are successfully removed from that quarantine.

for infomation click here;

3. Check user is in any quarantine in the quarantines list.

for infomation click here;

4. Get all quarantines were in specified user's quarantine history.

for infomation click here;

5. Get User Ids of the users have any quarantine in the quarantines list.

for infomation click here;

6. Get information of a quarantine prohibiting bulkmails and bulksms from being sent to user.

for infomation click here;