platform/api/laravel/Mail/MailManager.yaml
2024-09-02 10:44:11 -07:00

493 lines
12 KiB
YAML

name: MailManager
class_comment: '# * @mixin \Illuminate\Mail\Mailer'
dependencies:
- name: SesClient
type: class
source: Aws\Ses\SesClient
- name: SesV2Client
type: class
source: Aws\SesV2\SesV2Client
- name: Closure
type: class
source: Closure
- name: FactoryContract
type: class
source: Illuminate\Contracts\Mail\Factory
- name: LogManager
type: class
source: Illuminate\Log\LogManager
- name: ArrayTransport
type: class
source: Illuminate\Mail\Transport\ArrayTransport
- name: LogTransport
type: class
source: Illuminate\Mail\Transport\LogTransport
- name: ResendTransport
type: class
source: Illuminate\Mail\Transport\ResendTransport
- name: SesTransport
type: class
source: Illuminate\Mail\Transport\SesTransport
- name: SesV2Transport
type: class
source: Illuminate\Mail\Transport\SesV2Transport
- name: Arr
type: class
source: Illuminate\Support\Arr
- name: ConfigurationUrlParser
type: class
source: Illuminate\Support\ConfigurationUrlParser
- name: Str
type: class
source: Illuminate\Support\Str
- name: InvalidArgumentException
type: class
source: InvalidArgumentException
- name: LoggerInterface
type: class
source: Psr\Log\LoggerInterface
- name: Resend
type: class
source: Resend
- name: HttpClient
type: class
source: Symfony\Component\HttpClient\HttpClient
- name: MailgunTransportFactory
type: class
source: Symfony\Component\Mailer\Bridge\Mailgun\Transport\MailgunTransportFactory
- name: PostmarkTransportFactory
type: class
source: Symfony\Component\Mailer\Bridge\Postmark\Transport\PostmarkTransportFactory
- name: Dsn
type: class
source: Symfony\Component\Mailer\Transport\Dsn
- name: FailoverTransport
type: class
source: Symfony\Component\Mailer\Transport\FailoverTransport
- name: RoundRobinTransport
type: class
source: Symfony\Component\Mailer\Transport\RoundRobinTransport
- name: SendmailTransport
type: class
source: Symfony\Component\Mailer\Transport\SendmailTransport
- name: EsmtpTransport
type: class
source: Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport
- name: EsmtpTransportFactory
type: class
source: Symfony\Component\Mailer\Transport\Smtp\EsmtpTransportFactory
- name: SocketStream
type: class
source: Symfony\Component\Mailer\Transport\Smtp\Stream\SocketStream
properties:
- name: app
visibility: protected
comment: '# * @mixin \Illuminate\Mail\Mailer
# */
# class MailManager implements FactoryContract
# {
# /**
# * The application instance.
# *
# * @var \Illuminate\Contracts\Foundation\Application'
- name: mailers
visibility: protected
comment: '# * The array of resolved mailers.
# *
# * @var array'
- name: customCreators
visibility: protected
comment: '# * The registered custom driver creators.
# *
# * @var array'
methods:
- name: __construct
visibility: public
parameters:
- name: app
comment: "# * @mixin \\Illuminate\\Mail\\Mailer\n# */\n# class MailManager implements\
\ FactoryContract\n# {\n# /**\n# * The application instance.\n# *\n# * @var \\\
Illuminate\\Contracts\\Foundation\\Application\n# */\n# protected $app;\n# \n\
# /**\n# * The array of resolved mailers.\n# *\n# * @var array\n# */\n# protected\
\ $mailers = [];\n# \n# /**\n# * The registered custom driver creators.\n# *\n\
# * @var array\n# */\n# protected $customCreators = [];\n# \n# /**\n# * Create\
\ a new Mail manager instance.\n# *\n# * @param \\Illuminate\\Contracts\\Foundation\\\
Application $app\n# * @return void"
- name: mailer
visibility: public
parameters:
- name: name
default: 'null'
comment: '# * Get a mailer instance by name.
# *
# * @param string|null $name
# * @return \Illuminate\Contracts\Mail\Mailer'
- name: driver
visibility: public
parameters:
- name: driver
default: 'null'
comment: '# * Get a mailer driver instance.
# *
# * @param string|null $driver
# * @return \Illuminate\Mail\Mailer'
- name: get
visibility: protected
parameters:
- name: name
comment: '# * Attempt to get the mailer from the local cache.
# *
# * @param string $name
# * @return \Illuminate\Mail\Mailer'
- name: resolve
visibility: protected
parameters:
- name: name
comment: '# * Resolve the given mailer.
# *
# * @param string $name
# * @return \Illuminate\Mail\Mailer
# *
# * @throws \InvalidArgumentException'
- name: createSymfonyTransport
visibility: public
parameters:
- name: config
comment: '# * Create a new transport instance.
# *
# * @param array $config
# * @return \Symfony\Component\Mailer\Transport\TransportInterface
# *
# * @throws \InvalidArgumentException'
- name: createSmtpTransport
visibility: protected
parameters:
- name: config
comment: '# * Create an instance of the Symfony SMTP Transport driver.
# *
# * @param array $config
# * @return \Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport'
- name: configureSmtpTransport
visibility: protected
parameters:
- name: transport
- name: config
comment: '# * Configure the additional SMTP driver options.
# *
# * @param \Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport $transport
# * @param array $config
# * @return \Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport'
- name: createSendmailTransport
visibility: protected
parameters:
- name: config
comment: '# * Create an instance of the Symfony Sendmail Transport driver.
# *
# * @param array $config
# * @return \Symfony\Component\Mailer\Transport\SendmailTransport'
- name: createSesTransport
visibility: protected
parameters:
- name: config
comment: '# * Create an instance of the Symfony Amazon SES Transport driver.
# *
# * @param array $config
# * @return \Illuminate\Mail\Transport\SesTransport'
- name: createSesV2Transport
visibility: protected
parameters:
- name: config
comment: '# * Create an instance of the Symfony Amazon SES V2 Transport driver.
# *
# * @param array $config
# * @return \Illuminate\Mail\Transport\SesV2Transport'
- name: addSesCredentials
visibility: protected
parameters:
- name: config
comment: '# * Add the SES credentials to the configuration array.
# *
# * @param array $config
# * @return array'
- name: createResendTransport
visibility: protected
parameters:
- name: config
comment: '# * Create an instance of the Resend Transport driver.
# *
# * @param array $config
# * @return \Illuminate\Mail\Transport\ResendTransprot'
- name: createMailTransport
visibility: protected
parameters: []
comment: '# * Create an instance of the Symfony Mail Transport driver.
# *
# * @return \Symfony\Component\Mailer\Transport\SendmailTransport'
- name: createMailgunTransport
visibility: protected
parameters:
- name: config
comment: '# * Create an instance of the Symfony Mailgun Transport driver.
# *
# * @param array $config
# * @return \Symfony\Component\Mailer\Transport\TransportInterface'
- name: createPostmarkTransport
visibility: protected
parameters:
- name: config
comment: '# * Create an instance of the Symfony Postmark Transport driver.
# *
# * @param array $config
# * @return \Symfony\Component\Mailer\Bridge\Postmark\Transport\PostmarkApiTransport'
- name: createFailoverTransport
visibility: protected
parameters:
- name: config
comment: '# * Create an instance of the Symfony Failover Transport driver.
# *
# * @param array $config
# * @return \Symfony\Component\Mailer\Transport\FailoverTransport'
- name: createRoundrobinTransport
visibility: protected
parameters:
- name: config
comment: '# * Create an instance of the Symfony Roundrobin Transport driver.
# *
# * @param array $config
# * @return \Symfony\Component\Mailer\Transport\RoundRobinTransport'
- name: createLogTransport
visibility: protected
parameters:
- name: config
comment: '# * Create an instance of the Log Transport driver.
# *
# * @param array $config
# * @return \Illuminate\Mail\Transport\LogTransport'
- name: createArrayTransport
visibility: protected
parameters: []
comment: '# * Create an instance of the Array Transport Driver.
# *
# * @return \Illuminate\Mail\Transport\ArrayTransport'
- name: getHttpClient
visibility: protected
parameters:
- name: config
comment: '# * Get a configured Symfony HTTP client instance.
# *
# * @return \Symfony\Contracts\HttpClient\HttpClientInterface|null'
- name: setGlobalAddress
visibility: protected
parameters:
- name: mailer
- name: config
- name: type
comment: '# * Set a global address on the mailer by type.
# *
# * @param \Illuminate\Mail\Mailer $mailer
# * @param array $config
# * @param string $type
# * @return void'
- name: getConfig
visibility: protected
parameters:
- name: name
comment: '# * Get the mail connection configuration.
# *
# * @param string $name
# * @return array'
- name: getDefaultDriver
visibility: public
parameters: []
comment: '# * Get the default mail driver name.
# *
# * @return string'
- name: setDefaultDriver
visibility: public
parameters:
- name: name
comment: '# * Set the default mail driver name.
# *
# * @param string $name
# * @return void'
- name: purge
visibility: public
parameters:
- name: name
default: 'null'
comment: '# * Disconnect the given mailer and remove from local cache.
# *
# * @param string|null $name
# * @return void'
- name: extend
visibility: public
parameters:
- name: driver
- name: callback
comment: '# * Register a custom transport creator Closure.
# *
# * @param string $driver
# * @param \Closure $callback
# * @return $this'
- name: getApplication
visibility: public
parameters: []
comment: '# * Get the application instance used by the manager.
# *
# * @return \Illuminate\Contracts\Foundation\Application'
- name: setApplication
visibility: public
parameters:
- name: app
comment: '# * Set the application instance used by the manager.
# *
# * @param \Illuminate\Contracts\Foundation\Application $app
# * @return $this'
- name: forgetMailers
visibility: public
parameters: []
comment: '# * Forget all of the resolved mailer instances.
# *
# * @return $this'
- name: __call
visibility: public
parameters:
- name: method
- name: parameters
comment: '# * Dynamically call the default driver instance.
# *
# * @param string $method
# * @param array $parameters
# * @return mixed'
traits:
- Aws\Ses\SesClient
- Aws\SesV2\SesV2Client
- Closure
- Illuminate\Log\LogManager
- Illuminate\Mail\Transport\ArrayTransport
- Illuminate\Mail\Transport\LogTransport
- Illuminate\Mail\Transport\ResendTransport
- Illuminate\Mail\Transport\SesTransport
- Illuminate\Mail\Transport\SesV2Transport
- Illuminate\Support\Arr
- Illuminate\Support\ConfigurationUrlParser
- Illuminate\Support\Str
- InvalidArgumentException
- Psr\Log\LoggerInterface
- Resend
- Symfony\Component\HttpClient\HttpClient
- Symfony\Component\Mailer\Bridge\Mailgun\Transport\MailgunTransportFactory
- Symfony\Component\Mailer\Bridge\Postmark\Transport\PostmarkTransportFactory
- Symfony\Component\Mailer\Transport\Dsn
- Symfony\Component\Mailer\Transport\FailoverTransport
- Symfony\Component\Mailer\Transport\RoundRobinTransport
- Symfony\Component\Mailer\Transport\SendmailTransport
- Symfony\Component\Mailer\Transport\Smtp\EsmtpTransport
- Symfony\Component\Mailer\Transport\Smtp\EsmtpTransportFactory
- Symfony\Component\Mailer\Transport\Smtp\Stream\SocketStream
interfaces:
- FactoryContract