Sends one e-mail through the mail transport of the installation.
A step of a YAML migration with type: mail. The class expMigrationStepMail (kernel/classes/migration/steps/expmigrationstepmail.php) is registered in settings/migration.ini [StepSettings] StepTypeList[mail].
Keys
| Key | Type | Default | What it is |
|---|---|---|---|
to | list | required | the addresses it goes to |
cc | list | addresses in copy | |
bcc | list | addresses in blind copy | |
subject | string | required | the subject |
body | string | required | the text |
html | bool | false | true: body is HTML |
from | string | the sender (default: site.ini [MailSettings] EmailSender, else AdminEmail) | |
reply_to | string | the address answers go to | |
transport | string | a transport of site.ini [MailSettings] TransportAlias (file, sendmail, smtp) for this mail only | |
category | string | "admin" | the mail category of mailpreferences.ini; an optional one reaches only the recipients whose preferences allow it |
Besides these, every step takes the keys of the engine: type, mode, if, references, environments, engines and comment (the file format). A key of type identifier names a node, an object or another part of the installation by id, remote id, path or name (identifiers).
Values for references
references: { <name>: <value> } keeps a value of the step's result as ${ref.<name>} for the steps and migrations after it:
| Value | What it is |
|---|---|
recipients | how many addresses it went to |
Undoing
A step of this type does not undo itself: a migration with it needs down: or a rollback to its caption.
It touches no cache.
Example
- type: mail
to: [ [email protected] ]
subject: The news section has a new class
body: "From today on, news items have a teaser image."Related
Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstepmail.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.