fix static-analysis error and formatting code

Signed-off-by: Bennet Becker <[email protected]>

lib/private/Mail/Message.php

@@ -307,18 +307,23 @@ public function useTemplate(IEMailTemplate $emailTemplate): IMessage {
 	 * Add the Auto-Submitted header to the email, preventing most automated
 	 * responses to automated messages.
 	 *
-	 * @param string $value (one of AutoSubmittedValue::NO, AutoSubmittedValue::AUTO_GENERATED, AutoSubmittedValue::AUTO_REPLIED)
+	 * @param AutoSubmittedValue::* $value (one of AutoSubmittedValue::NO, AutoSubmittedValue::AUTO_GENERATED, AutoSubmittedValue::AUTO_REPLIED)
 	 * @return $this
 	 */
 	public function setAutoSubmitted(string $value): IMessage {
 		$headers = $this->swiftMessage->getHeaders();
-		if($headers->has('Auto-Submitted')) {
-			$auto_submitted = $headers->get('Auto-Submitted');
-			$auto_submitted->setValue($value);
-		} else {
-			$headers->addTextHeader('Auto-Submitted', $value);
+
+		if ($headers->has('Auto-Submitted')) {
+			// if the header already exsists, remove it.
+			// the value can be modified with some implementations
+			// of the interface \Swift_Mime_Header, however the
+			// interface doesn't, and this makes the static-code
+			// analysis unhappy.
+			$headers->remove('Auto-Submitted');
 		}
 
+		$headers->addTextHeader('Auto-Submitted', $value);
+
 		return $this;
 	}
 

tests/lib/Mail/MessageTest.php

@@ -8,7 +8,6 @@
 
 namespace Test\Mail;
 
-use Egulias\EmailValidator\EmailValidator;
 use OC\Mail\Message;
 use OCP\Mail\AutoSubmittedValue;
 use OCP\Mail\IEMailTemplate;
@@ -267,119 +266,88 @@ public function testBothRenderingOptions() {
 	}
 
 	public function testSetAutoSubmitted1() {
-
 		$swiftMimeSimpleHeaderSet = $this->getMockBuilder('\Swift_Mime_SimpleHeaderSet')
 			->disableOriginalConstructor()
 			->getMock();
-
 		$swiftMessage = $this->getMockBuilder('\Swift_Message')
 			->disableOriginalConstructor()
 			->disableOriginalClone()
 			->disableArgumentCloning()
 			->disallowMockingUnknownTypes()
 			->getMock();
 
-
 		$swiftMessage->method('getHeaders')->willReturn($swiftMimeSimpleHeaderSet);
 
 		$swiftMimeSimpleHeaderSet->expects($this->once())
 			->method('has')
 			->with('Auto-Submitted');
-
 		$swiftMimeSimpleHeaderSet->expects($this->never())
-			->method('get');
-
+			->method('remove');
 		$swiftMimeSimpleHeaderSet->expects($this->once())
 			->method('addTextHeader')
 			->with('Auto-Submitted', AutoSubmittedValue::AUTO_GENERATED);
 
 		$message = new Message($swiftMessage, false);
-
 		$message->setAutoSubmitted(AutoSubmittedValue::AUTO_GENERATED);
-
 	}
 
 	public function testSetAutoSubmitted2() {
-
-		$swiftMimeHeader = $this->getMockBuilder('\Swift_Mime_Header')
-			->disableOriginalConstructor()
-			->addMethods(['setValue'])
-			->getMockForAbstractClass();
-
 		$swiftMimeSimpleHeaderSet = $this->getMockBuilder('\Swift_Mime_SimpleHeaderSet')
 			->disableOriginalConstructor()
 			->getMock();
-
 		$swiftMessage = $this->getMockBuilder('\Swift_Message')
 			->disableOriginalConstructor()
 			->disableOriginalClone()
 			->disableArgumentCloning()
 			->disallowMockingUnknownTypes()
 			->getMock();
 
-
 		$swiftMessage->method('getHeaders')->willReturn($swiftMimeSimpleHeaderSet);
-		$swiftMimeSimpleHeaderSet->method('get')->with("Auto-Submitted")->willReturn($swiftMimeHeader);
-
 
 		$swiftMimeSimpleHeaderSet->expects($this->once())
 			->method('has')
 			->with('Auto-Submitted')
 			->willReturn(true);
-
 		$swiftMimeSimpleHeaderSet->expects($this->once())
-			->method('get');
-
-		$swiftMimeSimpleHeaderSet->expects($this->never())
+			->method('remove')
+			->with('Auto-Submitted');
+		$swiftMimeSimpleHeaderSet->expects($this->once())
 			->method('addTextHeader')
 			->with('Auto-Submitted', AutoSubmittedValue::AUTO_GENERATED);
 
-		$swiftMimeHeader->expects($this->once())
-			->method('setValue')
-			->with(AutoSubmittedValue::AUTO_GENERATED);
-
 		$message = new Message($swiftMessage, false);
-
 		$message->setAutoSubmitted(AutoSubmittedValue::AUTO_GENERATED);
 	}
 
 	public function testGetAutoSubmitted1() {
-
 		$swiftMimeSimpleHeaderSet = $this->getMockBuilder('\Swift_Mime_SimpleHeaderSet')
 			->disableOriginalConstructor()
 			->getMock();
-
 		$swiftMessage = $this->getMockBuilder('\Swift_Message')
 			->disableOriginalConstructor()
 			->disableOriginalClone()
 			->disableArgumentCloning()
 			->disallowMockingUnknownTypes()
 			->getMock();
 
-
 		$swiftMessage->method('getHeaders')->willReturn($swiftMimeSimpleHeaderSet);
 
 		$swiftMimeSimpleHeaderSet->expects($this->once())
 			->method('has')
 			->with('Auto-Submitted');
-
 		$swiftMimeSimpleHeaderSet->expects($this->never())
 			->method('get');
 
 		$message = new Message($swiftMessage, false);
-
 		$this->assertSame("no", $message->getAutoSubmitted());
 	}
 	public function testGetAutoSubmitted2() {
-
 		$swiftMimeHeader = $this->getMockBuilder('\Swift_Mime_Header')
 			->disableOriginalConstructor()
 			->getMockForAbstractClass();
-
 		$swiftMimeSimpleHeaderSet = $this->getMockBuilder('\Swift_Mime_SimpleHeaderSet')
 			->disableOriginalConstructor()
 			->getMock();
-
 		$swiftMessage = $this->getMockBuilder('\Swift_Message')
 			->disableOriginalConstructor()
 			->disableOriginalClone()
@@ -395,14 +363,11 @@ public function testGetAutoSubmitted2() {
 			->method('has')
 			->with('Auto-Submitted')
 			->willReturn(true);
-
 		$swiftMimeSimpleHeaderSet->expects($this->once())
 			->method('get')
 			->willReturn($swiftMimeHeader);
 
 		$message = new Message($swiftMessage, false);
-
 		$this->assertSame(AutoSubmittedValue::AUTO_GENERATED, $message->getAutoSubmitted());
-
 	}
 }