Guide To Quarantine: Difference between revisions
More actions
No edit summary |
Suhailsname (talk | contribs) Β |
||
| (19 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Quarantine_Functions]] | |||
{{HelpFiles}} | {{HelpFiles}} | ||
=== Quarantine Module === | === Quarantine Module === | ||
Quarantine is used | 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 === | === I. USE GUI === | ||
| Line 9: | Line 11: | ||
=== 1. Create a new quarantine<br/> === | === 1. Create a new quarantine<br/> === | ||
[[File:Quarantine1.png]] Β | [[File: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 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. | ||
[[File:Quarantine2.png]] Β | [[File:Quarantine2.png]] | ||
Β Name: Name of the Quarantine resource | Β Name: Name of the Quarantine resource | ||
| Line 20: | Line 22: | ||
Β Path: the path is where the quarantine will be saved | Β 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: [http://wiki.catglobe.com/index.php/UserQuarantine_class for infomation click here;] | |||
=== 2. Add | === 2. Add quarantines for bulkmail/SMS resource template === | ||
At Quarantine tab, | At Quarantine tab, you can add or delete quarantines. | ||
[[File: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. | |||
=== 3. Create a bulkmail/SMS from bulkmail/SMS resource template was added to one or more quarantines === | 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<br/> === | |||
Β | |||
[[File:Quarantine4.png]] | |||
User will not receive email or SMS if the user is in any quarantine in the quarantines list. | 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<br/> === | |||
Β | [[File:Quarantine5.png]] | ||
=== II. Use CGScript === | === II. Use CGScript === | ||
=== 1. Specified users are added to that quarantine. === | === 1. Specified users are added to that quarantine. === | ||
[http://wiki.catglobe.com/index.php/Quarantine_addToQuarantine for infomation click here;] | |||
=== 2. Specified users are successfully removed from that quarantine. === | === 2. Specified users are successfully removed from that quarantine. === | ||
[http://wiki.catglobe.com/index.php/Quarantine_removeFromQuarantine for infomation click here;] | |||
=== 3. Check user is in any quarantine in the quarantines list. === | === 3. Check user is in any quarantine in the quarantines list. === | ||
[http://wiki.catglobe.com/index.php/Quarantine_checkIfQuarantined for infomation click here;] | |||
=== 4. Get all quarantines were in specified user's quarantine history. === | === 4. Get all quarantines were in specified user's quarantine history. === | ||
=== 5. Get User Ids of the users have any quarantine in the quarantines list. === | [http://wiki.catglobe.com/index.php/Quarantine_getUserHistory for infomation click here;] | ||
Β | |||
=== 5. Get User Ids of the users have any quarantine in the quarantines list.<br/> === | |||
Β | |||
[http://wiki.catglobe.com/index.php/Quarantine_getUserIdsOfQuarantined for infomation click here;] | |||
=== 6. Get information of a quarantine prohibiting bulkmails and bulksms from being sent to user. === | === 6. Get information of a quarantine prohibiting bulkmails and bulksms from being sent to user. === | ||
[http://wiki.catglobe.com/index.php/UserQuarantine_class for infomation click here;] | |||
__NOTOC__ | __NOTOC__ | ||
Latest revision as of 09:55, 11 October 2016
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
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.
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.
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




