Public Member Functions |
|
__construct ($queueObj, $parentObj) | |
clearFilters () | |
deleteFilteredEmails () | |
deleteQueueEMail ($mailID) | |
enterQuarantine () | |
forceQueueDelivery () | |
getFilterObj () | |
getQueueObj () | |
getSessionObj () | |
imposeAgeRestriction ($day=0, $hours=0, $min=0, $sec=0, $compareType="equal") | |
imposeNextScheduleRestriction ($date, $compareType) | |
imposeRecipientRestriction ($recipient, $compareType="equal") | |
imposeRetriesRestriction ($nrOfRetries, $compareType="equal") | |
imposeSenderRestriction ($sender, $compareType) | |
imposeSizeRestriction ($size, $compareType="equal", $sizeType="kb") | |
imposeStatusRestriction ($status) | |
listFilteredEMails ($action="no action") | |
listQueueEMails () | |
retryFilteredEmails () | |
retryQueueEMail ($mailID) | |
sendNDRFilteredEmails () | |
sendNDRQueueEMail ($mailID) |
Member Function Documentation
Queue::clearFilters | ( | ) |
clears the already set filters
- Returns:
- bool
Queue::deleteFilteredEmails | ( | ) |
applies a delete action to filtered emails
- Returns:
- bool
Queue::deleteQueueEMail | ( | $ | mailID | ) |
this method tells Axigen to delete the mailId
- Returns:
- bool
- Parameters:
-
$mailID int the mailId to delete
Queue::enterQuarantine | ( | ) |
this method returns an object with the qurantine
- Returns:
- object Quarantine
Queue::forceQueueDelivery | ( | ) |
this method forces the emails queue delivery
- Returns:
- bool
Queue::imposeAgeRestriction | ( | $ | day = 0 , |
|
$ | hours = 0 , |
|||
$ | min = 0 , |
|||
$ | sec = 0 , |
|||
$ | compareType =
"equal" |
|||
) |
sets the filter age restriction
- Returns:
- bool
- Parameters:
-
$day int number of days $hours int number of hours $min int number of minutes $sec int number of seconds $compareType string type of comparison (equal , less, more)
Queue::imposeNextScheduleRestriction | ( | $ | date, | |
$ | compareType | |||
) |
sets the filter next schedule restriction
- Returns:
- bool
- Parameters:
-
$date string next schedule date (ex: 2 Jan 2007 17:34) $compareType string type of comparison (equal , less, more)
Queue::imposeRecipientRestriction | ( | $ | recipient, | |
$ | compareType =
"equal" |
|||
) |
sets the filter recipient restriction
- Returns:
- bool
- Parameters:
-
$recipient string the Recipient to filter $compareType string type of comparison (equal , not equal)
Queue::imposeRetriesRestriction | ( | $ | nrOfRetries, | |
$ | compareType =
"equal" |
|||
) |
sets the filter retries restriction
- Returns:
- bool
- Parameters:
-
$nrOfRetries int number of retries $compareType string type of comparison (equal , less, more)
Queue::imposeSenderRestriction | ( | $ | sender, | |
$ | compareType | |||
) |
sets the filter sender restriction
- Returns:
- bool
- Parameters:
-
$sender string the Sender to filter $compareType string type of comparison (equal , not equal)
Queue::imposeSizeRestriction | ( | $ | size, | |
$ | compareType =
"equal" , |
|||
$ | sizeType = "kb" |
|||
) |
sets the filter size restriction
- Returns:
- bool
- Parameters:
-
$size int the message size $compareType string type of comparison (equal , less, more) $sizeType string type of size (B - bytes, KB - kilobytes, MB - megabytes)
Queue::imposeStatusRestriction | ( | $ | status | ) |
sets the filter status restriction
- Returns:
- bool
- Parameters:
-
$status string the email status ("SEND FAILURE", "PROCESSING ERROR", "RELAY ERROR", "LOCAL ERROR", "FILTER REJECT", "FILTER DISCARD")
Queue::listFilteredEMails | ( | $ | action =
"no action" |
) |
returns an array with emails filtered by already set filters
- Returns:
- array
Queue::listQueueEMails | ( | ) |
returns an array with all the emails from the queue
- Returns:
- array
Queue::retryFilteredEmails | ( | ) |
applies a retry action to filtered emails
- Returns:
- bool
Queue::retryQueueEMail | ( | $ | mailID | ) |
this method tells Axigen to retry sending the mailId
- Returns:
- bool
- Parameters:
-
$mailID int the mail it to retry
Queue::sendNDRFilteredEmails | ( | ) |
applies a NDR action to filtered emails
- Returns:
- bool
Queue::sendNDRQueueEMail | ( | $ | mailID | ) |
this method tells Axigen to send NDR to the mailId
- Returns:
- bool
- Parameters:
-
$mailID int the mail it to send NDR