MailParams
in package
Class MailParams
Within CiviMail, we have a few competing data-structures to chose from when representing a mail message:
- ezcMail
- Mail_mime
- $mailParams (from Hook::alterMailParams)
The $mailParams data-structure is probably the quirkiest, but it's also the one for which we have the strongest obligation (e.g. it's part of a published hook). This class includes helper functions for converting or validating the $mailParams format.
Tags
Table of Contents
Methods
- convertMailParamsToMime() : Mail_mime
- Convert from "mail params" to PEAR's Mail_mime.
Methods
convertMailParamsToMime()
Convert from "mail params" to PEAR's Mail_mime.
public
static convertMailParamsToMime(array<string|int, mixed> $mailParams) : Mail_mime
The data-structure which represents a message for purposes of hook_civicrm_alterMailParams does not match the data structure for Mail_mime.
Parameters
- $mailParams : array<string|int, mixed>