• Home
• luya
• components
• Mail

PHP Class luya\components\Mail

This component is registered on each LUYA instance, how to use: php if (Yii::$app->mail->compose('Subject', 'Message body of the Mail'->adress('[email protected]')->send()) { echo "Mail has been sent!"; } else { echo "Error" : Yii::$app->mail->error; } SMTP debug help: swaks -s HOST -p 587 -ehlo localhost -au AUTH_USER -to TO_ADRESSE -tls 显示文件 Open project: luyadev/luya Class Usage Examples

Public Properties

Property	Type	Description
$altBody		alternate text message if email client doesn't support HTML
$debug		enable debug output mode 'Data and commands'
$from		sender email address
$fromName		sender name
$host		email server host address
$isSMTP		disable if you want to use old PHP sendmail
$layout		Define a layout template file which is going to be wrapped around the setBody() content. The file alias will be resolved so an example layout could look as followed: php $layout = '@app/views/maillayout.php'; In your config or any mailer object. As in layouts the content of the mail specific html can be access in the $content variable. The example content of maillayout.php from above could look like this: php My Company
$password		email server password
$port		email server port
$smtpSecure		Posible values are tls or ssl
$username		email server username

Public Methods

Method	Description
address ( string $email, string $name = null ) : Mail	Add a single address with optional name
addresses ( array $emails ) : Mail	Correct spelled alias method for adresses.
adresses ( array $emails ) : Mail	Add multiple addresses into the mailer object.
bccAddress ( string $email, string $name = null ) : Mail	Add a single BCC address with optional name
bccAddresses ( array $emails ) : Mail	Add multiple BCC addresses into the mailer object.
ccAddress ( string $email, string $name = null ) : Mail	Add a single CC address with optional name
ccAddresses ( array $emails ) : Mail	Add multiple CC addresses into the mailer object.
cleanup ( ) : void	Reset the mailer object to null
compose ( string $subject, string $body ) : Mail	Compose a new mail message, this will first flush existing mailer objects
getError ( ) : string	Get the mailer error info if any.
getMailer ( ) : PHPMailer	Getter for the mailer object
send ( ) : boolean	Trigger the send event of the mailer
setBody ( string $body ) : Mail	Set the HTML body for the mailer message, if a layout is defined the layout will automatically wrapped about the html body.
setSubject ( string $subject ) : Mail	Set the mail message subject of the mailer instance
smtpTest ( $verbose )

Protected Methods

Method	Description
wrapLayout ( string $content )	Wrap the layout from the $layout propertie and store the passed content as $content variable in the view.

Method Details

Property Details