From 7d65618feeb0cd151d917b62583e750a68b7c305 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Fri, 12 Jul 2019 11:31:08 -0700
Subject: [PATCH] src/FlexMailerTask.php - Docblock

---
 src/FlexMailerTask.php | 22 +++++++++++++++++++---
 1 file changed, 19 insertions(+), 3 deletions(-)

diff --git a/src/FlexMailerTask.php b/src/FlexMailerTask.php
index 6c21c9f..328df38 100644
--- a/src/FlexMailerTask.php
+++ b/src/FlexMailerTask.php
@@ -43,31 +43,37 @@ class FlexMailerTask {
 
   /**
    * @var int
+   *   A persistent record for this email delivery.
+   * @see \CRM_Mailing_Event_DAO_Queue
    */
   private $eventQueueId;
 
   /**
    * @var int
+   *   The ID of the recipiient.
+   * @see \CRM_Contact_DAO_Contact
    */
   private $contactId;
 
   /**
    * @var string
+   *   An authentication code. The name is misleading - it may be hash, but
+   *   that implementation detail is outside our purview.
    */
   private $hash;
 
   /**
    * @var string
-   *
-   * WAS: email
+   *   Selected/preferred email address of the intended recipient.
    */
   private $address;
 
   /**
-   * The individual email message to send (per alterMailParams).
+   * The full email message to send to this recipient (per alterMailParams).
    *
    * @var array
    * @see MailParams
+   * @see \CRM_Utils_Hook::alterMailParams()
    */
   private $mailParams = array();
 
@@ -75,9 +81,13 @@ class FlexMailerTask {
    * FlexMailerTask constructor.
    *
    * @param int $eventQueueId
+   *   A persistent record for this email delivery.
    * @param int $contactId
+   *   The ID of the recipiient.
    * @param string $hash
+   *   An authentication code.
    * @param string $address
+   *   Selected/preferred email address of the intended recipient.
    */
   public function __construct(
     $eventQueueId,
@@ -93,6 +103,7 @@ public function __construct(
 
   /**
    * @return int
+   * @see \CRM_Mailing_Event_DAO_Queue
    */
   public function getEventQueueId() {
     return $this->eventQueueId;
@@ -100,6 +111,8 @@ public function getEventQueueId() {
 
   /**
    * @return int
+   *   The ID of the recipiient.
+   * @see \CRM_Contact_DAO_Contact
    */
   public function getContactId() {
     return $this->contactId;
@@ -107,6 +120,8 @@ public function getContactId() {
 
   /**
    * @return string
+   *   An authentication code. The name is misleading - it may be hash, but
+   *   that implementation detail is outside our purview.
    */
   public function getHash() {
     return $this->hash;
@@ -114,6 +129,7 @@ public function getHash() {
 
   /**
    * @return string
+   *   Selected email address of the intended recipient.
    */
   public function getAddress() {
     return $this->address;