Function EmailIntegration->_outgoing_message

Definitions

sources/mail_integration.php

  • Send out an e-mail message.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$subject string No No required parameter N/A N/A Subject
$message string No No required parameter N/A N/A Message in Comcode
$to_member_id MEMBER No No required parameter N/A N/A Member ID of recipient
$to_displayname string No No required parameter N/A N/A Display name of recipient
$to_email EMAIL No No required parameter N/A N/A E-mail address of recipient
$from_displayname string No No required parameter N/A N/A Display name of sender
$from_email EMAIL No No Blank (empty string) N/A N/A E-mail address of sender (blank: use sender address for Reply-To)

Preview

Code (PHP)

/**
 * Send out an e-mail message.
 *
 * @param  string $subject Subject
 * @param  string $message Message in Comcode
 * @param  MEMBER $to_member_id Member ID of recipient
 * @param  string $to_displayname Display name of recipient
 * @param  EMAIL $to_email E-mail address of recipient
 * @param  string $from_displayname Display name of sender
 * @param  EMAIL $from_email E-mail address of sender (blank: use sender address for Reply-To)
 */
protected function _outgoing_message(string $subject, string $message, int $to_member_id, string $to_displayname, string $to_email, string $from_displayname, string $from_email = '')