N°4307 Replace SwiftMailer with Laminas-mail

lib/laminas/laminas-mail/src/Storage/Part/PartInterface.php

@@ -0,0 +1,123 @@
+<?php
+
+/**
+ * @see       https://github.com/laminas/laminas-mail for the canonical source repository
+ * @copyright https://github.com/laminas/laminas-mail/blob/master/COPYRIGHT.md
+ * @license   https://github.com/laminas/laminas-mail/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Laminas\Mail\Storage\Part;
+
+use ArrayIterator;
+use Laminas\Mail\Header\HeaderInterface;
+use Laminas\Mail\Headers;
+use RecursiveIterator;
+
+interface PartInterface extends RecursiveIterator
+{
+    /**
+     * Check if part is a multipart message
+     *
+     * @return bool if part is multipart
+     */
+    public function isMultipart();
+
+    /**
+     * Body of part
+     *
+     * If part is multipart the raw content of this part with all sub parts is
+     * returned.
+     *
+     * @return string body
+     * @throws Exception\ExceptionInterface
+     */
+    public function getContent();
+
+    /**
+     * Return size of part
+     *
+     * @return int size
+     */
+    public function getSize();
+
+    /**
+     * Get part of multipart message
+     *
+     * @param  int $num number of part starting with 1 for first part
+     * @return PartInterface wanted part
+     * @throws Exception\ExceptionInterface
+     */
+    public function getPart($num);
+
+    /**
+     * Count parts of a multipart part
+     *
+     * @return int number of sub-parts
+     */
+    public function countParts();
+
+    /**
+     * Get all headers
+     *
+     * The returned headers are as saved internally. All names are lowercased.
+     * The value is a string or an array if a header with the same name occurs
+     * more than once.
+     *
+     * @return Headers
+     */
+    public function getHeaders();
+
+    /**
+     * Get a header in specified format
+     *
+     * Internally headers that occur more than once are saved as array, all
+     * other as string. If $format is set to string implode is used to concat
+     * the values (with Laminas\Mime\Mime::LINEEND as delim).
+     *
+     * @param string $name name of header, matches case-insensitive, but
+     *     camel-case is replaced with dashes
+     * @param string $format change type of return value to 'string' or 'array'
+     * @return string|array|HeaderInterface|ArrayIterator value of header in
+     *     wanted or internal format
+     * @throws Exception\ExceptionInterface
+     */
+    public function getHeader($name, $format = null);
+
+    /**
+     * Get a specific field from a header like content type or all fields as array
+     *
+     * If the header occurs more than once, only the value from the first
+     * header is returned.
+     *
+     * Throws an exception if the requested header does not exist. If the
+     * specific header field does not exist, returns null.
+     *
+     * @param string $name name of header, like in getHeader()
+     * @param string $wantedPart the wanted part, default is first, if null an
+     *     array with all parts is returned
+     * @param string $firstName key name for the first part
+     * @return string|array wanted part or all parts as
+     *     [$firstName => firstPart, partname => value]
+     * @throws Exception\ExceptionInterface
+     */
+    public function getHeaderField($name, $wantedPart = '0', $firstName = '0');
+
+    /**
+     * Getter for mail headers - name is matched in lowercase
+     *
+     * This getter is short for PartInterface::getHeader($name, 'string')
+     *
+     * @see PartInterface::getHeader()
+     * @param  string $name header name
+     * @return string value of header
+     * @throws Exception\ExceptionInterface
+     */
+    public function __get($name);
+
+    /**
+     * magic method to get content of part
+     *
+     * @return string content
+     */
+    public function __toString();
+}