Function ForumEmailIntegration->_process_incoming_message
Definitions
sources/cns_forum_email_integration.php
- Process an e-mail found.
- Visibility: protected
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $from_email | No | No | required parameter | N/A | N/A | From e-mail | |
| $email_bounce_to | No | No | required parameter | N/A | N/A | E-mail address of sender (usually the same as $email, but not if it was a forwarded e-mail) | |
| $from_name | string | No | No | required parameter | N/A | N/A | From name |
| $subject | string | No | No | required parameter | N/A | N/A | E-mail subject |
| $_body_text | ?string | No | No | required parameter | N/A | N/A | E-mail body in text format (null: not present) |
| $_body_html | ?string | No | No | required parameter | N/A | N/A | E-mail body in HTML format (null: not present) |
| $attachments | array | No | No | required parameter | N/A | N/A | Map of attachments (name to file data); only populated if $mime_type is appropriate for an attachment |
Preview
Code (PHP)
/**
* Process an e-mail found.
*
* @param EMAIL $from_email From e-mail
* @param EMAIL $email_bounce_to E-mail address of sender (usually the same as $email, but not if it was a forwarded e-mail)
* @param string $from_name From name
* @param string $subject E-mail subject
* @param ?string $_body_text E-mail body in text format (null: not present)
* @param ?string $_body_html E-mail body in HTML format (null: not present)
* @param array $attachments Map of attachments (name to file data); only populated if $mime_type is appropriate for an attachment
*/
protected function _process_incoming_message(string $from_email, string $email_bounce_to, string $from_name, string $subject, ?string $_body_text, ?string $_body_html, array $attachments)
* Process an e-mail found.
*
* @param EMAIL $from_email From e-mail
* @param EMAIL $email_bounce_to E-mail address of sender (usually the same as $email, but not if it was a forwarded e-mail)
* @param string $from_name From name
* @param string $subject E-mail subject
* @param ?string $_body_text E-mail body in text format (null: not present)
* @param ?string $_body_html E-mail body in HTML format (null: not present)
* @param array $attachments Map of attachments (name to file data); only populated if $mime_type is appropriate for an attachment
*/
protected function _process_incoming_message(string $from_email, string $email_bounce_to, string $from_name, string $subject, ?string $_body_text, ?string $_body_html, array $attachments)