.phan/stubs/mail.php

   1 <?php
   2
   3 /**
   4  * Minimal set of classes necessary for UserMailer to be happy. Types
   5  * taken from documentation at pear.php.net.
   6  * phpcs:ignoreFile
   7  */
   8
   9 class PEAR {
  10         /**
  11          * @param mixed $data
  12          * @return bool
  13          */
  14         public static function isError( $data ) {
  15         }
  16 }
  17
  18 class PEAR_Error {
  19         /**
  20          * @return string
  21          */
  22         public function getMessage() {
  23         }
  24 }
  25
  26 class Mail {
  27         /**
  28          * @param string $driver
  29          * @param array $params
  30          * @return self
  31          */
  32         static public function factory( $driver, array $params = [] ) {
  33         }
  34
  35         /**
  36          * @param mixed $recipients
  37          * @param array $headers
  38          * @param string $body
  39          * @return bool|PEAR_Error
  40          */
  41         public function send( $recipients, array $headers, $body ) {
  42         }
  43         /**
  44          * @return string
  45          */
  46         public function getMessage() {
  47         }
  48 }
  49
  50 class Mail_smtp extends Mail {
  51 }
  52
  53 class Mail_mime {
  54         /**
  55          * @param mixed $params
  56          */
  57         public function __construct( $params = [] ) {
  58         }
  59
  60         /**
  61          * @param string $data
  62          * @param bool $isfile
  63          * @param bool $append
  64          * @return bool|PEAR_Error
  65          */
  66         public function setTXTBody( $data, $isfile = false, $append = false ) {
  67         }
  68
  69         /**
  70          * @param string $data
  71          * @param bool $isfile
  72          * @return bool|PEAR_Error
  73          */
  74         public function setHTMLBody( $data, $isfile = false ) {
  75         }
  76
  77         /**
  78          * @param array|null $parms
  79          * @param mixed $filename
  80          * @param bool $skip_head
  81          * @return string|bool|PEAR_Error
  82          */
  83         public function get( $params = null, $filename = null, $skip_head = false ) {
  84         }
  85
  86         /**
  87          * @param array|null $xtra_headers
  88          * @param bool $overwrite
  89          * @param bool $skip_content
  90          * @return array
  91          */
  92         public function headers( array $xtra_headers = null, $overwrite = false, $skip_content = false ) {
  93         }
  94 }