meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
plugin:dkim [2024/01/30 15:08] – [Purpose] duncancplugin:dkim [2024/08/18 11:31] (current) – [Generating DKIM for the domain] duncanc
Line 2: Line 2:
  
 ---- plugin ---- ---- plugin ----
 +
 +
 description: Adds DKIM header to emails description: Adds DKIM header to emails
 author     : Duncan  Cameron   author     : Duncan  Cameron  
Line 18: Line 20:
 ===== Purpose ===== ===== Purpose =====
  
-This plugin adds a DKIM header to emails sent by phplist. It simply passes-on the settings fields to phpmailer, which does the actual generation of the DKIM header. If your mail server already adds a DKIM header to outgoing mail then you do not need to use this plugin.+This plugin adds a DKIM header to emails sent by phplist. It simply passes-on the settings fields to phpmailer, which does the actual generation of the DKIM header. If your mail server already adds a DKIM header to outgoing mail then you probably do not need to use this plugin.
  
-You need to create a DKIM private/public key pair, then create a DNS TXT record holding the public key. +The plugin can also be used to generate a DKIM header for the domain of the From address. This can help with DMARC verification as DMARC will fail when the From address is a different domain to that used for DKIM and SPF. Usually the DKIM header is for the domain on which phplist is installed.
  
-You can usually do this using the control panel of your web server. Otherwise you can use this DKIM record generator [[https://easydmarc.com/tools/dkim-record-generator]]+You need to create a DKIM private/public key pair, then create a DNS TXT record holding the public key. You can usually do this using the control panel of your web server. Otherwise you can use this DKIM record generator https://easydmarc.com/tools/dkim-record-generator 
 ===== Installation ===== ===== Installation =====
  
Line 30: Line 32:
  
 ===== Configuration ===== ===== Configuration =====
- 
  
 The plugin adds a section to the Settings page where you can enter The plugin adds a section to the Settings page where you can enter
Line 40: Line 41:
   * the passphrase for the private key file (optional)   * the passphrase for the private key file (optional)
   * whether to include the field values in the DKIM header.   * whether to include the field values in the DKIM header.
 +  * or enter one or more sets of DKIM fields in a text area when you want to use the From address.
  
-You must enter either the private key or the path to a file containing the private key. The private key field takes precedence over the private key path.+==== Generating DKIM header for the domain ==== 
 +You must enter the domain, the selector and either the private key or the path to a file containing the private key. The private key field takes precedence over the private key path.
  
 For example, if the name of your DKIM record is ''default._domainkey.mydomain.com'' then For example, if the name of your DKIM record is ''default._domainkey.mydomain.com'' then
Line 57: Line 60:
 </code> </code>
  
 +==== Generating DKIM header for the From address ====
 +
 +The section on the Settings page has a text area where you can enter the domain, the selector and the private key for one more domains that you will be using as the From address for campaigns. Each set of fields must be separated by a blank line.
 +<code>
 +othersite1.com
 +phplist
 +-----BEGIN RSA PRIVATE KEY-----
 +MIICXQIBAAKBgQDY0g55Ks4QWc1JyiwdMDIKV9NpQzk5aDhIpD5boaKu80C3WrIy
 +...
 +MLumvW5nNkpiQbvwx3SnlKM3RCLU1rUARePSnSnsYY56
 +-----END RSA PRIVATE KEY-----
 +
 +othersite2.com
 +phplist
 +-----BEGIN RSA PRIVATE KEY-----
 +MIICXQIBAAKBgQDY0g55Ks4QWc1JyiwdMDIKV9NpQzk5aDhIpD5boaKu80C3WrIy
 +...
 +MLumvW5nNkpiQbvwx3SnlKM3RCLU1rUARePSnSnsYY56
 +-----END RSA PRIVATE KEY-----
 +</code>
 +
 +The plugin will use the domain of the From address to choose the selector and private key for generating the DKIM header. If the From domain is not found then a DKIM header for the domain will be generated.