php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-29 22:21:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

'yii\mail\MessageInterface' file related methods interface adjusted to use options, embed file methods added.

Browse Source
This commit is contained in:
Paul Klimov
2013-10-29 14:06:16 +02:00
parent 35429fbd44
commit 774c4db860
5 changed files with 170 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
framework/yii/mail/BaseMessage.php
View File

@@ -50,24 +50,6 @@ abstract class BaseMessage extends Object implements MessageInterface
return $this->getMailer()->send($this);
}
/**
* @inheritdoc
*/
public function attachFile($fileName, $contentType = null, $attachFileName = null)
{
if (!file_exists($fileName)) {
throw new InvalidParamException('Unable to attach file "' . $fileName . '": file does not exists!');
}
if (empty($contentType)) {
$contentType = FileHelper::getMimeType($fileName);
}
if (empty($attachFileName)) {
$attachFileName = basename($fileName);
}
$content = file_get_contents($fileName);
$this->attachContentAsFile($content, $attachFileName, $contentType);
}
/**
* @inheritdoc
*/

36
framework/yii/mail/MessageInterface.php
View File

@@ -84,18 +84,42 @@ interface MessageInterface
/**
* Attach specified content as file for the email message.
* @param string $content attachment file content.
* @param string $fileName attachment file name.
* @param string $contentType MIME type of the attachment file, by default 'application/octet-stream' will be used.
* @param array $options options for embed file. Valid options are:
* - fileName: name, which should be used to attach file.
* - contentType: attached file MIME type.
*/
public function attachContentAsFile($content, $fileName, $contentType = 'application/octet-stream');
public function attachContent($content, array $options = []);
/**
* Attaches existing file to the email message.
* @param string $fileName full file name
* @param string $contentType MIME type of the attachment file, if empty it will be suggested automatically.
* @param string $attachFileName name, which should be used for attachment, if empty file base name will be used.
* @param array $options options for embed file. Valid options are:
* - fileName: name, which should be used to attach file.
* - contentType: attached file MIME type.
*/
public function attachFile($fileName, $contentType = null, $attachFileName = null);
public function attachFile($fileName, array $options = []);
/**
* Attach a file and return it's CID source.
* This method should be used when embedding images or other data in a message.
* @param string $fileName file name.
* @param array $options options for embed file. Valid options are:
* - fileName: name, which should be used to attach file.
* - contentType: attached file MIME type.
* @return string attachment CID.
*/
public function embedFile($fileName, array $options = []);
/**
* Attach a content as file and return it's CID source.
* This method should be used when embedding images or other data in a message.
* @param string $content attachment file content.
* @param array $options options for embed file. Valid options are:
* - fileName: name, which should be used to attach file.
* - contentType: attached file MIME type.
* @return string attachment CID.
*/
public function embedContent($content, array $options = []);
/**
* Sends this email message.