Issue #3382624: embedFromPath API addition (for #3284140)

src/BaseEmailInterface.php

@@ -228,7 +228,8 @@ interface BaseEmailInterface {
    * @param string $path
    *   The path to the file.
    * @param string|null $name
-   *   (optional) The file name. Defaults to the base name of the path.
+   *   (optional) The file name, which if set must be unique among all
+   *   attachments.
    * @param string|null $mimeType
    *   (optional) The mime type. If omitted, the type will be guessed.
    *
@@ -254,12 +255,21 @@ interface BaseEmailInterface {
    */
   public function attachNoPath(string $body, string $name = NULL, string $mimeType = NULL);
 
-  // @codingStandardsIgnoreStart
   /**
-   * @return $this
+   * Embeds an inline image.
+   *
+   * @param string $path
+   *   The path to the file.
+   * @param string|null $name
+   *   (optional) The file name, which must be unique among all attachments.
+   *   Leave blank to generate a unique name.
+   * @param string|null $mimeType
+   *   (optional) The mime type. If omitted, the type will be guessed.
+   *
+   * @return string|false
+   *   The file name or FALSE if embedding is not allowed for security reasons.
    */
-  // public function embedFromPath(string $path, string $name = null, string $contentType = null);
-  // @codingStandardsIgnoreEnd
+  public function embedFromPath(string $path, string $name = NULL, string $mimeType = NULL);
 
   /**
    * Gets the headers object for getting or setting headers.