Mailgun\Messages\MessageBuilder::addInlineImage PHP Method

addInlineImage() public method

public addInlineImage ( string $inlineImagePath, string | null $inlineImageName = null ) : boolean
$inlineImagePath string
$inlineImageName string | null
return boolean
    public function addInlineImage($inlineImagePath, $inlineImageName = null)
    {
        if (strpos($inlineImagePath, '@') !== 0) {
            throw new InvalidParameter(ExceptionMessages::INVALID_PARAMETER_INLINE);
        }
        $this->files['inline'][] = ['filePath' => $inlineImagePath, 'remoteName' => $inlineImageName];
        return true;
    }

Usage Example

Example #1
0
 /**
  * Embed a file in the message and get the CID.
  *
  * @param string $path
  * @param string $name
  *
  * @return string
  */
 public function embed($path, $name = null)
 {
     $name = $name ?: basename($path);
     $this->messageBuilder->addInlineImage("@{$path}", $name);
     return "cid:{$name}";
 }