name: MailMessage class_comment: null dependencies: - name: Container type: class source: Illuminate\Container\Container - name: Attachable type: class source: Illuminate\Contracts\Mail\Attachable - name: Arrayable type: class source: Illuminate\Contracts\Support\Arrayable - name: Renderable type: class source: Illuminate\Contracts\Support\Renderable - name: Attachment type: class source: Illuminate\Mail\Attachment - name: Markdown type: class source: Illuminate\Mail\Markdown - name: Conditionable type: class source: Illuminate\Support\Traits\Conditionable - name: Conditionable type: class source: Conditionable properties: - name: view visibility: public comment: '# * The view to be rendered. # * # * @var array|string' - name: viewData visibility: public comment: '# * The view data for the message. # * # * @var array' - name: markdown visibility: public comment: '# * The Markdown template to render (if applicable). # * # * @var string|null' - name: theme visibility: public comment: '# * The current theme being used when generating emails. # * # * @var string|null' - name: from visibility: public comment: '# * The "from" information for the message. # * # * @var array' - name: replyTo visibility: public comment: '# * The "reply to" information for the message. # * # * @var array' - name: cc visibility: public comment: '# * The "cc" information for the message. # * # * @var array' - name: bcc visibility: public comment: '# * The "bcc" information for the message. # * # * @var array' - name: attachments visibility: public comment: '# * The attachments for the message. # * # * @var array' - name: rawAttachments visibility: public comment: '# * The raw attachments for the message. # * # * @var array' - name: tags visibility: public comment: '# * The tags for the message. # * # * @var array' - name: metadata visibility: public comment: '# * The metadata for the message. # * # * @var array' - name: priority visibility: public comment: '# * Priority level of the message. # * # * @var int' - name: callbacks visibility: public comment: '# * The callbacks for the message. # * # * @var array' methods: - name: view visibility: public parameters: - name: view - name: data default: '[]' comment: "# * The view to be rendered.\n# *\n# * @var array|string\n# */\n# public\ \ $view;\n# \n# /**\n# * The view data for the message.\n# *\n# * @var array\n\ # */\n# public $viewData = [];\n# \n# /**\n# * The Markdown template to render\ \ (if applicable).\n# *\n# * @var string|null\n# */\n# public $markdown = 'notifications::email';\n\ # \n# /**\n# * The current theme being used when generating emails.\n# *\n# *\ \ @var string|null\n# */\n# public $theme;\n# \n# /**\n# * The \"from\" information\ \ for the message.\n# *\n# * @var array\n# */\n# public $from = [];\n# \n# /**\n\ # * The \"reply to\" information for the message.\n# *\n# * @var array\n# */\n\ # public $replyTo = [];\n# \n# /**\n# * The \"cc\" information for the message.\n\ # *\n# * @var array\n# */\n# public $cc = [];\n# \n# /**\n# * The \"bcc\" information\ \ for the message.\n# *\n# * @var array\n# */\n# public $bcc = [];\n# \n# /**\n\ # * The attachments for the message.\n# *\n# * @var array\n# */\n# public $attachments\ \ = [];\n# \n# /**\n# * The raw attachments for the message.\n# *\n# * @var array\n\ # */\n# public $rawAttachments = [];\n# \n# /**\n# * The tags for the message.\n\ # *\n# * @var array\n# */\n# public $tags = [];\n# \n# /**\n# * The metadata for\ \ the message.\n# *\n# * @var array\n# */\n# public $metadata = [];\n# \n# /**\n\ # * Priority level of the message.\n# *\n# * @var int\n# */\n# public $priority;\n\ # \n# /**\n# * The callbacks for the message.\n# *\n# * @var array\n# */\n# public\ \ $callbacks = [];\n# \n# /**\n# * Set the view for the mail message.\n# *\n#\ \ * @param array|string $view\n# * @param array $data\n# * @return $this" - name: text visibility: public parameters: - name: textView - name: data default: '[]' comment: '# * Set the plain text view for the mail message. # * # * @param string $textView # * @param array $data # * @return $this' - name: markdown visibility: public parameters: - name: view - name: data default: '[]' comment: '# * Set the Markdown template for the notification. # * # * @param string $view # * @param array $data # * @return $this' - name: template visibility: public parameters: - name: template comment: '# * Set the default markdown template. # * # * @param string $template # * @return $this' - name: theme visibility: public parameters: - name: theme comment: '# * Set the theme to use with the Markdown template. # * # * @param string $theme # * @return $this' - name: from visibility: public parameters: - name: address - name: name default: 'null' comment: '# * Set the from address for the mail message. # * # * @param string $address # * @param string|null $name # * @return $this' - name: replyTo visibility: public parameters: - name: address - name: name default: 'null' comment: '# * Set the "reply to" address of the message. # * # * @param array|string $address # * @param string|null $name # * @return $this' - name: cc visibility: public parameters: - name: address - name: name default: 'null' comment: '# * Set the cc address for the mail message. # * # * @param array|string $address # * @param string|null $name # * @return $this' - name: bcc visibility: public parameters: - name: address - name: name default: 'null' comment: '# * Set the bcc address for the mail message. # * # * @param array|string $address # * @param string|null $name # * @return $this' - name: attach visibility: public parameters: - name: file - name: options default: '[]' comment: '# * Attach a file to the message. # * # * @param string|\Illuminate\Contracts\Mail\Attachable|\Illuminate\Mail\Attachment $file # * @param array $options # * @return $this' - name: attachMany visibility: public parameters: - name: files comment: '# * Attach multiple files to the message. # * # * @param array $files # * @return $this' - name: attachData visibility: public parameters: - name: data - name: name - name: options default: '[]' comment: '# * Attach in-memory data as an attachment. # * # * @param string $data # * @param string $name # * @param array $options # * @return $this' - name: tag visibility: public parameters: - name: value comment: '# * Add a tag header to the message when supported by the underlying transport. # * # * @param string $value # * @return $this' - name: metadata visibility: public parameters: - name: key - name: value comment: '# * Add a metadata header to the message when supported by the underlying transport. # * # * @param string $key # * @param string $value # * @return $this' - name: priority visibility: public parameters: - name: level comment: '# * Set the priority of this message. # * # * The value is an integer where 1 is the highest priority and 5 is the lowest. # * # * @param int $level # * @return $this' - name: data visibility: public parameters: [] comment: '# * Get the data array for the mail message. # * # * @return array' - name: parseAddresses visibility: protected parameters: - name: value comment: '# * Parse the multi-address array into the necessary format. # * # * @param array $value # * @return array' - name: arrayOfAddresses visibility: protected parameters: - name: address comment: '# * Determine if the given "address" is actually an array of addresses. # * # * @param mixed $address # * @return bool' - name: render visibility: public parameters: [] comment: '# * Render the mail notification message into an HTML string. # * # * @return \Illuminate\Support\HtmlString' - name: withSymfonyMessage visibility: public parameters: - name: callback comment: '# * Register a callback to be called with the Symfony message instance. # * # * @param callable $callback # * @return $this' traits: - Illuminate\Container\Container - Illuminate\Contracts\Mail\Attachable - Illuminate\Contracts\Support\Arrayable - Illuminate\Contracts\Support\Renderable - Illuminate\Mail\Attachment - Illuminate\Mail\Markdown - Illuminate\Support\Traits\Conditionable - Conditionable interfaces: - Renderable