Use of the SmtpPlus Module
What it does
SmtpPlus is adding the ability to your Magento Store to use a broader variety of Email Server configurations, and to send a copy of all outgoing messages as BCC (Black-Carbon-Copy) to Email Addresses of your choice.
In addition SmtpPlus is adding events triggered before and after a message is being sent. These events may get used by your own Store code to process any functions before or after a email message is sent.
Configuration
Prerequisites
Enable all Email Communication for your Magento Store, use the following setting regardless if you have it installed on Linux or Windows:
System
» Configuration
» System
:
SmtpPlus Settings
Use this SMTP Server
Set this to Yes
to use the advanced SMTP Server settings, when set to No
the default Magento behaviour for sending Email Messages is used. This allows you to switch between the default Magento way to send Email and the advanced abilities of SmtpPlus without loosing your SmtpPlus settings.
Mode of Operation
Allows to how Email Messages are to be sent directly to the SMTP Server:
- Directly send to SMTP Server will authenticate (if required) with the SMTP Server and send the messages.
- Login to POP/IMAP Server before sending to SMTP Server will login to the POP/IMAP Server configured below prior to sending the messages to the SMTP Server.
- Do not send Emails will prevent Emails to get sent, however they are being processed by SmtpPlus. This may get used for developing on your Store to “virtually” send Emails. In combination with Keep a copy of all sent Emails the Transactional Emails may still get saved for review.
SMTP Server IP or Address
Use a fully qualified IP-Address or Server Domain Name under which your Email Server is accessible.
SMTP Server Port
Define the Port Number on which your SMTP Server is listening for incoming connections. Default is 25
.
SMTP Server Encryption
Select one of the possible encryption types for communication with the Email Server. Use none
for plain and unencrypted communication, SSL
or TLS
for encrypted communication based on the capabilities of your Email Server.
SMTP Username for Authentication
If your Email Server requires Authentication before accepting Email Messages for sending, then define the Username to be used here. Leave the Username (and Password) blank if your Email Server accepts anonymous connections without authentication.
SMTP Password for Authentication
Define the Password here (together with the Username above) to be used for Authentication on your Email Server, in case Authentication is required on your Server.
SMTP Type of Authentication
Allows to select the type of Authentication to be used with your Email Server:
- Plain, Login
Both PLAIN and LOGIN authentication methods are used to log in using Base64 Encoded passwords over non-encrypted communication session. From a security viewpoint Base64 encoded passwords are essentially as vulnerable as plain text, due to decoding being pretty easy, without any whatsoever cryptographic protection. This type of authentication however may well get used on TLS/SSL encrypted connections.
- CRAM-MD5
CRAM-MD5 stands for challenge response authentication mechanism based on HMAC-MD5 MAC algorithm. CRAM-MD5 authentication is used on some types of extended SMTP servers without TLS (Transport Layer Security).
POP/IMAP Server Type
Use this to select your Incoming Mail Server type as POP Server or IMAP Server. This is only required in case you use the Login to POP/IMAP Server before sending to SMTP Server option of Mode of Operation.
POP/IMAP Server IP or Address
POP/IMAP Server Port
POP/IMAP Server Encryption
POP/IMAP Username for Authentication
POP/IMAP Password for Authentication
POP/IMAP Type of Authentication
All of these settings are the exact counterpart for the POP/IMAP Server settings from the SMTP Settings above. These are only required in case you use the Login to POP/IMAP Server before sending to SMTP Server option of Mode of Operation.
Template for New Email Message
Select the Template to be used for New Email Messages from the selection of Transactional Email Templates. Please create the template for New Email Messages prior to first use of SmtpPlus, and select it here.
Send BCC of all messages to Email Address
Add one or more fully qualified Email Addresses here to be added as BCC (Black-Carbon-Copy) recipients on all outgoing Email Messages. Separate multiple Email Addresses with a comma.
This may get used to receive a copy of any outgoing Email Messasge to your own Email Address for monitoring the outgoing messages, without the Email Address being revealed to the original recipients.
Send a copy of messages containing the following Keywords
Add Keywords here which shall trigger a BCC (Black-Carbon-Copy) of the Transactional Email when being found in the Subject Line or the Message Body. Use one Keyword or Keyword sequence per Line.
If you add a Email Address to the Keyword inside of square brackets, then that Email Address is being used for the BCC instead of the default Email Address defined in Send BCC of messages containing above Keywords to Email Address
.
Serialnumber for Order Confirmation[some.email@domain.tld] Shipment Notification
In above example the Keyword Order Confirmation
will trigger a BCC to some.email@domain.tld
where all other Keywords will trigger a BCC to the default Email Address defined in Send BCC of messages containing above Keywords to Email Address
.
Send BCC of messages containing above Keywords to Email Address
Enter the default Email Address where a BCC (Black-Carbon-Copy) of the Email Messages, where one of the above Keywords was found in, shall be sent to. You may use multiple Email Addresses, separated by a colon (',').
Keep a copy of all sent Emails
Set this to Yes if you want SmtpPlus to log all outgoing Email Messages into the Stores Database. When using this option, you will have access to all sent Email Messages in the Administrator, and you may add the sent Email Messages to the Customer Account.
Set this to Yes (with attachments) to also have File Attachments logged that are sent with the Emails, these are then accessible from the logged email message.
Configuration Examples
Here some Configuration Examples for selected Email Servers or Services:
1. Postfix with TLS/SSL
SmtpPlus Configuration Option | Setting |
---|---|
SMTP Server IP or Address | Your Email Server Address (your.server.tld ) |
SMTP Server Port | 25 (for TLS) 465 (for SSL) |
SMTP Server Encryption | TLS (or SSL) |
Username for Authentication | Your Username for Authentication |
Password for Authentication | Your Password for Authentication |
Type of Authentication | Login |
2. GMail - Google Mail
You may want to find the original Google advice for configuring Email Clients useful to, available here...
SmtpPlus Configuration Option | Setting |
---|---|
SMTP Server IP or Address | smtp.gmail.com |
SMTP Server Port | 465 or 587 |
SMTP Server Encryption | TLS |
Username for Authentication | Your full email address (including @gmail.com or @your_domain.com ) |
Password for Authentication | Your Gmail Password |
Type of Authentication | Login |