*
* Generated from xml/schema/CRM/Mailing/Mailing.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
- * (GenCodeChecksum:0889788ebb2ad430999bb9eda9524621)
+ * (GenCodeChecksum:4144d565580335c15e750f73a73df644)
*/
/**
];
/**
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $id;
/**
* Which site is this mailing for
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $domain_id;
/**
* FK to the header component.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $header_id;
/**
* FK to the footer component.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $footer_id;
/**
* FK to the auto-responder component.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $reply_id;
/**
* FK to the unsubscribe component.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $unsubscribe_id;
/**
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $resubscribe_id;
/**
* FK to the opt-out component.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $optout_id;
/**
* Mailing Name.
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(128))
+ * Note that values will be retrieved from the database as a string.
*/
public $name;
/**
* differentiate between standalone mailings, A/B tests, and A/B final-winner
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(32))
+ * Note that values will be retrieved from the database as a string.
*/
public $mailing_type;
/**
* From Header of mailing
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(128))
+ * Note that values will be retrieved from the database as a string.
*/
public $from_name;
/**
* From Email of mailing
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(128))
+ * Note that values will be retrieved from the database as a string.
*/
public $from_email;
/**
* Reply-To Email of mailing
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(128))
+ * Note that values will be retrieved from the database as a string.
*/
public $replyto_email;
* The language/processing system used for email templates.
*
* @var string
+ * (SQL type: varchar(64))
+ * Note that values will be retrieved from the database as a string.
*/
public $template_type;
/**
* Advanced options used by the email templating system. (JSON encoded)
*
- * @var longtext
+ * @var string|null
+ * (SQL type: longtext)
+ * Note that values will be retrieved from the database as a string.
*/
public $template_options;
/**
* Subject of mailing
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(128))
+ * Note that values will be retrieved from the database as a string.
*/
public $subject;
/**
* Body of the mailing in text format.
*
- * @var longtext
+ * @var string|null
+ * (SQL type: longtext)
+ * Note that values will be retrieved from the database as a string.
*/
public $body_text;
/**
* Body of the mailing in html format.
*
- * @var longtext
+ * @var string|null
+ * (SQL type: longtext)
+ * Note that values will be retrieved from the database as a string.
*/
public $body_html;
/**
* Should we track URL click-throughs for this mailing?
*
- * @var bool
+ * @var bool|string
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $url_tracking;
/**
* Should we forward replies back to the author?
*
- * @var bool
+ * @var bool|string
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $forward_replies;
/**
* Should we enable the auto-responder?
*
- * @var bool
+ * @var bool|string
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $auto_responder;
/**
* Should we track when recipients open/read this mailing?
*
- * @var bool
+ * @var bool|string
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $open_tracking;
/**
* Has at least one job associated with this mailing finished?
*
- * @var bool
+ * @var bool|string
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_completed;
/**
* FK to the message template.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $msg_template_id;
/**
* Overwrite the VERP address in Reply-To
*
- * @var bool
+ * @var bool|string
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $override_verp;
/**
* FK to Contact ID who first created this mailing
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $created_id;
/**
* Date and time this mailing was created.
*
- * @var timestamp
+ * @var string
+ * (SQL type: timestamp)
+ * Note that values will be retrieved from the database as a string.
*/
public $created_date;
/**
* When the mailing (or closely related entity) was created or modified or deleted.
*
- * @var timestamp
+ * @var string
+ * (SQL type: timestamp)
+ * Note that values will be retrieved from the database as a string.
*/
public $modified_date;
/**
* FK to Contact ID who scheduled this mailing
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $scheduled_id;
/**
* Date and time this mailing was scheduled.
*
- * @var timestamp
+ * @var string
+ * (SQL type: timestamp)
+ * Note that values will be retrieved from the database as a string.
*/
public $scheduled_date;
/**
* FK to Contact ID who approved this mailing
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $approver_id;
/**
* Date and time this mailing was approved.
*
- * @var timestamp
+ * @var string
+ * (SQL type: timestamp)
+ * Note that values will be retrieved from the database as a string.
*/
public $approval_date;
/**
* The status of this mailing. Values: none, approved, rejected
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $approval_status_id;
/**
* Note behind the decision.
*
- * @var longtext
+ * @var string|null
+ * (SQL type: longtext)
+ * Note that values will be retrieved from the database as a string.
*/
public $approval_note;
/**
* Is this mailing archived?
*
- * @var bool
+ * @var bool|string
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $is_archived;
/**
* In what context(s) is the mailing contents visible (online viewing)
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(40))
+ * Note that values will be retrieved from the database as a string.
*/
public $visibility;
/**
* The campaign for which this mailing has been initiated.
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $campaign_id;
/**
* Remove duplicate emails?
*
- * @var bool
+ * @var bool|string
+ * (SQL type: tinyint)
+ * Note that values will be retrieved from the database as a string.
*/
public $dedupe_email;
/**
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $sms_provider_id;
/**
* Key for validating requests related to this mailing.
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(16))
+ * Note that values will be retrieved from the database as a string.
*/
public $hash;
/**
* With email_selection_method, determines which email address to use
*
- * @var int
+ * @var int|string|null
+ * (SQL type: int unsigned)
+ * Note that values will be retrieved from the database as a string.
*/
public $location_type_id;
/**
* With location_type_id, determine how to choose the email address to use.
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(20))
+ * Note that values will be retrieved from the database as a string.
*/
public $email_selection_method;
/**
* Language of the content of the mailing. Useful for tokens.
*
- * @var string
+ * @var string|null
+ * (SQL type: varchar(5))
+ * Note that values will be retrieved from the database as a string.
*/
public $language;
'pseudoconstant' => [
'callback' => 'CRM_Mailing_BAO_Mailing::getTemplateTypeNames',
],
- 'add' => NULL,
+ 'add' => '4.7.16',
],
'template_options' => [
'name' => 'template_options',
'entity' => 'Mailing',
'bao' => 'CRM_Mailing_BAO_Mailing',
'localizable' => 0,
- 'add' => NULL,
+ 'serialize' => self::SERIALIZE_JSON,
+ 'add' => '4.7.16',
],
'subject' => [
'name' => 'subject',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Url Tracking'),
'description' => ts('Should we track URL click-throughs for this mailing?'),
+ 'required' => TRUE,
'where' => 'civicrm_mailing.url_tracking',
+ 'default' => '0',
'table_name' => 'civicrm_mailing',
'entity' => 'Mailing',
'bao' => 'CRM_Mailing_BAO_Mailing',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Forward Replies'),
'description' => ts('Should we forward replies back to the author?'),
+ 'required' => TRUE,
'where' => 'civicrm_mailing.forward_replies',
+ 'default' => '0',
'table_name' => 'civicrm_mailing',
'entity' => 'Mailing',
'bao' => 'CRM_Mailing_BAO_Mailing',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Auto Responder'),
'description' => ts('Should we enable the auto-responder?'),
+ 'required' => TRUE,
'where' => 'civicrm_mailing.auto_responder',
+ 'default' => '0',
'table_name' => 'civicrm_mailing',
'entity' => 'Mailing',
'bao' => 'CRM_Mailing_BAO_Mailing',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Track Mailing?'),
'description' => ts('Should we track when recipients open/read this mailing?'),
+ 'required' => TRUE,
'where' => 'civicrm_mailing.open_tracking',
+ 'default' => '0',
'table_name' => 'civicrm_mailing',
'entity' => 'Mailing',
'bao' => 'CRM_Mailing_BAO_Mailing',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Mailing Completed'),
'description' => ts('Has at least one job associated with this mailing finished?'),
+ 'required' => TRUE,
'where' => 'civicrm_mailing.is_completed',
+ 'default' => '0',
'table_name' => 'civicrm_mailing',
'entity' => 'Mailing',
'bao' => 'CRM_Mailing_BAO_Mailing',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Override Verp'),
'description' => ts('Overwrite the VERP address in Reply-To'),
+ 'required' => TRUE,
'where' => 'civicrm_mailing.override_verp',
'default' => '0',
'table_name' => 'civicrm_mailing',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Is Mailing Archived?'),
'description' => ts('Is this mailing archived?'),
+ 'required' => TRUE,
'where' => 'civicrm_mailing.is_archived',
'default' => '0',
'table_name' => 'civicrm_mailing',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('No Duplicate emails?'),
'description' => ts('Remove duplicate emails?'),
+ 'required' => TRUE,
'where' => 'civicrm_mailing.dedupe_email',
'default' => '0',
'table_name' => 'civicrm_mailing',
projects / civicrm-core.git / blobdiff