Adds cool mailing functionality to Concrete5.
What is this
This a package made to made the developer's life a little bit easier and the customer a little bit happier.
What is this NOT
This a not an idiot-proof tool. Although it makes certain things easy, you can screw up one or two things if you are not careful. Nothing too dangerous.
1.0
- Concrete5 5.7 beta 1 or higher
__This is a Concrete 5.7 addon. For the Concrete 5.6 compatible version, please see C5Mailer package __
Download in Packages folder and install from dashboard.
Load the Mailer helper
//Load the Mailer helper
$mailer = Loader::helper('mailer','c5mailer');
Specify which template to use
//Specify the Page name to be used as template
$mailer->setMailTemplate( 'Demo Basic Template' );
//Or: Use the collection ID, if known
$mailer->setPageID( 139 );
//Or: Use the collection
$mailer->setPage( $page );
Optional: Set the sender. Fallback: the global defined one will be used
$mailer->setSender( 'system@c5.com', 'Auto Robots' );
$mailer->setSender( 'system@c5.com' ); //name is optional
Optional: Set reply to
$mailer->setReplyTo( 'real-person@c5.com', 'Real Human' );
$mailer->setReplyTo( 'real-person@c5.com' ); //name is optional
Required: Set the receiver
$mailer->setReceiver( 'john@doe.com', 'John Doe' );
$mailer->setReceiver( 'john@doe.com' ); //name is optional
Optional: set the subject. Fallback: the page description will be used
$mailer->setSubject( 'Catchy Email Subject' );
//email var can be used in subject as well
$mailer->setSubject( 'Catchy Email Subject For %username%' );
Optional: add the replacements array
$mailer->setReplacements(array(
'username' => 'John Doe',
'another_var' => 'Lorem Ipsum',
));
Optional: add attachments
//By File Path
$mailer->attachFileByPath( '/tmp/Comp_2.jpg' );
$mailer->attachFileByPath( '/tmp/Comp_2.jpg', 'nice_name.jpg' ); //name is optional
//And/Or Using a Concrete5 File
$mailer->attachFile( File::getByID(3) );
//And/Or Using a Concrete5 FileID
$mailer->attachFileByID( 4 );
Send the email
$mailer->send();
(C) Copyright Stefan Fodor(stefan@unserialized.dk) @ 2014
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Software built with love in Denmark.