MailMailableTest.php 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444
  1. <?php
  2. namespace Illuminate\Tests\Mail;
  3. use Illuminate\Mail\Mailable;
  4. use PHPUnit\Framework\TestCase;
  5. class MailMailableTest extends TestCase
  6. {
  7. public function testMailableSetsRecipientsCorrectly()
  8. {
  9. $mailable = new WelcomeMailableStub;
  10. $mailable->to('taylor@laravel.com');
  11. $this->assertEquals([['name' => null, 'address' => 'taylor@laravel.com']], $mailable->to);
  12. $this->assertTrue($mailable->hasTo('taylor@laravel.com'));
  13. $mailable = new WelcomeMailableStub;
  14. $mailable->to('taylor@laravel.com', 'Taylor Otwell');
  15. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->to);
  16. $this->assertTrue($mailable->hasTo('taylor@laravel.com', 'Taylor Otwell'));
  17. $this->assertTrue($mailable->hasTo('taylor@laravel.com'));
  18. $mailable = new WelcomeMailableStub;
  19. $mailable->to(['taylor@laravel.com']);
  20. $this->assertEquals([['name' => null, 'address' => 'taylor@laravel.com']], $mailable->to);
  21. $this->assertTrue($mailable->hasTo('taylor@laravel.com'));
  22. $this->assertFalse($mailable->hasTo('taylor@laravel.com', 'Taylor Otwell'));
  23. $mailable = new WelcomeMailableStub;
  24. $mailable->to([['name' => 'Taylor Otwell', 'email' => 'taylor@laravel.com']]);
  25. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->to);
  26. $this->assertTrue($mailable->hasTo('taylor@laravel.com', 'Taylor Otwell'));
  27. $this->assertTrue($mailable->hasTo('taylor@laravel.com'));
  28. $mailable = new WelcomeMailableStub;
  29. $mailable->to(new MailableTestUserStub);
  30. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->to);
  31. $this->assertTrue($mailable->hasTo(new MailableTestUserStub));
  32. $this->assertTrue($mailable->hasTo('taylor@laravel.com'));
  33. $mailable = new WelcomeMailableStub;
  34. $mailable->to(collect([new MailableTestUserStub]));
  35. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->to);
  36. $this->assertTrue($mailable->hasTo(new MailableTestUserStub));
  37. $this->assertTrue($mailable->hasTo('taylor@laravel.com'));
  38. $mailable = new WelcomeMailableStub;
  39. $mailable->to(collect([new MailableTestUserStub, new MailableTestUserStub]));
  40. $this->assertEquals([
  41. ['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com'],
  42. ['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com'],
  43. ], $mailable->to);
  44. $this->assertTrue($mailable->hasTo(new MailableTestUserStub));
  45. $this->assertTrue($mailable->hasTo('taylor@laravel.com'));
  46. foreach (['', null, [], false] as $address) {
  47. $mailable = new WelcomeMailableStub;
  48. $mailable->to($address);
  49. $this->assertFalse($mailable->hasTo(new MailableTestUserStub));
  50. $this->assertFalse($mailable->hasTo($address));
  51. }
  52. }
  53. public function testMailableSetsCcRecipientsCorrectly()
  54. {
  55. $mailable = new WelcomeMailableStub;
  56. $mailable->cc('taylor@laravel.com');
  57. $this->assertEquals([['name' => null, 'address' => 'taylor@laravel.com']], $mailable->cc);
  58. $this->assertTrue($mailable->hasCc('taylor@laravel.com'));
  59. $mailable = new WelcomeMailableStub;
  60. $mailable->cc('taylor@laravel.com', 'Taylor Otwell');
  61. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->cc);
  62. $this->assertTrue($mailable->hasCc('taylor@laravel.com', 'Taylor Otwell'));
  63. $this->assertTrue($mailable->hasCc('taylor@laravel.com'));
  64. $mailable = new WelcomeMailableStub;
  65. $mailable->cc(['taylor@laravel.com']);
  66. $this->assertEquals([['name' => null, 'address' => 'taylor@laravel.com']], $mailable->cc);
  67. $this->assertTrue($mailable->hasCc('taylor@laravel.com'));
  68. $this->assertFalse($mailable->hasCc('taylor@laravel.com', 'Taylor Otwell'));
  69. $mailable = new WelcomeMailableStub;
  70. $mailable->cc([['name' => 'Taylor Otwell', 'email' => 'taylor@laravel.com']]);
  71. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->cc);
  72. $this->assertTrue($mailable->hasCc('taylor@laravel.com', 'Taylor Otwell'));
  73. $this->assertTrue($mailable->hasCc('taylor@laravel.com'));
  74. $mailable = new WelcomeMailableStub;
  75. $mailable->cc(new MailableTestUserStub);
  76. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->cc);
  77. $this->assertTrue($mailable->hasCc(new MailableTestUserStub));
  78. $this->assertTrue($mailable->hasCc('taylor@laravel.com'));
  79. $mailable = new WelcomeMailableStub;
  80. $mailable->cc(collect([new MailableTestUserStub]));
  81. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->cc);
  82. $this->assertTrue($mailable->hasCc(new MailableTestUserStub));
  83. $this->assertTrue($mailable->hasCc('taylor@laravel.com'));
  84. $mailable = new WelcomeMailableStub;
  85. $mailable->cc(collect([new MailableTestUserStub, new MailableTestUserStub]));
  86. $this->assertEquals([
  87. ['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com'],
  88. ['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com'],
  89. ], $mailable->cc);
  90. $this->assertTrue($mailable->hasCc(new MailableTestUserStub));
  91. $this->assertTrue($mailable->hasCc('taylor@laravel.com'));
  92. $mailable = new WelcomeMailableStub;
  93. $mailable->cc(['taylor@laravel.com', 'not-taylor@laravel.com']);
  94. $this->assertEquals([
  95. ['name' => null, 'address' => 'taylor@laravel.com'],
  96. ['name' => null, 'address' => 'not-taylor@laravel.com'],
  97. ], $mailable->cc);
  98. $this->assertTrue($mailable->hasCc('taylor@laravel.com'));
  99. $this->assertTrue($mailable->hasCc('not-taylor@laravel.com'));
  100. foreach (['', null, [], false] as $address) {
  101. $mailable = new WelcomeMailableStub;
  102. $mailable->cc($address);
  103. $this->assertFalse($mailable->hasCc(new MailableTestUserStub));
  104. $this->assertFalse($mailable->hasCc($address));
  105. }
  106. }
  107. public function testMailableSetsBccRecipientsCorrectly()
  108. {
  109. $mailable = new WelcomeMailableStub;
  110. $mailable->bcc('taylor@laravel.com');
  111. $this->assertEquals([['name' => null, 'address' => 'taylor@laravel.com']], $mailable->bcc);
  112. $this->assertTrue($mailable->hasBcc('taylor@laravel.com'));
  113. $mailable = new WelcomeMailableStub;
  114. $mailable->bcc('taylor@laravel.com', 'Taylor Otwell');
  115. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->bcc);
  116. $this->assertTrue($mailable->hasBcc('taylor@laravel.com', 'Taylor Otwell'));
  117. $this->assertTrue($mailable->hasBcc('taylor@laravel.com'));
  118. $mailable = new WelcomeMailableStub;
  119. $mailable->bcc(['taylor@laravel.com']);
  120. $this->assertEquals([['name' => null, 'address' => 'taylor@laravel.com']], $mailable->bcc);
  121. $this->assertTrue($mailable->hasBcc('taylor@laravel.com'));
  122. $this->assertFalse($mailable->hasBcc('taylor@laravel.com', 'Taylor Otwell'));
  123. $mailable = new WelcomeMailableStub;
  124. $mailable->bcc([['name' => 'Taylor Otwell', 'email' => 'taylor@laravel.com']]);
  125. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->bcc);
  126. $this->assertTrue($mailable->hasBcc('taylor@laravel.com', 'Taylor Otwell'));
  127. $this->assertTrue($mailable->hasBcc('taylor@laravel.com'));
  128. $mailable = new WelcomeMailableStub;
  129. $mailable->bcc(new MailableTestUserStub);
  130. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->bcc);
  131. $this->assertTrue($mailable->hasBcc(new MailableTestUserStub));
  132. $this->assertTrue($mailable->hasBcc('taylor@laravel.com'));
  133. $mailable = new WelcomeMailableStub;
  134. $mailable->bcc(collect([new MailableTestUserStub]));
  135. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->bcc);
  136. $this->assertTrue($mailable->hasBcc(new MailableTestUserStub));
  137. $this->assertTrue($mailable->hasBcc('taylor@laravel.com'));
  138. $mailable = new WelcomeMailableStub;
  139. $mailable->bcc(collect([new MailableTestUserStub, new MailableTestUserStub]));
  140. $this->assertEquals([
  141. ['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com'],
  142. ['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com'],
  143. ], $mailable->bcc);
  144. $this->assertTrue($mailable->hasBcc(new MailableTestUserStub));
  145. $this->assertTrue($mailable->hasBcc('taylor@laravel.com'));
  146. $mailable = new WelcomeMailableStub;
  147. $mailable->bcc(['taylor@laravel.com', 'not-taylor@laravel.com']);
  148. $this->assertEquals([
  149. ['name' => null, 'address' => 'taylor@laravel.com'],
  150. ['name' => null, 'address' => 'not-taylor@laravel.com'],
  151. ], $mailable->bcc);
  152. $this->assertTrue($mailable->hasBcc('taylor@laravel.com'));
  153. $this->assertTrue($mailable->hasBcc('not-taylor@laravel.com'));
  154. foreach (['', null, [], false] as $address) {
  155. $mailable = new WelcomeMailableStub;
  156. $mailable->bcc($address);
  157. $this->assertFalse($mailable->hasBcc(new MailableTestUserStub));
  158. $this->assertFalse($mailable->hasBcc($address));
  159. }
  160. }
  161. public function testMailableSetsReplyToCorrectly()
  162. {
  163. $mailable = new WelcomeMailableStub;
  164. $mailable->replyTo('taylor@laravel.com');
  165. $this->assertEquals([['name' => null, 'address' => 'taylor@laravel.com']], $mailable->replyTo);
  166. $this->assertTrue($mailable->hasReplyTo('taylor@laravel.com'));
  167. $mailable = new WelcomeMailableStub;
  168. $mailable->replyTo('taylor@laravel.com', 'Taylor Otwell');
  169. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->replyTo);
  170. $this->assertTrue($mailable->hasReplyTo('taylor@laravel.com', 'Taylor Otwell'));
  171. $this->assertTrue($mailable->hasReplyTo('taylor@laravel.com'));
  172. $mailable = new WelcomeMailableStub;
  173. $mailable->replyTo(['taylor@laravel.com']);
  174. $this->assertEquals([['name' => null, 'address' => 'taylor@laravel.com']], $mailable->replyTo);
  175. $this->assertTrue($mailable->hasReplyTo('taylor@laravel.com'));
  176. $this->assertFalse($mailable->hasReplyTo('taylor@laravel.com', 'Taylor Otwell'));
  177. $mailable = new WelcomeMailableStub;
  178. $mailable->replyTo([['name' => 'Taylor Otwell', 'email' => 'taylor@laravel.com']]);
  179. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->replyTo);
  180. $this->assertTrue($mailable->hasReplyTo('taylor@laravel.com', 'Taylor Otwell'));
  181. $this->assertTrue($mailable->hasReplyTo('taylor@laravel.com'));
  182. $mailable = new WelcomeMailableStub;
  183. $mailable->replyTo(new MailableTestUserStub);
  184. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->replyTo);
  185. $this->assertTrue($mailable->hasReplyTo(new MailableTestUserStub));
  186. $this->assertTrue($mailable->hasReplyTo('taylor@laravel.com'));
  187. $mailable = new WelcomeMailableStub;
  188. $mailable->replyTo(collect([new MailableTestUserStub]));
  189. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->replyTo);
  190. $this->assertTrue($mailable->hasReplyTo(new MailableTestUserStub));
  191. $this->assertTrue($mailable->hasReplyTo('taylor@laravel.com'));
  192. $mailable = new WelcomeMailableStub;
  193. $mailable->replyTo(collect([new MailableTestUserStub, new MailableTestUserStub]));
  194. $this->assertEquals([
  195. ['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com'],
  196. ['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com'],
  197. ], $mailable->replyTo);
  198. $this->assertTrue($mailable->hasReplyTo(new MailableTestUserStub));
  199. $this->assertTrue($mailable->hasReplyTo('taylor@laravel.com'));
  200. foreach (['', null, [], false] as $address) {
  201. $mailable = new WelcomeMailableStub;
  202. $mailable->replyTo($address);
  203. $this->assertFalse($mailable->hasReplyTo(new MailableTestUserStub));
  204. $this->assertFalse($mailable->hasReplyTo($address));
  205. }
  206. }
  207. public function testMailableSetsFromCorrectly()
  208. {
  209. $mailable = new WelcomeMailableStub;
  210. $mailable->from('taylor@laravel.com');
  211. $this->assertEquals([['name' => null, 'address' => 'taylor@laravel.com']], $mailable->from);
  212. $this->assertTrue($mailable->hasFrom('taylor@laravel.com'));
  213. $mailable = new WelcomeMailableStub;
  214. $mailable->from('taylor@laravel.com', 'Taylor Otwell');
  215. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->from);
  216. $this->assertTrue($mailable->hasFrom('taylor@laravel.com', 'Taylor Otwell'));
  217. $this->assertTrue($mailable->hasFrom('taylor@laravel.com'));
  218. $mailable = new WelcomeMailableStub;
  219. $mailable->from(['taylor@laravel.com']);
  220. $this->assertEquals([['name' => null, 'address' => 'taylor@laravel.com']], $mailable->from);
  221. $this->assertTrue($mailable->hasFrom('taylor@laravel.com'));
  222. $this->assertFalse($mailable->hasFrom('taylor@laravel.com', 'Taylor Otwell'));
  223. $mailable = new WelcomeMailableStub;
  224. $mailable->from([['name' => 'Taylor Otwell', 'email' => 'taylor@laravel.com']]);
  225. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->from);
  226. $this->assertTrue($mailable->hasFrom('taylor@laravel.com', 'Taylor Otwell'));
  227. $this->assertTrue($mailable->hasFrom('taylor@laravel.com'));
  228. $mailable = new WelcomeMailableStub;
  229. $mailable->from(new MailableTestUserStub);
  230. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->from);
  231. $this->assertTrue($mailable->hasFrom(new MailableTestUserStub));
  232. $this->assertTrue($mailable->hasFrom('taylor@laravel.com'));
  233. $mailable = new WelcomeMailableStub;
  234. $mailable->from(collect([new MailableTestUserStub]));
  235. $this->assertEquals([['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com']], $mailable->from);
  236. $this->assertTrue($mailable->hasFrom(new MailableTestUserStub));
  237. $this->assertTrue($mailable->hasFrom('taylor@laravel.com'));
  238. $mailable = new WelcomeMailableStub;
  239. $mailable->from(collect([new MailableTestUserStub, new MailableTestUserStub]));
  240. $this->assertEquals([
  241. ['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com'],
  242. ['name' => 'Taylor Otwell', 'address' => 'taylor@laravel.com'],
  243. ], $mailable->from);
  244. $this->assertTrue($mailable->hasFrom(new MailableTestUserStub));
  245. $this->assertTrue($mailable->hasFrom('taylor@laravel.com'));
  246. foreach (['', null, [], false] as $address) {
  247. $mailable = new WelcomeMailableStub;
  248. $mailable->from($address);
  249. $this->assertFalse($mailable->hasFrom(new MailableTestUserStub));
  250. $this->assertFalse($mailable->hasFrom($address));
  251. }
  252. }
  253. public function testItIgnoresDuplicatedRawAttachments()
  254. {
  255. $mailable = new WelcomeMailableStub;
  256. $mailable->attachData('content1', 'report-1.txt');
  257. $this->assertCount(1, $mailable->rawAttachments);
  258. $mailable->attachData('content2', 'report-2.txt');
  259. $this->assertCount(2, $mailable->rawAttachments);
  260. $mailable->attachData('content1', 'report-1.txt');
  261. $mailable->attachData('content2', 'report-2.txt');
  262. $this->assertCount(2, $mailable->rawAttachments);
  263. $mailable->attachData('content1', 'report-3.txt');
  264. $mailable->attachData('content2', 'report-4.txt');
  265. $this->assertCount(4, $mailable->rawAttachments);
  266. $this->assertSame([
  267. [
  268. 'data' => 'content1',
  269. 'name' => 'report-1.txt',
  270. 'options' => [],
  271. ],
  272. [
  273. 'data' => 'content2',
  274. 'name' => 'report-2.txt',
  275. 'options' => [],
  276. ],
  277. [
  278. 'data' => 'content1',
  279. 'name' => 'report-3.txt',
  280. 'options' => [],
  281. ],
  282. [
  283. 'data' => 'content2',
  284. 'name' => 'report-4.txt',
  285. 'options' => [],
  286. ],
  287. ], $mailable->rawAttachments);
  288. }
  289. public function testItIgnoresDuplicateStorageAttachments()
  290. {
  291. $mailable = new WelcomeMailableStub;
  292. $mailable->attachFromStorageDisk('disk1', 'sample/file.txt');
  293. $this->assertCount(1, $mailable->diskAttachments);
  294. $mailable->attachFromStorageDisk('disk1', 'sample/file2.txt');
  295. $this->assertCount(2, $mailable->diskAttachments);
  296. $mailable->attachFromStorageDisk('disk1', 'sample/file.txt', 'file.txt');
  297. $mailable->attachFromStorageDisk('disk1', 'sample/file2.txt');
  298. $this->assertCount(2, $mailable->diskAttachments);
  299. $mailable->attachFromStorageDisk('disk2', 'sample/file.txt', 'file.txt');
  300. $mailable->attachFromStorageDisk('disk2', 'sample/file2.txt');
  301. $this->assertCount(4, $mailable->diskAttachments);
  302. $mailable->attachFromStorageDisk('disk1', 'sample/file.txt', 'custom.txt');
  303. $this->assertCount(5, $mailable->diskAttachments);
  304. $this->assertSame([
  305. [
  306. 'disk' => 'disk1',
  307. 'path' => 'sample/file.txt',
  308. 'name' => 'file.txt',
  309. 'options' => [],
  310. ],
  311. [
  312. 'disk' => 'disk1',
  313. 'path' => 'sample/file2.txt',
  314. 'name' => 'file2.txt',
  315. 'options' => [],
  316. ],
  317. [
  318. 'disk' => 'disk2',
  319. 'path' => 'sample/file.txt',
  320. 'name' => 'file.txt',
  321. 'options' => [],
  322. ],
  323. [
  324. 'disk' => 'disk2',
  325. 'path' => 'sample/file2.txt',
  326. 'name' => 'file2.txt',
  327. 'options' => [],
  328. ],
  329. [
  330. 'disk' => 'disk1',
  331. 'path' => 'sample/file.txt',
  332. 'name' => 'custom.txt',
  333. 'options' => [],
  334. ],
  335. ], $mailable->diskAttachments);
  336. }
  337. public function testMailableBuildsViewData()
  338. {
  339. $mailable = new WelcomeMailableStub;
  340. $mailable->build();
  341. $expected = [
  342. 'first_name' => 'Taylor',
  343. 'lastName' => 'Otwell',
  344. 'framework' => 'Laravel',
  345. ];
  346. $this->assertSame($expected, $mailable->buildViewData());
  347. }
  348. public function testMailerMayBeSet()
  349. {
  350. $mailable = new WelcomeMailableStub;
  351. $mailable->mailer('array');
  352. $mailable = unserialize(serialize($mailable));
  353. $this->assertSame('array', $mailable->mailer);
  354. }
  355. }
  356. class WelcomeMailableStub extends Mailable
  357. {
  358. public $framework = 'Laravel';
  359. protected $version = '5.3';
  360. /**
  361. * Build the message.
  362. *
  363. * @return $this
  364. */
  365. public function build()
  366. {
  367. $this->with('first_name', 'Taylor')
  368. ->withLastName('Otwell');
  369. }
  370. }
  371. class MailableTestUserStub
  372. {
  373. public $name = 'Taylor Otwell';
  374. public $email = 'taylor@laravel.com';
  375. }