NF_Actions_Email

Class NF_Action_Email.

Defined (1)

The class is defined in the following location(s).

/includes/Actions/Email.php  
  1. final class NF_Actions_Email extends NF_Abstracts_Action 
  2. { 
  3.     /** 
  4.     * @var string 
  5.     */ 
  6.     protected $_name = 'email'; 
  7.  
  8.     /** 
  9.     * @var array 
  10.     */ 
  11.     protected $_tags = array(); 
  12.  
  13.     /** 
  14.     * @var string 
  15.     */ 
  16.     protected $_timing = 'late'; 
  17.  
  18.     /** 
  19.     * @var int 
  20.     */ 
  21.     protected $_priority = 10; 
  22.  
  23.     /** 
  24.     * Constructor 
  25.     */ 
  26.     public function __construct() 
  27.     { 
  28.         parent::__construct(); 
  29.  
  30.         $this->_nicename = __( 'Email', 'ninja-forms' ); 
  31.  
  32.         $settings = Ninja_Forms::config( 'ActionEmailSettings' ); 
  33.  
  34.         $this->_settings = array_merge( $this->_settings, $settings ); 
  35.  
  36.         $this->_backwards_compatibility(); 
  37.     } 
  38.  
  39.     /** 
  40.     * PUBLIC METHODS 
  41.     */ 
  42.  
  43.     public function process( $action_settings, $form_id, $data ) 
  44.     { 
  45.         $errors = $this->check_for_errors( $action_settings ); 
  46.  
  47.         $headers = $this->_get_headers( $action_settings ); 
  48.          
  49.         if ( has_filter( 'ninja_forms_get_fields_sorted' ) ) { 
  50.             $fields_by_key = array(); 
  51.             foreach( $data[ 'fields' ] as $field ) { 
  52.                 if( is_null( $field ) ) continue; 
  53.                 if( is_array( $field ) ) { 
  54.                     if( ! isset( $field[ 'key' ] ) ) continue; 
  55.                     $key = $field[ 'key' ]; 
  56.                 } else { 
  57.                     $key = $field->get_setting('key'); 
  58.                 } 
  59.                 $fields_by_key[ $key ] = $field; 
  60.             } 
  61.             $data[ 'fields' ] = apply_filters( 'ninja_forms_get_fields_sorted', array(), $data[ 'fields' ], $fields_by_key, $form_id ); 
  62.         } 
  63.  
  64.         $attachments = $this->_get_attachments( $action_settings, $data ); 
  65.  
  66.         if( 'html' == $action_settings[ 'email_format' ] ) { 
  67.             $message = $action_settings['email_message']; 
  68.         } else { 
  69.             $message = $this->format_plain_text_message( $action_settings[ 'email_message_plain' ] ); 
  70.         } 
  71.  
  72.         $message = apply_filters( 'ninja_forms_action_email_message', $message, $data, $action_settings ); 
  73.  
  74.         try { 
  75.             $sent = wp_mail($action_settings['to'], $action_settings['email_subject'], $message, $headers, $attachments); 
  76.         } catch ( Exception $e ) { 
  77.             $sent = false; 
  78.             $errors[ 'email_sent' ] = $e->getMessage(); 
  79.         } 
  80.  
  81.         $data[ 'actions' ][ 'email' ][ 'to' ] = $action_settings['to']; 
  82.         $data[ 'actions' ][ 'email' ][ 'sent' ] = $sent; 
  83.         $data[ 'actions' ][ 'email' ][ 'headers' ] = $headers; 
  84.         $data[ 'actions' ][ 'email' ][ 'attachments' ] = $attachments; 
  85.  
  86.         if( $errors ) { 
  87.             $data[ 'errors' ][ 'form' ] = $errors; 
  88.         } 
  89.          
  90.         if ( ! empty( $attachments ) ) { 
  91.             $this->_drop_csv(); 
  92.         } 
  93.  
  94.         return $data; 
  95.     } 
  96.  
  97.     protected function check_for_errors( $action_settings ) 
  98.     { 
  99.         $errors = array(); 
  100.  
  101.         $email_address_settings = array( 'to', 'from_address', 'reply_to', 'cc', 'bcc' ); 
  102.  
  103.         foreach( $email_address_settings as $setting ) { 
  104.             if( ! isset( $action_settings[ $setting ] ) ) continue; 
  105.             if( ! $action_settings[ $setting ] ) continue; 
  106.  
  107.  
  108.             $email_addresses = is_array( $action_settings[ $setting ] ) ? $action_settings[ $setting ] : explode( ', ', $action_settings[ $setting ] ); 
  109.             foreach( (array) $email_addresses as $email ) { 
  110.                 $email = trim( $email ); 
  111.                 if ( false !== strpos( $email, '<' ) && false !== strpos( $email, '>' ) ) { 
  112.                     preg_match('/(?<=<).*?(?=>)/', $email, $email); 
  113.                     $email = $email[ 0 ]; 
  114.                 } 
  115.                 if( ! is_email( $email ) ) { 
  116.                     $errors[ 'email_' . $email ] = sprintf( __( 'Your email action "%s" has an invalid value for the "%s" setting. Please check this setting and try again.', 'ninja-forms'), $action_settings[ 'label' ], $setting ); 
  117.                 } 
  118.             } 
  119.         } 
  120.  
  121.         return $errors; 
  122.     } 
  123.  
  124.     private function _get_headers( $settings ) 
  125.     { 
  126.         $headers = array(); 
  127.  
  128.         $headers[] = 'Content-Type: text/' . $settings[ 'email_format' ]; 
  129.         $headers[] = 'charset=UTF-8'; 
  130.  
  131.         $headers[] = $this->_format_from( $settings ); 
  132.  
  133.         $headers = array_merge( $headers, $this->_format_recipients( $settings ) ); 
  134.  
  135.         return $headers; 
  136.     } 
  137.  
  138.     private function _get_attachments( $settings, $data ) 
  139.     { 
  140.         $attachments = array(); 
  141.  
  142.         if( 1 == $settings[ 'attach_csv' ] ) { 
  143.             $attachments[] = $this->_create_csv( $data[ 'fields' ] ); 
  144.         } 
  145.  
  146.         if( ! isset( $settings[ 'id' ] ) ) $settings[ 'id' ] = ''; 
  147.  
  148.         $attachments = apply_filters( 'ninja_forms_action_email_attachments', $attachments, $data, $settings ); 
  149.  
  150.         return $attachments; 
  151.     } 
  152.  
  153.     private function _format_from( $settings ) 
  154.     { 
  155.         $from_name = get_bloginfo( 'name', 'raw' ); 
  156.         $from_name = apply_filters( 'ninja_forms_action_email_from_name', $from_name ); 
  157.         $from_name = ( $settings[ 'from_name' ] ) ? $settings[ 'from_name' ] : $from_name; 
  158.  
  159.         $from_address = get_bloginfo( 'admin_email' ); 
  160.         $from_address = apply_filters( 'ninja_forms_action_email_from_address', $from_address ); 
  161.         $from_address = ( $settings[ 'from_address' ] ) ? $settings[ 'from_address' ] : $from_address; 
  162.  
  163.         return $this->_format_recipient( 'from', $from_address, $from_name ); 
  164.     } 
  165.  
  166.     private function _format_recipients( $settings ) 
  167.     { 
  168.         $headers = array(); 
  169.  
  170.         $recipient_settings = array( 
  171.             'Cc' => $settings[ 'cc' ],  
  172.             'Bcc' => $settings[ 'bcc' ],  
  173.             'Reply-to' => $settings[ 'reply_to' ],  
  174.  ); 
  175.  
  176.         foreach( $recipient_settings as $type => $emails ) { 
  177.  
  178.             $emails = explode( ', ', $emails ); 
  179.  
  180.             foreach( $emails as $email ) { 
  181.  
  182.                 if( ! $email ) continue; 
  183.  
  184.                 $matches = array(); 
  185.                 if (preg_match('/^"?(?<name>[^<"]+)"? <(?<email>[^>]+)>$/', $email, $matches)) { 
  186.                     $headers[] = $this->_format_recipient($type, $matches['email'], $matches['name']); 
  187.                 } else { 
  188.                     $headers[] = $this->_format_recipient($type, $email); 
  189.                 } 
  190.             } 
  191.         } 
  192.  
  193.         return $headers; 
  194.     } 
  195.  
  196.     private function _format_recipient( $type, $email, $name = '' ) 
  197.     { 
  198.         $type = ucfirst( $type ); 
  199.  
  200.         if( ! $name ) $name = $email; 
  201.  
  202.         $recipient = "$type: $name <$email>"; 
  203.  
  204.         return $recipient; 
  205.     } 
  206.  
  207.     private function _create_csv( $fields ) 
  208.     { 
  209.         $csv_array = array(); 
  210.          
  211.         // Get our current date. 
  212.         $date_format = Ninja_Forms()->get_setting( 'date_format' ); 
  213.         $today = date( $date_format, current_time( 'timestamp' ) ); 
  214.         $csv_array[ 0 ][] = 'Date Submitted'; 
  215.         $csv_array[ 1 ][] = $today; 
  216.  
  217.         foreach( $fields as $field ) { 
  218.              
  219.             $ignore = array( 
  220.                 'hr',  
  221.                 'submit',  
  222.                 'html' 
  223.  ); 
  224.  
  225.             $ignore = apply_filters( 'ninja_forms_csv_ignore_fields', $ignore ); 
  226.  
  227.             if( ! isset( $field[ 'label' ] ) ) continue; 
  228.             if( in_array( $field[ 'type' ], $ignore ) ) continue; 
  229.              
  230.             $label = ( '' != $field[ 'admin_label' ] ) ? $field[ 'admin_label' ] : $field[ 'label' ]; 
  231.              
  232.             $value = WPN_Helper::stripslashes( $field[ 'value' ] ); 
  233.             if ( empty( $value ) ) { 
  234.                 $value = ''; 
  235.             } 
  236.             if ( is_array( $value ) ) { 
  237.                 $value = implode( ', ', $value ); 
  238.             } 
  239.  
  240.             $csv_array[ 0 ][] = $label; 
  241.             $csv_array[ 1 ][] = $value; 
  242.         } 
  243.  
  244.         $csv_content = WPN_Helper::str_putcsv( $csv_array,  
  245.             apply_filters( 'ninja_forms_sub_csv_delimiter', ', ' ),  
  246.             apply_filters( 'ninja_forms_sub_csv_enclosure', '"' ),  
  247.             apply_filters( 'ninja_forms_sub_csv_terminator', "\n" ) 
  248.  ); 
  249.  
  250.         $upload_dir = wp_upload_dir(); 
  251.         $path = trailingslashit( $upload_dir['path'] ); 
  252.  
  253.         // create temporary file 
  254.         $path = tempnam( $path, 'Sub' ); 
  255.         $temp_file = fopen( $path, 'r+' ); 
  256.  
  257.         // write to temp file 
  258.         fwrite( $temp_file, $csv_content ); 
  259.         fclose( $temp_file ); 
  260.  
  261.         // find the directory we will be using for the final file 
  262.         $path = pathinfo( $path ); 
  263.         $dir = $path['dirname']; 
  264.         $basename = $path['basename']; 
  265.  
  266.         // create name for file 
  267.         $new_name = apply_filters( 'ninja_forms_submission_csv_name', 'ninja-forms-submission' ); 
  268.  
  269.         // remove a file if it already exists 
  270.         if( file_exists( $dir.'/'.$new_name.'.csv' ) ) { 
  271.             unlink( $dir.'/'.$new_name.'.csv' ); 
  272.         } 
  273.  
  274.         // move file 
  275.         rename( $dir.'/'.$basename, $dir.'/'.$new_name.'.csv' ); 
  276.         return $dir.'/'.$new_name.'.csv'; 
  277.     } 
  278.      
  279.     /** 
  280.      * Function to delete csv file from temp directory after Email Action has completed. 
  281.      */ 
  282.     private function _drop_csv() 
  283.     { 
  284.         $upload_dir = wp_upload_dir(); 
  285.         $path = trailingslashit( $upload_dir['path'] ); 
  286.  
  287.         // create name for file 
  288.         $new_name = apply_filters( 'ninja_forms_submission_csv_name', 'ninja-forms-submission' ); 
  289.  
  290.         // remove a file if it already exists 
  291.         if( file_exists( $path.'/'.$new_name.'.csv' ) ) { 
  292.             unlink( $path.'/'.$new_name.'.csv' ); 
  293.         } 
  294.     } 
  295.  
  296.     /** 
  297.      * Backwards Compatibility 
  298.      */ 
  299.  
  300.     private function _backwards_compatibility() 
  301.     { 
  302.         add_filter( 'ninja_forms_sub_csv_delimiter', array( $this, 'ninja_forms_sub_csv_delimiter' ), 10, 1 ); 
  303.         add_filter( 'ninja_sub_csv_enclosure', array( $this, 'ninja_sub_csv_enclosure' ), 10, 1 ); 
  304.         add_filter( 'ninja_sub_csv_terminator', array( $this, 'ninja_sub_csv_terminator' ), 10, 1 ); 
  305.         add_filter( 'ninja_forms_action_email_attachments', array( $this, 'ninja_forms_action_email_attachments' ), 10, 3 ); 
  306.     } 
  307.  
  308.     public function ninja_forms_sub_csv_delimiter( $delimiter ) 
  309.     { 
  310.         return apply_filters( 'nf_sub_csv_delimiter', $delimiter ); 
  311.     } 
  312.  
  313.     public function ninja_sub_csv_enclosure( $enclosure ) 
  314.     { 
  315.         return apply_filters( 'nf_sub_csv_enclosure', $enclosure ); 
  316.     } 
  317.  
  318.     public function ninja_sub_csv_terminator( $terminator ) 
  319.     { 
  320.         return apply_filters( 'nf_sub_csv_terminator', $terminator ); 
  321.     } 
  322.  
  323.     public function ninja_forms_action_email_attachments( $attachments, $form_data, $action_settings ) 
  324.     { 
  325.         return apply_filters( 'nf_email_notification_attachments', $attachments, $action_settings[ 'id' ] ); 
  326.     } 
  327.  
  328.     private function format_plain_text_message( $message ) 
  329.     { 
  330.         $message =  str_replace( array( '<table>', '</table>', '<tr><td>', '' ), '', $message ); 
  331.         $message =  str_replace( '</td><td>', ' ', $message ); 
  332.         $message =  str_replace( '</td></tr>', "\r\n", $message ); 
  333.         return strip_tags( $message ); 
  334.     } 
  335. }