Function Mail_dispatcher_base->inject_unsubscribe_headers

Definitions

sources/mail.php

  • Inject List-Unsubscribe headers for an e-mail to a single address.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$email_address EMAIL No No required parameter N/A N/A The recipient e-mail address
$_headers string No No required parameter N/A N/A The provisional headers to use

Returns

  • Updated headers to use including List-Unsubscribe
  • Type: string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Inject List-Unsubscribe headers for an e-mail to a single address.
 *
 * @param  EMAIL $email_address The recipient e-mail address
 * @param  string $_headers The provisional headers to use
 * @return string Updated headers to use including List-Unsubscribe
 */
public function inject_unsubscribe_headers(string $email_address, string $_headers) : string