modUser.sendEmail

modUser::sendEmail¶

Sends a mail to the email of the related profile, with fullname as display name. $message is the body only; reply-to follows the sender.

The method returns false without a modX instance, without a profile, or when the mail service will not load. Otherwise it returns the result of the send; failures go to the error log and the mail object is reset.

Syntax¶

boolean sendEmail (string $message [, array $options = array()])

• $message (string) Body of the mail.
• $options (array) Overrides for from, fromName, sender, subject and html; from and sender fall back to emailsender, fromName to site_name, subject to the emailsubject lexicon entry and html to true, by default array().

Example¶

$user->sendEmail('Hello staff', array(
    'subject' => 'Welcome',
    'html' => false,
));

See Also¶

• modUser
• emailsender
• site_name