Function ForumEmailIntegration->outgoing_message
Definitions
sources/cns_forum_email_integration.php
- Send out an e-mail message for a forum post.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $topic_id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the topic that got posted in |
| $post_id | AUTO_LINK | No | No | required parameter | N/A | N/A | The ID of the post |
| $forum_id | AUTO_LINK | No | No | required parameter | N/A | N/A | The forum that the topic is in |
| $post_url | mixed | No | No | required parameter | N/A | N/A | URL to the post (URLPATH or Tempcode) |
| $topic_title | string | No | No | required parameter | N/A | N/A | Topic title |
| $post | string | No | No | required parameter | N/A | N/A | Post text |
| $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 | 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 poster |
| $is_starter | boolean | No | No | False | N/A | N/A | Whether this is a new topic, just created by the poster |
Preview
Code (PHP)
/**
* Send out an e-mail message for a forum post.
*
* @param AUTO_LINK $topic_id The ID of the topic that got posted in
* @param AUTO_LINK $post_id The ID of the post
* @param AUTO_LINK $forum_id The forum that the topic is in
* @param mixed $post_url URL to the post (URLPATH or Tempcode)
* @param string $topic_title Topic title
* @param string $post Post text
* @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 poster
* @param boolean $is_starter Whether this is a new topic, just created by the poster
*/
public function outgoing_message(int $topic_id, int $post_id, int $forum_id, $post_url, string $topic_title, string $post, int $to_member_id, string $to_displayname, string $to_email, string $from_displayname, bool $is_starter = false)
* Send out an e-mail message for a forum post.
*
* @param AUTO_LINK $topic_id The ID of the topic that got posted in
* @param AUTO_LINK $post_id The ID of the post
* @param AUTO_LINK $forum_id The forum that the topic is in
* @param mixed $post_url URL to the post (URLPATH or Tempcode)
* @param string $topic_title Topic title
* @param string $post Post text
* @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 poster
* @param boolean $is_starter Whether this is a new topic, just created by the poster
*/
public function outgoing_message(int $topic_id, int $post_id, int $forum_id, $post_url, string $topic_title, string $post, int $to_member_id, string $to_displayname, string $to_email, string $from_displayname, bool $is_starter = false)