Mail.php 5.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. <?php
  2. namespace Illuminate\Support\Facades;
  3. use Illuminate\Support\Testing\Fakes\MailFake;
  4. /**
  5. * @method static \Illuminate\Contracts\Mail\Mailer mailer(string|null $name = null)
  6. * @method static \Illuminate\Mail\Mailer driver(string|null $driver = null)
  7. * @method static \Illuminate\Mail\Mailer build(array $config)
  8. * @method static \Symfony\Component\Mailer\Transport\TransportInterface createSymfonyTransport(array $config)
  9. * @method static string getDefaultDriver()
  10. * @method static void setDefaultDriver(string $name)
  11. * @method static void purge(string|null $name = null)
  12. * @method static \Illuminate\Mail\MailManager extend(string $driver, \Closure $callback)
  13. * @method static \Illuminate\Contracts\Foundation\Application getApplication()
  14. * @method static \Illuminate\Mail\MailManager setApplication(\Illuminate\Contracts\Foundation\Application $app)
  15. * @method static \Illuminate\Mail\MailManager forgetMailers()
  16. * @method static void alwaysFrom(string $address, string|null $name = null)
  17. * @method static void alwaysReplyTo(string $address, string|null $name = null)
  18. * @method static void alwaysReturnPath(string $address)
  19. * @method static void alwaysTo(string $address, string|null $name = null)
  20. * @method static \Illuminate\Mail\PendingMail to(mixed $users, string|null $name = null)
  21. * @method static \Illuminate\Mail\PendingMail cc(mixed $users, string|null $name = null)
  22. * @method static \Illuminate\Mail\PendingMail bcc(mixed $users, string|null $name = null)
  23. * @method static \Illuminate\Mail\SentMessage|null html(string $html, mixed $callback)
  24. * @method static \Illuminate\Mail\SentMessage|null raw(string $text, mixed $callback)
  25. * @method static \Illuminate\Mail\SentMessage|null plain(string $view, array $data, mixed $callback)
  26. * @method static string render(string|array $view, array $data = [])
  27. * @method static \Illuminate\Mail\SentMessage|null send(\Illuminate\Contracts\Mail\Mailable|string|array $view, array $data = [], \Closure|string|null $callback = null)
  28. * @method static \Illuminate\Mail\SentMessage|null sendNow(\Illuminate\Contracts\Mail\Mailable|string|array $mailable, array $data = [], \Closure|string|null $callback = null)
  29. * @method static mixed queue(\Illuminate\Contracts\Mail\Mailable $view, \BackedEnum|string|null $queue = null)
  30. * @method static mixed onQueue(\BackedEnum|string|null $queue, \Illuminate\Contracts\Mail\Mailable $view)
  31. * @method static mixed queueOn(string $queue, \Illuminate\Contracts\Mail\Mailable $view)
  32. * @method static mixed later(\DateTimeInterface|\DateInterval|int $delay, \Illuminate\Contracts\Mail\Mailable $view, string|null $queue = null)
  33. * @method static mixed laterOn(string $queue, \DateTimeInterface|\DateInterval|int $delay, \Illuminate\Contracts\Mail\Mailable $view)
  34. * @method static \Symfony\Component\Mailer\Transport\TransportInterface getSymfonyTransport()
  35. * @method static \Illuminate\Contracts\View\Factory getViewFactory()
  36. * @method static void setSymfonyTransport(\Symfony\Component\Mailer\Transport\TransportInterface $transport)
  37. * @method static \Illuminate\Mail\Mailer setQueue(\Illuminate\Contracts\Queue\Factory $queue)
  38. * @method static void macro(string $name, object|callable $macro)
  39. * @method static void mixin(object $mixin, bool $replace = true)
  40. * @method static bool hasMacro(string $name)
  41. * @method static void flushMacros()
  42. * @method static void assertSent(string|\Closure $mailable, callable|array|string|int|null $callback = null)
  43. * @method static void assertNotOutgoing(string|\Closure $mailable, callable|null $callback = null)
  44. * @method static void assertNotSent(string|\Closure $mailable, callable|array|string|null $callback = null)
  45. * @method static void assertNothingOutgoing()
  46. * @method static void assertNothingSent()
  47. * @method static void assertQueued(string|\Closure $mailable, callable|array|string|int|null $callback = null)
  48. * @method static void assertNotQueued(string|\Closure $mailable, callable|array|string|null $callback = null)
  49. * @method static void assertNothingQueued()
  50. * @method static void assertSentCount(int $count)
  51. * @method static void assertQueuedCount(int $count)
  52. * @method static void assertOutgoingCount(int $count)
  53. * @method static \Illuminate\Support\Collection sent(string|\Closure $mailable, callable|null $callback = null)
  54. * @method static bool hasSent(string $mailable)
  55. * @method static \Illuminate\Support\Collection queued(string|\Closure $mailable, callable|null $callback = null)
  56. * @method static bool hasQueued(string $mailable)
  57. *
  58. * @see \Illuminate\Mail\MailManager
  59. * @see \Illuminate\Support\Testing\Fakes\MailFake
  60. */
  61. class Mail extends Facade
  62. {
  63. /**
  64. * Replace the bound instance with a fake.
  65. *
  66. * @return \Illuminate\Support\Testing\Fakes\MailFake
  67. */
  68. public static function fake()
  69. {
  70. $actualMailManager = static::isFake()
  71. ? static::getFacadeRoot()->manager
  72. : static::getFacadeRoot();
  73. return tap(new MailFake($actualMailManager), function ($fake) {
  74. static::swap($fake);
  75. });
  76. }
  77. /**
  78. * Get the registered name of the component.
  79. *
  80. * @return string
  81. */
  82. protected static function getFacadeAccessor()
  83. {
  84. return 'mail.manager';
  85. }
  86. }