| Property | Type | Description | |
|---|---|---|---|
| $inbound_provider | Inbound provider loader. Defaults to boolean false. |
| Method | Description | |
|---|---|---|
| activity_listener ( object $item ) | Saves pertinent activity variables to our "listener" object, which is used in {@link BP_Reply_By_Email::wp_mail_filter()} Since the activity component is used in other BP components, we can also do checks for forums and blogs as well. | |
| admin_notice ( ) | Add an admin notice nag | |
| bbp_listener ( integer $reply_id, integer $topic_id ) | bbPress 2 plugin compatibility. | |
| disable_non_rbe_notice ( boolean $retval, array $args ) : boolean | For non-RBE emails, we now add a line above each message denoting that the email is not one you can reply to. | |
| get_inbound_providers ( ) : array | Get inbound providers. | |
| get_temporary_variables ( array $retval ) : array | When posting group forum topics or posts via IMAP, we need to grab some temporary variables to pass to other methods - {@link BP_Reply_By_Email::group_forum_listener()} and {@link BP_Reply_By_Email::set_group_id()}. | |
| group_forum_listener ( integer $post_id ) | BP Group Email Subscription (GES) plugin compatibility. | |
| init ( ) | Initializes the class when called upon. | |
| load_inbound_provider ( ) | Load inbound provider. | |
| localization ( ) | Custom textdomain loader. | |
| message_listener ( object $item ) | Saves pertinent message variables to our "listener" object, which is used in {@link BP_Reply_By_Email::wp_mail_filter()} | |
| move_nonrbe_notice_in_bp_html ( string $retval, string $property_name, string $transform ) | Moves the non-RBE notice in the BP HTML email content to the top of the email. | |
| move_rbe_marker ( str $html ) : str | WP Better Emails Support. | |
| move_rbe_marker_in_bp_html ( string $retval, string $property_name, string $transform ) | Moves the RBE marker in the BP HTML email content to the top of the email. | |
| phpmailer_set_reply_to_header ( PHPMailer $phpmailer ) | Set 'Reply-To' email address for PHPMailer if mailbox is > 64 characters. | |
| post ( boolean $retval, array $data, array $params ) : array | object | Post by email routine. | |
| set_bp_email_headers ( boolean | WP_Error $retval, BP_Email $email ) | Set various email headers for BP 2.5 emails. | |
| set_bp_post_object ( WP_Post $post ) : WP_Post | Modify BP email content to prepend our RBE marker. | |
| set_group_id ( integer $retval ) : integer | Overrides the current group ID with our locally-cached one from {@link BP_Reply_By_Email::get_temporary_variables()} if available. | |
| wp_mail_filter ( array $args ) : array | Adds "Reply-To" to email headers in {@link wp_mail()}. |
| Method | Description | |
|---|---|---|
| get_reply_to_address ( array $headers = [] ) | Get the email address used for the 'Reply-To' email header. | |
| prepend_nonrbe_notice_to_content ( string $content = '', $args = [] ) : string | Prepend our non-RBE notice to a string. | |
| prepend_rbe_marker_to_content ( string $content = '' ) : string | Prepend our RBE marker to a string. |
| Method | Description | |
|---|---|---|
| constants ( ) | Setup our constants. | |
| hooks ( ) | Setup RBE's hooks. | |
| includes ( ) | Include required files. |
| public activity_listener ( object $item ) | ||
| $item | object | The activity object created during {@link BP_Activity_Activity::save()} |
| public bbp_listener ( integer $reply_id, integer $topic_id ) | ||
| $reply_id | integer | The forum reply ID created by bbPress |
| $topic_id | integer | The forum topic ID created by bbPress |
| public static get_inbound_providers ( ) : array | ||
| return | array | Key/value pairs (inbound provider name => class name) |
| protected get_reply_to_address ( array $headers = [] ) | ||
| $headers | array | Email headers. |
| public get_temporary_variables ( array $retval ) : array | ||
| $retval | array | Array of arguments |
| return | array | Array of arguments |
| public group_forum_listener ( integer $post_id ) | ||
| $post_id | integer | The forum post ID created by bbPress |
| public localization ( ) |
| public message_listener ( object $item ) | ||
| $item | object | The message object created during {@link BP_Messages_Message::send()} |
| public move_rbe_marker ( str $html ) : str | ||
| $html | str | The full HTML email content from WPBE |
| return | str | Modified HTML content |
| public phpmailer_set_reply_to_header ( PHPMailer $phpmailer ) | ||
| $phpmailer | PHPMailer | |
| public post ( boolean $retval, array $data, array $params ) : array | object | ||
| $retval | boolean | True by default. |
| $data | array | { An array of arguments. @type array $headers Email headers. @type string $content The email body content. @type string $subject The email subject line. @type int $user_id The user ID who sent the email. @type bool $is_html Whether the email content is HTML or not. @type int $i The email message number. } |
| $params | array | Parsed paramaters from the email address querystring. See {@link BP_Reply_By_Email_Parser::get_parameters()}. |
| return | array | object | Array of the parsed item on success. WP_Error object on failure. |
| protected prepend_nonrbe_notice_to_content ( string $content = '', $args = [] ) : string | ||
| $content | string | |
| return | string | |
| protected prepend_rbe_marker_to_content ( string $content = '' ) : string | ||
| $content | string | |
| return | string | |
| public set_bp_email_headers ( boolean | WP_Error $retval, BP_Email $email ) | ||
| $retval | boolean | WP_Error | Returns true if validation is successful, else a descriptive WP_Error. |
| BP_Email | Current instance of the email type class. | |
| public set_bp_post_object ( WP_Post $post ) : WP_Post | ||
| $post | WP_Post | BP Email post object. |
| return | WP_Post | |
| public set_group_id ( integer $retval ) : integer | ||
| $retval | integer | The group ID |
| return | integer | $retval The group ID |
| public wp_mail_filter ( array $args ) : array | ||
| $args | array | Arguments provided via {@link wp_mail()} filter. |
| return | array | |
