/**
* Try to match the string to a bounce type.
*
- * @param string $message The message to be matched
+ * @param string $message
+ * The message to be matched.
*
* @return array Tuple (bounce_type, bounce_reason)
* @static
/**
* Fetch object based on array of properties
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $defaults (reference ) an assoc array to hold the flattened values
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $defaults
+ * (reference ) an assoc array to hold the flattened values.
*
* @return CRM_Core_BAO_LocaationType object
* @static
/**
* Update the is_active flag in the db
*
- * @param int $id id of the database record
- * @param boolean $is_active value we want to set the is_active field
+ * @param int $id
+ * Id of the database record.
+ * @param bool $is_active
+ * Value we want to set the is_active field.
*
* @return Object DAO object on sucess, null otherwise
* @static
/**
* Create and Update mailing component
*
- * @param array $params (reference ) an assoc array of name/value pairs
- * @param array $ids (deprecated) the array that holds all the db ids
+ * @param array $params
+ * (reference ) an assoc array of name/value pairs.
+ * @param array $ids
+ * (deprecated) the array that holds all the db ids.
*
* @return CRM_Mailing_BAO_Component object
*
// note that $job_id is used only as a variable in the temp table construction
// and does not play a role in the queries generated
/**
- * @param int $job_id (misnomer) a nonce value used to name temporary tables
+ * @param int $job_id
+ * (misnomer) a nonce value used to name temporary tables.
* @param int $mailing_id
* @param null $offset
* @param null $limit
* structures to represent the order in which tokens were found from left to right, top to bottom.
*
*
- * @param str $prop name of the property that holds the text that we want to scan for tokens (html, text)
+ * @param str $prop
+ * Name of the property that holds the text that we want to scan for tokens (html, text).
*
* @return void
*/
/**
* Generate an event queue for a test job
*
- * @param array $testParams contains form values
+ * @param array $testParams
+ * Contains form values.
*
* @return void
*/
* is placed on the values received, so they do not need to follow the verp
* convention.
*
- * @param array $headers Array of message headers to update, in-out
- * @param string $prefix Prefix for the message ID, use same prefixes as verp
+ * @param array $headers
+ * Array of message headers to update, in-out.
+ * @param string $prefix
+ * Prefix for the message ID, use same prefixes as verp.
* wherever possible
- * @param string $job_id Job ID component of the generated message ID
- * @param string $event_queue_id Event Queue ID component of the generated message ID
- * @param string $hash Hash component of the generated message ID.
+ * @param string $job_id
+ * Job ID component of the generated message ID.
+ * @param string $event_queue_id
+ * Event Queue ID component of the generated message ID.
+ * @param string $hash
+ * Hash component of the generated message ID.
*
* @return void
*/
/**
* Static wrapper for getting verp and urls
*
- * @param int $job_id ID of the Job associated with this message
- * @param int $event_queue_id ID of the EventQueue
- * @param string $hash Hash of the EventQueue
- * @param string $email Destination address
+ * @param int $job_id
+ * ID of the Job associated with this message.
+ * @param int $event_queue_id
+ * ID of the EventQueue.
+ * @param string $hash
+ * Hash of the EventQueue.
+ * @param string $email
+ * Destination address.
*
* @return array (reference) array array ref that hold array refs to the verp info and urls
*/
/**
* Get verp, urls and headers
*
- * @param int $job_id ID of the Job associated with this message
- * @param int $event_queue_id ID of the EventQueue
- * @param string $hash Hash of the EventQueue
- * @param string $email Destination address
+ * @param int $job_id
+ * ID of the Job associated with this message.
+ * @param int $event_queue_id
+ * ID of the EventQueue.
+ * @param string $hash
+ * Hash of the EventQueue.
+ * @param string $email
+ * Destination address.
*
* @param bool $isForward
*
/**
* Compose a message
*
- * @param int $job_id ID of the Job associated with this message
- * @param int $event_queue_id ID of the EventQueue
- * @param string $hash Hash of the EventQueue
- * @param string $contactId ID of the Contact
- * @param string $email Destination address
- * @param string $recipient To: of the recipient
- * @param boolean $test Is this mailing a test?
+ * @param int $job_id
+ * ID of the Job associated with this message.
+ * @param int $event_queue_id
+ * ID of the EventQueue.
+ * @param string $hash
+ * Hash of the EventQueue.
+ * @param string $contactId
+ * ID of the Contact.
+ * @param string $email
+ * Destination address.
+ * @param string $recipient
+ * To: of the recipient.
+ * @param bool $test
+ * Is this mailing a test?.
* @param $contactDetails
* @param $attachments
- * @param boolean $isForward Is this mailing compose for forward?
- * @param string $fromEmail email address of who is forwardinf it.
+ * @param bool $isForward
+ * Is this mailing compose for forward?.
+ * @param string $fromEmail
+ * Email address of who is forwardinf it.
*
* @param null $replyToEmail
*
/**
* Add the mailings
*
- * @param array $params reference array contains the values submitted by the form
- * @param array $ids reference array contains the id
+ * @param array $params
+ * Reference array contains the values submitted by the form.
+ * @param array $ids
+ * Reference array contains the id.
*
* @static
*
* Construct a new mailing object, along with job and mailing_group
* objects, from the form values of the create mailing wizard.
*
- * @params array $params Form values
+ * @params array $params
+ * Form values.
*
* @param array $params
* @param array $ids
* Replace the list of recipients on a given mailing
*
* @param int $mailingId
- * @param string $type 'include' or 'exclude'
- * @param string $entity 'groups' or 'mailings'
+ * @param string $type
+ * 'include' or 'exclude'.
+ * @param string $entity
+ * 'groups' or 'mailings'.
* @param array<int> $entityIds
* @throws CiviCRM_API3_Exception
*/
* Generate a report. Fetch event count information, mailing data, and job
* status.
*
- * @param int $id The mailing id to report
- * @param boolean $skipDetails whether return all detailed report
+ * @param int $id
+ * The mailing id to report.
+ * @param bool $skipDetails
+ * Whether return all detailed report.
*
* @param bool $isSMS
*
/**
* Get the rows for a browse operation
*
- * @param int $offset The row number to start from
- * @param int $rowCount The nmber of rows to return
- * @param string $sort The sql string that describes the sort order
+ * @param int $offset
+ * The row number to start from.
+ * @param int $rowCount
+ * The nmber of rows to return.
+ * @param string $sort
+ * The sql string that describes the sort order.
*
* @param null $additionalClause
* @param array $additionalParams
/**
* Delete Mails and all its associated records
*
- * @param int $id id of the mail to delete
+ * @param int $id
+ * Id of the mail to delete.
*
* @return void
* @static
* Delete Jobss and all its associated records
* related to test Mailings
*
- * @param int $id id of the Job to delete
+ * @param int $id
+ * Id of the Job to delete.
*
* @return void
* @static
/**
* Get the content/components of mailing based on mailing Id
*
- * @param $report array of mailing report
+ * @param $report
+ * Array of mailing report.
*
- * @param $form reference of this
+ * @param $form
+ * Reference of this.
*
* @param bool $isSMS
*
/**
* This function is a wrapper for ajax activity selector
*
- * @param array $params associated array for params record id.
+ * @param array $params
+ * Associated array for params record id.
*
* @return array $contactActivities associated array of contact activities
*/
/**
* Retrieve contact mailing
*
- * @param array $params associated array
+ * @param array $params
+ * Associated array.
*
* @return array of mailings for a contact
*
/**
* Retrieve contact mailing count
*
- * @param array $params associated array
+ * @param array $params
+ * Associated array.
*
* @return int count of mailings for a contact
*
/**
* Construct a new mailingab object
*
- * @params array $params Form values
+ * @params array $params
+ * Form values.
*
* @param $params
* @param array $ids
/**
* function to add the mailings
*
- * @param array $params reference array contains the values submitted by the form
- * @param array $ids reference array contains the id
+ * @param array $params
+ * Reference array contains the values submitted by the form.
+ * @param array $ids
+ * Reference array contains the id.
*
* @static
*
/**
* Delete MailingAB and all its associated records
*
- * @param int $id id of the mail to delete
+ * @param int $id
+ * Id of the mail to delete.
*
* @return void
* @static
/**
* Send the mailing
*
- * @param object $mailer A Mail object to send the messages
+ * @param object $mailer
+ * A Mail object to send the messages.
*
* @param array $testParams
*
/**
* Cancel a mailing
*
- * @param int $mailingId the id of the mailing to be canceled
+ * @param int $mailingId
+ * The id of the mailing to be canceled.
* @static
*/
public static function cancel($mailingId) {
/**
* Return a translated status enum string
*
- * @param string $status The status enum
+ * @param string $status
+ * The status enum.
*
* @return string The translated version
* @static
* Redistribute recipients from $sourceMailingId to a series of other mailings.
*
* @param int $sourceMailingId
- * @param array $to (int $targetMailingId => int $count)
+ * @param array $to
+ * (int $targetMailingId => int $count).
*/
public static function reassign($sourceMailingId, $to) {
foreach ($to as $targetMailingId => $count) {
* Store Mails into Spool table.
*
* @param $recipient
- * @param array $headers The string of headers to send with the mail.
+ * @param array $headers
+ * The string of headers to send with the mail.
*
- * @param string $body The full text of the message body, including any
+ * @param string $body
+ * The full text of the message body, including any.
* Mime parts, etc.
*
* @param int $job_id
* Given a url, mailing id and queue event id, find or construct a
* trackable url and redirect url.
*
- * @param string $url The target url to track
- * @param int $mailing_id The id of the mailing
- * @param int $queue_id The queue event id (contact clicking through)
+ * @param string $url
+ * The target url to track.
+ * @param int $mailing_id
+ * The id of the mailing.
+ * @param int $queue_id
+ * The queue event id (contact clicking through).
*
* @return string $redirect The redirect/tracking url
* @static
/**
* Get row count for the event selector
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id Optional ID of a job to filter on
- * @param boolean $is_distinct Group by queue ID?
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of a job to filter on.
+ * @param bool $is_distinct
+ * Group by queue ID?.
*
* @return int Number of rows in result set
* @static
/**
* Get rows for the event browser
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id optional ID of the job
- * @param boolean $is_distinct Group by queue id?
- * @param int $offset Offset
- * @param int $rowCount Number of rows
- * @param array $sort sort array
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of the job.
+ * @param bool $is_distinct
+ * Group by queue id?.
+ * @param int $offset
+ * Offset.
+ * @param int $rowCount
+ * Number of rows.
+ * @param array $sort
+ * Sort array.
*
* @return array Result set
* @static
/**
* Confirm a pending subscription
*
- * @param int $contact_id The id of the contact
- * @param int $subscribe_id The id of the subscription event
- * @param string $hash The hash
+ * @param int $contact_id
+ * The id of the contact.
+ * @param int $subscribe_id
+ * The id of the subscription event.
+ * @param string $hash
+ * The hash.
*
* @return boolean True on success
* @static
/**
* Create a new delivery event
*
- * @param array $params Associative array of delivery event values
+ * @param array $params
+ * Associative array of delivery event values.
*
* @return void
* @static
/**
* Get row count for the event selector
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id Optional ID of a job to filter on
- * @param boolean $is_distinct Group by queue ID?
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of a job to filter on.
+ * @param bool $is_distinct
+ * Group by queue ID?.
*
* @return int Number of rows in result set
* @static
/**
* Get rows for the event browser
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id optional ID of the job
- * @param boolean $is_distinct Group by queue id?
- * @param int $offset Offset
- * @param int $rowCount Number of rows
- * @param array $sort sort array
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of the job.
+ * @param bool $is_distinct
+ * Group by queue id?.
+ * @param int $offset
+ * Offset.
+ * @param int $rowCount
+ * Number of rows.
+ * @param array $sort
+ * Sort array.
*
* @return array Result set
* @static
* This function rectifies that by considering all non-test mailing jobs which have completed between $minDays and $maxDays
* and setting the resetDate to the date that an email was delivered
*
- * @param integer $minDays consider mailings that were completed at least $minDays ago
- * @param integer $maxDays consider mailings that were completed not more than $maxDays ago
+ * @param int $minDays
+ * Consider mailings that were completed at least $minDays ago.
+ * @param int $maxDays
+ * Consider mailings that were completed not more than $maxDays ago.
*
* @return void
* @static
/**
* Get row count for the event selector
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id Optional ID of a job to filter on
- * @param boolean $is_distinct Group by queue ID?
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of a job to filter on.
+ * @param bool $is_distinct
+ * Group by queue ID?.
*
* @return int Number of rows in result set
* @static
/**
* Get rows for the event browser
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id optional ID of the job
- * @param boolean $is_distinct Group by queue id?
- * @param int $offset Offset
- * @param int $rowCount Number of rows
- * @param array $sort sort array
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of the job.
+ * @param bool $is_distinct
+ * Group by queue id?.
+ * @param int $offset
+ * Offset.
+ * @param int $rowCount
+ * Number of rows.
+ * @param array $sort
+ * Sort array.
*
* @return array Result set
* @static
/**
* Register an open event
*
- * @param int $queue_id The Queue Event ID of the recipient
+ * @param int $queue_id
+ * The Queue Event ID of the recipient.
*
* @return void
* @static
/**
* Get row count for the event selector
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id Optional ID of a job to filter on
- * @param boolean $is_distinct Group by queue ID?
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of a job to filter on.
+ * @param bool $is_distinct
+ * Group by queue ID?.
*
* @return int Number of rows in result set
* @static
/**
* Get opened count for each mailing for a given set of mailing IDs and a specific contact
*
- * @param int $mailingIDs IDs of the mailing (comma separated)
- * @param int $contactID ID of the contact
+ * @param int $mailingIDs
+ * IDs of the mailing (comma separated).
+ * @param int $contactID
+ * ID of the contact.
*
* @return array Count per mailing ID
* @static
/**
* Get rows for the event browser
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id optional ID of the job
- * @param boolean $is_distinct Group by queue id?
- * @param int $offset Offset
- * @param int $rowCount Number of rows
- * @param array $sort sort array
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of the job.
+ * @param bool $is_distinct
+ * Group by queue id?.
+ * @param int $offset
+ * Offset.
+ * @param int $rowCount
+ * Number of rows.
+ * @param array $sort
+ * Sort array.
*
* @param int $contact_id
*
/**
* Queue a new recipient
*
- * @param array $params values of the new EventQueue
+ * @param array $params
+ * Values of the new EventQueue.
*
* @return CRM_Mailing_Event_BAO_Queue The new EventQueue
* @static
/**
* Create a security hash from the job, email and contact ids
*
- * @param array The ids to be hashed
+ * @param array The ids to be hashed
*
* @return int The hash
* @static
/**
* Verify that a queue event exists with the specified id/job id/hash
*
- * @param int $job_id The job ID of the event to find
- * @param int $queue_id The Queue Event ID to find
- * @param string $hash The hash to validate against
+ * @param int $job_id
+ * The job ID of the event to find.
+ * @param int $queue_id
+ * The Queue Event ID to find.
+ * @param string $hash
+ * The hash to validate against.
*
* @return object|null The queue event if verified, or null
* @static
/**
* Given a queue event ID, find the corresponding email address.
*
- * @param int $queue_id The queue event ID
+ * @param int $queue_id
+ * The queue event ID.
*
* @return string The email address
* @static
/**
* Count up events given a mailing id and optional job id
*
- * @param int $mailing_id ID of the mailing to count
- * @param int $job_id Optional ID of a job to limit results
+ * @param int $mailing_id
+ * ID of the mailing to count.
+ * @param int $job_id
+ * Optional ID of a job to limit results.
*
* @return int Number of matching events
* @static
/**
* Get rows for the event browser
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id optional ID of the job
- * @param int $offset Offset
- * @param int $rowCount Number of rows
- * @param array $sort sort array
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of the job.
+ * @param int $offset
+ * Offset.
+ * @param int $rowCount
+ * Number of rows.
+ * @param array $sort
+ * Sort array.
*
* @return array Result set
* @static
/**
* Register a reply event.
*
- * @param int $job_id The job ID of the reply
- * @param int $queue_id The queue event id
- * @param string $hash The hash
+ * @param int $job_id
+ * The job ID of the reply.
+ * @param int $queue_id
+ * The queue event id.
+ * @param string $hash
+ * The hash.
*
* @param null $replyto
*
/**
* Forward a mailing reply
*
- * @param int $queue_id Queue event ID of the sender
- * @param string $mailing The mailing object
- * @param string $bodyTxt text part of the body (ignored if $fullEmail provided)
- * @param string $replyto Reply-to of the incoming message
- * @param string $bodyHTML HTML part of the body (ignored if $fullEmail provided)
- * @param string $fullEmail whole email to forward in one string
+ * @param int $queue_id
+ * Queue event ID of the sender.
+ * @param string $mailing
+ * The mailing object.
+ * @param string $bodyTxt
+ * Text part of the body (ignored if $fullEmail provided).
+ * @param string $replyto
+ * Reply-to of the incoming message.
+ * @param string $bodyHTML
+ * HTML part of the body (ignored if $fullEmail provided).
+ * @param string $fullEmail
+ * Whole email to forward in one string.
*
* @return void
* @static
/**
* Send an automated response
*
- * @param object $mailing The mailing object
- * @param int $queue_id The queue ID
- * @param string $replyto Optional reply-to from the reply
+ * @param object $mailing
+ * The mailing object.
+ * @param int $queue_id
+ * The queue ID.
+ * @param string $replyto
+ * Optional reply-to from the reply.
*
* @return void
* @static
/**
* Get row count for the event selector
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id Optional ID of a job to filter on
- * @param boolean $is_distinct Group by queue ID?
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of a job to filter on.
+ * @param bool $is_distinct
+ * Group by queue ID?.
*
* @return int Number of rows in result set
* @static
/**
* Get rows for the event browser
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id optional ID of the job
- * @param boolean $is_distinct Group by queue id?
- * @param int $offset Offset
- * @param int $rowCount Number of rows
- * @param array $sort sort array
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of the job.
+ * @param bool $is_distinct
+ * Group by queue id?.
+ * @param int $offset
+ * Offset.
+ * @param int $rowCount
+ * Number of rows.
+ * @param array $sort
+ * Sort array.
*
* @return array Result set
* @static
/**
* Resubscribe a contact to the groups, he/she was unsubscribed from.
*
- * @param int $job_id The job ID
- * @param int $queue_id The Queue Event ID of the recipient
- * @param string $hash The hash
+ * @param int $job_id
+ * The job ID.
+ * @param int $queue_id
+ * The Queue Event ID of the recipient.
+ * @param string $hash
+ * The hash.
*
* @return array|null $groups Array of all groups to which the contact was added, or null if the queue event could not be found.
* @static
* Send a reponse email informing the contact of the groups to which he/she
* has been resubscribed.
*
- * @param string $queue_id The queue event ID
- * @param array $groups List of group IDs
- * @param bool $is_domain Is this domain-level?
- * @param int $job The job ID
+ * @param string $queue_id
+ * The queue event ID.
+ * @param array $groups
+ * List of group IDs.
+ * @param bool $is_domain
+ * Is this domain-level?.
+ * @param int $job
+ * The job ID.
*
* @return void
* @static
* Register a subscription event. Create a new contact if one does not
* already exist.
*
- * @param int $group_id The group id to subscribe to
- * @param string $email The email address of the (new) contact
- * @param int $contactId Currently used during event registration/contribution.
+ * @param int $group_id
+ * The group id to subscribe to.
+ * @param string $email
+ * The email address of the (new) contact.
+ * @param int $contactId
+ * Currently used during event registration/contribution.
* Specifically to avoid linking group to wrong duplicate contact
* during event registration.
* @param string $context
/**
* Verify the hash of a subscription event
*
- * @param int $contact_id ID of the contact
- * @param int $subscribe_id ID of the subscription event
- * @param string $hash Hash to verify
+ * @param int $contact_id
+ * ID of the contact.
+ * @param int $subscribe_id
+ * ID of the subscription event.
+ * @param string $hash
+ * Hash to verify.
*
* @return object|null The subscribe event object, or null on failure
* @static
/**
* Ask a contact for subscription confirmation (opt-in)
*
- * @param string $email The email address
+ * @param string $email
+ * The email address.
*
* @return void
*/
/**
* Get the domain object given a subscribe event
*
- * @param int $subscribe_id ID of the subscribe event
+ * @param int $subscribe_id
+ * ID of the subscribe event.
*
* @return object $domain The domain owning the event
* @static
/**
* Get the group details to which given email belongs
*
- * @param string $email email of the contact
- * @param int $contactID contactID if we want an exact match
+ * @param string $email
+ * Email of the contact.
+ * @param int $contactID
+ * ContactID if we want an exact match.
*
* @return array $groups array of group ids
*/
/**
* Send subscribe mail
*
- * @param array $groups the list of group ids for subscribe
- * @param array $params the list of email
- * @param int $contactId Currently used during event registration/contribution.
+ * @param array $groups
+ * The list of group ids for subscribe.
+ * @param array $params
+ * The list of email.
+ * @param int $contactId
+ * Currently used during event registration/contribution.
* Specifically to avoid linking group to wrong duplicate contact
* during event registration.
* @param string $context
* Track a click-through and return the URL to redirect. If the numbers
* don't match up, return the base url.
*
- * @param int $queue_id The Queue Event ID of the clicker
- * @param int $url_id The ID of the trackable URL
+ * @param int $queue_id
+ * The Queue Event ID of the clicker.
+ * @param int $url_id
+ * The ID of the trackable URL.
*
* @return string $url The redirection url, or base url on failure.
* @static
/**
* Get row count for the event selector
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id Optional ID of a job to filter on
- * @param boolean $is_distinct Group by queue ID?
- * @param int $url_id Optional ID of a url to filter on
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of a job to filter on.
+ * @param bool $is_distinct
+ * Group by queue ID?.
+ * @param int $url_id
+ * Optional ID of a url to filter on.
*
* @return int Number of rows in result set
* @static
/**
* Get tracked url count for each mailing for a given set of mailing IDs
*
- * @param int $mailingIDs IDs of the mailing (comma separated)
- * @param int $contactID ID of the contact
+ * @param int $mailingIDs
+ * IDs of the mailing (comma separated).
+ * @param int $contactID
+ * ID of the contact.
*
* @return array Count per mailing ID
* @static
/**
* Get rows for the event browser
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id optional ID of the job
- * @param boolean $is_distinct Group by queue id?
- * @param int $url_id optional ID of a trackable URL to filter on
- * @param int $offset Offset
- * @param int $rowCount Number of rows
- * @param array $sort sort array
- * @param int $contact_id optional contact ID
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of the job.
+ * @param bool $is_distinct
+ * Group by queue id?.
+ * @param int $url_id
+ * Optional ID of a trackable URL to filter on.
+ * @param int $offset
+ * Offset.
+ * @param int $rowCount
+ * Number of rows.
+ * @param array $sort
+ * Sort array.
+ * @param int $contact_id
+ * Optional contact ID.
*
* @return array Result set
* @static
/**
* Unsubscribe a contact from the domain
*
- * @param int $job_id The job ID
- * @param int $queue_id The Queue Event ID of the recipient
- * @param string $hash The hash
+ * @param int $job_id
+ * The job ID.
+ * @param int $queue_id
+ * The Queue Event ID of the recipient.
+ * @param string $hash
+ * The hash.
*
* @return boolean Was the contact successfully unsubscribed?
* @static
/**
* Unsubscribe a contact from all groups that received this mailing
*
- * @param int $job_id The job ID
- * @param int $queue_id The Queue Event ID of the recipient
- * @param string $hash The hash
- * @param boolean $return If true return the list of groups.
+ * @param int $job_id
+ * The job ID.
+ * @param int $queue_id
+ * The Queue Event ID of the recipient.
+ * @param string $hash
+ * The hash.
+ * @param bool $return
+ * If true return the list of groups.
*
* @return array|null $groups Array of all groups from which the contact was removed, or null if the queue event could not be found.
* @static
* Send a reponse email informing the contact of the groups from which he
* has been unsubscribed.
*
- * @param string $queue_id The queue event ID
- * @param array $groups List of group IDs
- * @param bool $is_domain Is this domain-level?
- * @param int $job The job ID
+ * @param string $queue_id
+ * The queue event ID.
+ * @param array $groups
+ * List of group IDs.
+ * @param bool $is_domain
+ * Is this domain-level?.
+ * @param int $job
+ * The job ID.
*
* @return void
* @static
/**
* Get row count for the event selector
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id Optional ID of a job to filter on
- * @param boolean $is_distinct Group by queue ID?
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of a job to filter on.
+ * @param bool $is_distinct
+ * Group by queue ID?.
*
* @param null $org_unsubscribe
*
/**
* Get rows for the event browser
*
- * @param int $mailing_id ID of the mailing
- * @param int $job_id optional ID of the job
- * @param boolean $is_distinct Group by queue id?
- * @param int $offset Offset
- * @param int $rowCount Number of rows
- * @param array $sort sort array
+ * @param int $mailing_id
+ * ID of the mailing.
+ * @param int $job_id
+ * Optional ID of the job.
+ * @param bool $is_distinct
+ * Group by queue id?.
+ * @param int $offset
+ * Offset.
+ * @param int $rowCount
+ * Number of rows.
+ * @param array $sort
+ * Sort array.
*
* @param null $org_unsubscribe
* @return array Result set
/**
* Validation
*
- * @param array $params (ref.) an assoc array of name/value pairs
+ * @param array $params
+ * (ref.) an assoc array of name/value pairs.
*
* @param $files
* @param $options
/**
* Global validation rules for the form
*
- * @param array $fields posted values of the form
+ * @param array $fields
+ * Posted values of the form.
*
* @return array list of errors to be posted back to the form
* @static
* Warning: if you make changes here, be sure to also make them in
* Retry.php
*
- * @param array $params The form values
+ * @param array $params
+ * The form values.
*
* @param $files
* @param $self
* Simple shell that derived classes can call to add buttons to
* the form with a customized title for the main Submit
*
- * @param string $title title of the main button
+ * @param string $title
+ * Title of the main button.
* @param string $nextType
* @param string $backType
* @param bool $submitOnce
* Form rule to send out a test mailing.
*
* @param aray $testParams
- * @param array $files Any files posted to the form
- * @param array $self an current this object
+ * @param array $files
+ * Any files posted to the form.
+ * @param array $self
+ * An current this object.
*
* @return boolean true on successful SMTP handoff
*/
/**
* Validation
*
- * @param array $params (ref.) an assoc array of name/value pairs
+ * @param array $params
+ * (ref.) an assoc array of name/value pairs.
*
* @param $files
* @param $self
/**
* Return the proper mail store implementation, based on config settings
*
- * @param string $name name of the settings set from civimail_mail_settings to use (null for default)
+ * @param string $name
+ * Name of the settings set from civimail_mail_settings to use (null for default).
*
* @throws Exception
* @return object mail store implementation for processing CiviMail-bound emails
/**
* Return the next X messages from the mail store
*
- * @param int $count number of messages to fetch (0 to fetch all)
+ * @param int $count
+ * Number of messages to fetch (0 to fetch all).
*
* @return array array of ezcMail objects
*/
/**
* Point to (and create if needed) a local Maildir for storing retrieved mail
*
- * @param string $name name of the Maildir
+ * @param string $name
+ * Name of the Maildir.
*
* @throws Exception
* @return string path to the Maildir's cur directory
/**
* Connect to the supplied IMAP server and make sure the two mailboxes exist
*
- * @param string $host host to connect to
- * @param string $username authentication username
- * @param string $password authentication password
- * @param bool $ssl whether to use IMAP or IMAPS
- * @param string $folder name of the inbox folder
+ * @param string $host
+ * Host to connect to.
+ * @param string $username
+ * Authentication username.
+ * @param string $password
+ * Authentication password.
+ * @param bool $ssl
+ * Whether to use IMAP or IMAPS.
+ * @param string $folder
+ * Name of the inbox folder.
*
* @return \CRM_Mailing_MailStore_Imap
*/
/**
* Move the specified message to the ignored folder
*
- * @param integer $nr number of the message to move
+ * @param int $nr
+ * Number of the message to move.
*
* @return void
*/
/**
* Move the specified message to the processed folder
*
- * @param integer $nr number of the message to move
+ * @param int $nr
+ * Number of the message to move.
*
* @return void
*/
/**
* Connect to the supplied dir and make sure the two mail dirs exist
*
- * @param string $dir dir to operate upon
+ * @param string $dir
+ * Dir to operate upon.
*
* @return \CRM_Mailing_MailStore_Localdir
*/
* Return the next X messages from the mail store
* FIXME: in CiviCRM 2.2 this always returns all the emails
*
- * @param int $count number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all)
+ * @param int $count
+ * Number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all).
*
* @return array array of ezcMail objects
*/
/**
* Fetch the specified message to the local ignore folder
*
- * @param integer $file file location of the message to fetch
+ * @param int $file
+ * File location of the message to fetch.
*
* @throws Exception
* @return void
/**
* Fetch the specified message to the local processed folder
*
- * @param integer $file file location of the message to fetch
+ * @param int $file
+ * File location of the message to fetch.
*
* @throws Exception
* @return void
/**
* Connect to the supplied dir and make sure the two mail dirs exist
*
- * @param string $dir dir to operate upon
+ * @param string $dir
+ * Dir to operate upon.
*
* @return \CRM_Mailing_MailStore_Maildir
*/
* Return the next X messages from the mail store
* FIXME: in CiviCRM 2.2 this always returns all the emails
*
- * @param int $count number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all)
+ * @param int $count
+ * Number of messages to fetch FIXME: ignored in CiviCRM 2.2 (assumed to be 0, i.e., fetch all).
*
* @return array array of ezcMail objects
*/
/**
* Fetch the specified message to the local ignore folder
*
- * @param integer $file file location of the message to fetch
+ * @param int $file
+ * File location of the message to fetch.
*
* @throws Exception
* @return void
/**
* Fetch the specified message to the local processed folder
*
- * @param integer $file file location of the message to fetch
+ * @param int $file
+ * File location of the message to fetch.
*
* @throws Exception
* @return void
/**
* Connect to and lock the supplied file and make sure the two mail dirs exist
*
- * @param string $file mbox to operate upon
+ * @param string $file
+ * Mbox to operate upon.
*
* @return \CRM_Mailing_MailStore_Mbox
*/
/**
* Fetch the specified message to the local ignore folder
*
- * @param integer $nr number of the message to fetch
+ * @param int $nr
+ * Number of the message to fetch.
*
* @return void
*/
/**
* Fetch the specified message to the local processed folder
*
- * @param integer $nr number of the message to fetch
+ * @param int $nr
+ * Number of the message to fetch.
*
* @return void
*/
/**
* Connect to the supplied POP3 server and make sure the two mail dirs exist
*
- * @param string $host host to connect to
- * @param string $username authentication username
- * @param string $password authentication password
- * @param bool $ssl whether to use POP3 or POP3S
+ * @param string $host
+ * Host to connect to.
+ * @param string $username
+ * Authentication username.
+ * @param string $password
+ * Authentication password.
+ * @param bool $ssl
+ * Whether to use POP3 or POP3S.
*
* @return \CRM_Mailing_MailStore_Pop3
*/
/**
* Fetch the specified message to the local ignore folder
*
- * @param integer $nr number of the message to fetch
+ * @param int $nr
+ * Number of the message to fetch.
*
* @return void
*/
/**
* Fetch the specified message to the local processed folder
*
- * @param integer $nr number of the message to fetch
+ * @param int $nr
+ * Number of the message to fetch.
*
* @return void
*/
/**
* Get all the mailing components of a particular type
*
- * @param $type the type of component needed
+ * @param $type
+ * The type of component needed.
*
* @return array - array reference of all mailing components
* @static
/**
* Determine the default mailing component of a given type
*
- * @param $type the type of component needed
- * @param $undefined the value to use if no default is defined
+ * @param $type
+ * The type of component needed.
+ * @param $undefined
+ * The value to use if no default is defined.
*
* @return integer -The ID of the default mailing component.
* @static
* Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
- * @param string $action the action being performed
- * @param enum $output what should the result set include (web/email/csv)
+ * @param string $action
+ * The action being performed.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return array the column headers that need to be displayed
*/
/**
* Returns all the rows in the given offset and rowCount
*
- * @param enum $action the action being performed
- * @param int $offset the row number to start from
- * @param int $rowCount the number of rows to return
- * @param string $sort the sql string that describes the sort order
- * @param enum $output what should the result set include (web/email/csv)
+ * @param enum $action
+ * The action being performed.
+ * @param int $offset
+ * The row number to start from.
+ * @param int $rowCount
+ * The number of rows to return.
+ * @param string $sort
+ * The sql string that describes the sort order.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return int the total number of rows for this action
*/
/**
* Name of export file.
*
- * @param string $output type of output
+ * @param string $output
+ * Type of output.
*
* @return string name of the file
*/
/**
* Class constructor
*
- * @param string $event The event type (queue/delivered/open...)
- * @param boolean $distinct Count only distinct contact events?
- * @param int $mailing ID of the mailing to query
- * @param int $job ID of the job to query. If null, all jobs from $mailing are queried.
- * @param int $url If the event type is a click-through, do we want only those from a specific url?
+ * @param string $event
+ * The event type (queue/delivered/open...).
+ * @param bool $distinct
+ * Count only distinct contact events?.
+ * @param int $mailing
+ * ID of the mailing to query.
+ * @param int $job
+ * ID of the job to query. If null, all jobs from $mailing are queried.
+ * @param int $url
+ * If the event type is a click-through, do we want only those from a specific url?.
*
* @return \CRM_Mailing_Selector_Event
@access public
* Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
- * @param string $action the action being performed
- * @param enum $output what should the result set include (web/email/csv)
+ * @param string $action
+ * The action being performed.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return array the column headers that need to be displayed
*/
/**
* Returns all the rows in the given offset and rowCount
*
- * @param enum $action the action being performed
- * @param int $offset the row number to start from
- * @param int $rowCount the number of rows to return
- * @param string $sort the sql string that describes the sort order
- * @param enum $output what should the result set include (web/email/csv)
+ * @param enum $action
+ * The action being performed.
+ * @param int $offset
+ * The row number to start from.
+ * @param int $rowCount
+ * The number of rows to return.
+ * @param string $sort
+ * The sql string that describes the sort order.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return int the total number of rows for this action
*/
/**
* Name of export file.
*
- * @param string $output type of output
+ * @param string $output
+ * Type of output.
*
* @return string name of the file
*/
/**
* Class constructor
*
- * @param array $queryParams array of parameters for query
+ * @param array $queryParams
+ * Array of parameters for query.
* @param \const|int $action - action of search basic or advanced.
- * @param string $mailingClause if the caller wants to further restrict the search
- * @param boolean $single are we dealing only with one contact?
- * @param int $limit how many mailing do we want returned
+ * @param string $mailingClause
+ * If the caller wants to further restrict the search.
+ * @param bool $single
+ * Are we dealing only with one contact?.
+ * @param int $limit
+ * How many mailing do we want returned.
*
* @param string $context
* @param null $compContext
/**
* Returns all the rows in the given offset and rowCount
*
- * @param enum $action the action being performed
- * @param int $offset the row number to start from
- * @param int $rowCount the number of rows to return
- * @param string $sort the sql string that describes the sort order
- * @param enum $output what should the result set include (web/email/csv)
+ * @param enum $action
+ * The action being performed.
+ * @param int $offset
+ * The row number to start from.
+ * @param int $rowCount
+ * The number of rows to return.
+ * @param string $sort
+ * The sql string that describes the sort order.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return int the total number of rows for this action
*/
* Returns the column headers as an array of tuples:
* (name, sortName (key to the sort array))
*
- * @param string $action the action being performed
- * @param enum $output what should the result set include (web/email/csv)
+ * @param string $action
+ * The action being performed.
+ * @param enum $output
+ * What should the result set include (web/email/csv).
*
* @return array the column headers that need to be displayed
*/
/**
* Name of export file.
*
- * @param string $output type of output
+ * @param string $output
+ * Type of output.
*
* @return string name of the file
*/
projects / civicrm-core.git / commitdiff