1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
<?php
/**
* YiiMailMessage class file.
*
* @author Jonah Turnquist <poppitypop@gmail.com>
* @link https://code.google.com/p/yii-mail/
* @package Yii-Mail
*/
/**
* Any requests to set or get attributes or call methods on this class that are
* not found in that class are redirected to the {@link Swift_Mime_Message}
* object.
*
* This means you need to look at the Swift Mailer documentation to see what
* methods are availiable for this class. There are a <b>lot</b> of methods,
* more than I wish to document. Any methods availiable in
* {@link Swift_Mime_Message} are availiable here.
*
* Documentation for the most important methods can be found at
* {@link http://swiftmailer.org/docs/messages}
*
* The YiiMailMessage component also allows using a shorthand for methods in
* {@link Swift_Mime_Message} that start with set* or get*
* For instance, instead of calling $message->setFrom('...') you can use
* $message->from = '...'.
*
* Here are a few methods to get you started:
* <ul>
* <li>setSubject('Your subject')</li>
* <li>setFrom(array('john@doe.com' => 'John Doe'))</li>
* <li>setTo(array('receiver@domain.org', 'other@domain.org' => 'Name'))</li>
* <li>attach(Swift_Attachment::fromPath('my-document.pdf'))</li>
* </ul>
*/
class YiiMailMessage extends CComponent {
/**
* @var string the view to use for rendering the body, null if no view is
* used. An extra variable $mail will be passed to the view .which you may
* use to set e.g. the email subject from within the view
*/
public $view;
/**
* @var Swift_Mime_Message
*/
public $message;
/**
* Any requests to set or get attributes or call methods on this class that
* are not found are redirected to the {@link Swift_Mime_Message} object.
* @param string the attribute name
*/
public function __get($name) {
try {
return parent::__get($name);
} catch (CException $e) {
$getter = 'get'.$name;
if(method_exists($this->message, $getter))
return $this->message->$getter();
else
throw $e;
}
}
/**
* Any requests to set or get attributes or call methods on this class that
* are not found are redirected to the {@link Swift_Mime_Message} object.
* @param string the attribute name
*/
public function __set($name, $value) {
try {
return parent::__set($name, $value);
} catch (CException $e) {
$setter = 'set'.$name;
if(method_exists($this->message, $setter))
$this->message->$setter($value);
else
throw $e;
}
}
/**
* Any requests to set or get attributes or call methods on this class that
* are not found are redirected to the {@link Swift_Mime_Message} object.
* @param string the method name
*/
public function __call($name, $parameters) {
try {
return parent::__call($name, $parameters);
} catch (CException $e) {
if(method_exists($this->message, $name))
return call_user_func_array(array($this->message, $name), $parameters);
else
throw $e;
}
}
/**
* You may optionally set some message info using the paramaters of this
* constructor.
* Use {@link view} and {@link setBody()} for more control.
*
* @param string $subject
* @param string $body
* @param string $contentType
* @param string $charset
* @return Swift_Mime_Message
*/
public function __construct($subject = null, $body = null, $contentType = null, $charset = null) {
Yii::app()->mail->registerScripts();
$this->message = Swift_Message::newInstance($subject, $body, $contentType, $charset);
}
/**
* Set the body of this entity, either as a string, or array of view
* variables if a view is set, or as an instance of
* {@link Swift_OutputByteStream}.
*
* @param mixed the body of the message. If a $this->view is set and this
* is a string, this is passed to the view as $body. If $this->view is set
* and this is an array, the array values are passed to the view like in the
* controller render() method
* @param string content type optional. For html, set to 'html/text'
* @param string charset optional
*/
public function setBody($body = '', $contentType = null, $charset = null) {
if ($this->view !== null) {
if (!is_array($body)) $body = array('body'=>$body);
// if Yii::app()->controller doesn't exist create a dummy
// controller to render the view (needed in the console app)
if(isset(Yii::app()->controller))
$controller = Yii::app()->controller;
else
$controller = new CController('YiiMail');
// renderPartial won't work with CConsoleApplication, so use
// renderInternal - this requires that we use an actual path to the
// view rather than the usual alias
$viewPath = Yii::getPathOfAlias(Yii::app()->mail->viewPath.'.'.$this->view).'.php';
$body = $controller->renderInternal($viewPath, array_merge($body, array('mail'=>$this)), true);
}
return $this->message->setBody($body, $contentType, $charset);
}
}
|
