feat: [CO-1341] forward appointment

common/src/main/java/com/zimbra/common/soap/MailConstants.java

@@ -169,6 +169,7 @@ private MailConstants() {}
   public static final String E_MODIFY_APPOINTMENT_RESPONSE = "ModifyAppointmentResponse";
   public static final String E_CANCEL_APPOINTMENT_REQUEST = "CancelAppointmentRequest";
   public static final String E_FORWARD_APPOINTMENT_REQUEST = "ForwardAppointmentRequest";
+  public static final String E_FORWARD_APPOINTMENT_RESPONSE = "ForwardAppointmentResponse";
   public static final String E_FORWARD_APPOINTMENT_INVITE_REQUEST =
       "ForwardAppointmentInviteRequest";
   public static final String E_ADD_APPOINTMENT_INVITE_REQUEST = "AddAppointmentInviteRequest";

store/src/main/java/com/zimbra/cs/service/mail/ForwardCalendarItem.java

@@ -276,11 +276,10 @@ private static void setSentByAndAttendees(ZVCalendar cal, String sentBy, Address
       ZComponent comp = compIter.next();
       ICalTok compName = ICalTok.lookup(comp.getName());
       if (ICalTok.VEVENT.equals(compName) || ICalTok.VTODO.equals(compName)) {
-        // Remove existing ATTENDEEs and X-MS-OLK-SENDER.
+        // Remove existing X-MS-OLK-SENDER.
         for (Iterator<ZProperty> propIter = comp.getPropertyIterator(); propIter.hasNext(); ) {
           ZProperty prop = propIter.next();
-          if (ICalTok.ATTENDEE.equals(prop.getToken())
-              || "X-MS-OLK-SENDER".equalsIgnoreCase(prop.getName())) propIter.remove();
+          if ("X-MS-OLK-SENDER".equalsIgnoreCase(prop.getName())) propIter.remove();
         }
         // SENT-BY
         ZProperty orgProp = comp.getProperty(ICalTok.ORGANIZER);

store/src/test/java/com/zextras/mailbox/soap/SoapTestSuite.java

@@ -4,14 +4,26 @@
 
 package com.zextras.mailbox.soap;
 
+import static com.zimbra.client.ZEmailAddress.EMAIL_TYPE_TO;
+
 import com.zextras.mailbox.util.SoapClient;
 import com.zimbra.common.service.ServiceException;
+import com.zimbra.common.soap.MailConstants;
 import com.zimbra.common.soap.SoapProtocol;
 import com.zimbra.cs.account.Account;
 import com.zimbra.cs.service.AuthProvider;
 import com.zimbra.soap.SoapEngine;
 import com.zimbra.soap.ZimbraSoapContext;
+import com.zimbra.soap.mail.message.CreateAppointmentRequest;
+import com.zimbra.soap.mail.message.CreateAppointmentResponse;
+import com.zimbra.soap.mail.message.ForwardAppointmentRequest;
+import com.zimbra.soap.mail.message.ForwardAppointmentResponse;
+import com.zimbra.soap.mail.type.EmailAddrInfo;
+import com.zimbra.soap.mail.type.Msg;
 import java.util.HashMap;
+import java.util.List;
+import org.apache.http.HttpResponse;
+import org.junit.jupiter.api.Assertions;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 /**
@@ -55,4 +67,34 @@ public static HashMap<String, Object> getSoapContextForAccount(Account account,
     };
   }
 
+  protected CreateAppointmentResponse createAppointment(Account authenticatedAccount, Msg msg)
+      throws Exception {
+    final CreateAppointmentRequest createAppointmentRequest = new CreateAppointmentRequest();
+    createAppointmentRequest.setMsg(msg);
+    final HttpResponse response = getSoapClient().executeSoap(authenticatedAccount,
+        createAppointmentRequest);
+    String soapResponse = SoapUtils.getResponse(response);
+    Assertions.assertEquals(200, response.getStatusLine().getStatusCode(),
+        "Create appointment failed with:\n" + soapResponse);
+    return SoapUtils.getSoapResponse(soapResponse, MailConstants.E_CREATE_APPOINTMENT_RESPONSE,
+        CreateAppointmentResponse.class);
+  }
+
+  protected ForwardAppointmentResponse forwardAppointment(Account authenticatedAccount, String appointmentId, String to)
+      throws Exception {
+
+    final ForwardAppointmentRequest forwardAppointmentRequest = new ForwardAppointmentRequest();
+    forwardAppointmentRequest.setId(appointmentId);
+    final Msg msg = new Msg();
+    msg.setEmailAddresses(List.of(new EmailAddrInfo(to, EMAIL_TYPE_TO)));
+    forwardAppointmentRequest.setMsg(msg);
+
+    final HttpResponse response = getSoapClient().executeSoap(authenticatedAccount,
+        forwardAppointmentRequest);
+    String soapResponse = SoapUtils.getResponse(response);
+    Assertions.assertEquals(200, response.getStatusLine().getStatusCode(),
+        "Forward appointment failed with:\n" + soapResponse);
+    return SoapUtils.getSoapResponse(soapResponse, MailConstants.E_FORWARD_APPOINTMENT_RESPONSE,
+        ForwardAppointmentResponse.class);
+  }
 }

store/src/test/java/com/zimbra/cs/service/mail/ForwardAppointmentAPITest.java

@@ -0,0 +1,205 @@
+package com.zimbra.cs.service.mail;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+import com.icegreen.greenmail.util.GreenMail;
+import com.icegreen.greenmail.util.ServerSetup;
+import com.zimbra.cs.mailbox.CalendarItem;
+import com.zimbra.cs.mailbox.MailItem.Type;
+import com.zimbra.cs.mailbox.calendar.Invite;
+import com.zimbra.cs.mailclient.smtp.SmtpConfig;
+import java.io.IOException;
+import java.time.Instant;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
+import java.util.List;
+
+import java.util.stream.Collectors;
+import javax.mail.Address;
+import javax.mail.Message.RecipientType;
+import javax.mail.MessagingException;
+import javax.mail.internet.MimeMessage;
+import javax.mail.internet.MimeMultipart;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Tag;
+import org.junit.jupiter.api.Test;
+
+import com.zextras.mailbox.soap.SoapTestSuite;
+import com.zextras.mailbox.util.MailboxTestUtil.AccountCreator;
+import com.zextras.mailbox.util.MailboxTestUtil.AccountCreator.Factory;
+import com.zimbra.common.service.ServiceException;
+import com.zimbra.cs.account.Account;
+import com.zimbra.cs.account.Provisioning;
+import com.zimbra.cs.index.SortBy;
+import com.zimbra.cs.mailbox.Folder;
+import com.zimbra.cs.mailbox.Mailbox;
+import com.zimbra.cs.mailbox.MailboxManager;
+import com.zimbra.soap.mail.message.CreateAppointmentResponse;
+import com.zimbra.soap.mail.type.CalOrganizer;
+import com.zimbra.soap.mail.type.CalendarAttendee;
+import com.zimbra.soap.mail.type.DtTimeInfo;
+import com.zimbra.soap.mail.type.EmailAddrInfo;
+import com.zimbra.soap.mail.type.InvitationInfo;
+import com.zimbra.soap.mail.type.Msg;
+
+@Tag("api")
+class ForwardAppointmentAPITest extends SoapTestSuite {
+
+	private static MailboxManager mailboxManager;
+
+	private static Folder getFirstCalendar(Account user) throws ServiceException {
+    final Mailbox mailbox = mailboxManager.getMailboxByAccount(user);
+    final List<Folder> calendarFolders = mailbox.getCalendarFolders(null, SortBy.DATE_DESC);
+    return calendarFolders.get(0);
+  }
+
+	private static Factory accountCreatorFactory;
+	private static GreenMail greenMail;
+
+	@BeforeAll
+	static void beforeAll() throws Exception {
+		greenMail =
+				new GreenMail(
+						new ServerSetup[] {
+								new ServerSetup(
+										SmtpConfig.DEFAULT_PORT, SmtpConfig.DEFAULT_HOST, ServerSetup.PROTOCOL_SMTP)
+						});
+		greenMail.start();
+		Provisioning provisioning = Provisioning.getInstance();
+		mailboxManager = MailboxManager.getInstance();
+		accountCreatorFactory = new AccountCreator.Factory(provisioning);
+	}
+
+	@Test
+	void shouldAddForwardeeToCurrentAttendeesWhenForwardingAppointment() throws Exception {
+		final Account userA = accountCreatorFactory.get().withUsername("userA").create();
+		final Account userB = accountCreatorFactory.get().withUsername("userB").create();
+		final Account userC = accountCreatorFactory.get().withUsername("userC").create();
+		final Account userD = accountCreatorFactory.get().withUsername("userD").create();
+		createAppointment(userA, List.of(userB, userD));
+		final MimeMessage[] receivedMessages = greenMail.getReceivedMessages();
+		MimeMessage receivedMessage1 = receivedMessages[0];
+		final String ics1 = extractIcsFromMessage(receivedMessage1, 1);
+		Assertions.assertTrue(ics1.contains("ATTENDEE;CN=userb@test.com;ROLE=REQ-PARTICIPANT:mailto:userb@test.com"));
+		Assertions.assertTrue(ics1.contains("ATTENDEE;CN=userd@test.com;ROLE=REQ-PARTICIPANT:mailto:userd@test.com"));
+		greenMail.reset();
+		final List<CalendarItem> calendarItems = getCalendarAppointments(userB);
+		final CalendarItem userBAppointment = calendarItems.get(0);
+		forwardAppointment(userB, String.valueOf(userBAppointment.getId()), userC.getName());
+
+		MimeMessage receivedMessage = greenMail.getReceivedMessages()[0];
+		final String ics = extractIcsFromMessage(receivedMessage, 2);
+		Assertions.assertTrue(ics.contains("ATTENDEE;PARTSTAT=NEEDS-ACTION;RSVP=TRUE:mailto:userc@test.com"));
+		Assertions.assertTrue(ics.contains("ATTENDEE;CN=userb@test.com;ROLE=REQ-PARTICIPANT:mailto:userb@test.com"));
+		Assertions.assertTrue(ics.contains("ATTENDEE;CN=userd@test.com;ROLE=REQ-PARTICIPANT:mailto:userd@test.com"));
+	}
+
+	@Test
+	void shouldSendEmailOnlyToNewAttendeeWhenForwarding() throws Exception {
+		final Account userA = accountCreatorFactory.get().withUsername("userA").create();
+		final Account userB = accountCreatorFactory.get().withUsername("userB").create();
+		final Account userC = accountCreatorFactory.get().withUsername("userC").create();
+		createAppointment(userA, List.of(userB, userC));
+		greenMail.reset();
+
+		final Account userD = accountCreatorFactory.get().withUsername("userD").create();
+		final List<CalendarItem> calendarItems = getCalendarAppointments(userB);
+		final CalendarItem userBAppointment = calendarItems.get(0);
+
+		forwardAppointment(userB, String.valueOf(userBAppointment.getId()), userD.getName());
+
+		MimeMessage receivedMessage = greenMail.getReceivedMessages()[0];
+		final Address[] recipients = receivedMessage.getRecipients(RecipientType.TO);
+		assertEquals(1, recipients.length);
+		assertEquals(userD.getName(), recipients[0].toString());
+	}
+
+	@Test
+	void shouldNotifyOrganizerThatItsAppointmentHasBeenForwarded() throws Exception {
+		final Account userA = accountCreatorFactory.get().withUsername("userA").create();
+		final Account userB = accountCreatorFactory.get().withUsername("userB").create();
+		final Account userC = accountCreatorFactory.get().withUsername("userC").create();
+		createAppointment(userA, List.of(userB, userC));
+		greenMail.reset();
+
+		final Account userD = accountCreatorFactory.get().withUsername("userD").create();
+		final List<CalendarItem> calendarItems = getCalendarAppointments(userB);
+		final CalendarItem userBAppointment = calendarItems.get(0);
+
+		forwardAppointment(userB, String.valueOf(userBAppointment.getId()), userD.getName());
+
+		MimeMessage forwardedNotification = greenMail.getReceivedMessages()[1];
+		final Address[] recipients = forwardedNotification.getRecipients(RecipientType.TO);
+		assertEquals(1, recipients.length);
+		assertEquals(userA.getName(), recipients[0].toString());
+		final String messageContent = new String(forwardedNotification.getRawInputStream().readAllBytes());
+		assertTrue(messageContent.contains("Your meeting was forwarded"));
+		assertTrue(messageContent.contains("userb <userb@test.com>  has forwarded your meeting request to additional recipients."));
+	}
+
+	private static List<CalendarItem> getCalendarAppointments(Account userB) throws ServiceException {
+		return mailboxManager.getMailboxByAccount(userB)
+				.getCalendarItems(null, Type.APPOINTMENT, getFirstCalendar(userB).getFolderId());
+	}
+
+	private static CalendarItem getCalendarItemById(Account account,
+			CreateAppointmentResponse appointmentResponse) throws ServiceException {
+		return mailboxManager.getMailboxByAccount(account)
+				.getCalendarItemById(null, Integer.parseInt(appointmentResponse.getCalItemId()));
+	}
+
+	private CreateAppointmentResponse createAppointment(Account organizer, List<Account> attendees) throws Exception {
+		final Msg invitation = newAppointmentMessage(organizer, attendees.stream().map(Account::getName).collect(
+				Collectors.toList()));
+		final CreateAppointmentResponse appointmentResponse = createAppointment(organizer, invitation);
+		final Invite invite = getCalendarItemById(organizer, appointmentResponse).getInvite(0);
+		for(Account attendee: attendees) {
+			mailboxManager.getMailboxByAccount(attendee)
+					.addInvite(null, invite, getFirstCalendar(attendee).getFolderId());
+		}
+		return appointmentResponse;
+	}
+	private static String extractIcsFromMessage(MimeMessage receivedMessage, int bodyPart)
+			throws IOException, MessagingException {
+		return new String(
+				((MimeMultipart) receivedMessage.getContent()).getBodyPart(bodyPart).getInputStream()
+						.readAllBytes());
+	}
+
+	private static String nextWeek() {
+		final LocalDateTime now = LocalDateTime.now();
+		return now.plusDays(7L).format(DateTimeFormatter.ofPattern("yMMdd"));
+	}
+
+
+	private Msg newAppointmentMessage(Account organizer, List<String> attendees) {
+		Msg msg = new Msg();
+		msg.setSubject("Test appointment");
+
+		InvitationInfo invitationInfo = new InvitationInfo();
+		final CalOrganizer calOrganizer = new CalOrganizer();
+		calOrganizer.setAddress(organizer.getName());
+		invitationInfo.setOrganizer(calOrganizer);
+		attendees.forEach(
+				address -> {
+					final CalendarAttendee calendarAttendee = new CalendarAttendee();
+					calendarAttendee.setAddress(address);
+					calendarAttendee.setDisplayName(address);
+					calendarAttendee.setRsvp(true);
+					calendarAttendee.setRole("REQ");
+					invitationInfo.addAttendee(calendarAttendee);
+				});
+		invitationInfo.setDateTime(Instant.now().toEpochMilli());
+		final String dateTime = nextWeek();
+		invitationInfo.setDtStart(new DtTimeInfo(dateTime));
+
+		attendees.forEach(
+				address -> msg.addEmailAddress(new EmailAddrInfo(address, "t")));
+		msg.addEmailAddress(new EmailAddrInfo(organizer.getName(), "f"));
+		msg.setInvite(invitationInfo);
+
+		return msg;
+	}
+
+}

store/src/test/java/com/zimbra/cs/service/mail/ModifyAppointmentApiTest.java

@@ -115,18 +115,6 @@ private CreateMountpointResponse createMountpoint(Account onAccount, Folder shar
         CreateMountpointResponse.class);
   }
 
-  private CreateAppointmentResponse createAppointment(Account authenticatedAccount, Msg msg)
-      throws Exception {
-    final CreateAppointmentRequest createAppointmentRequest = new CreateAppointmentRequest();
-    createAppointmentRequest.setMsg(msg);
-    final HttpResponse response = getSoapClient().executeSoap(authenticatedAccount,
-        createAppointmentRequest);
-    String soapResponse = SoapUtils.getResponse(response);
-    Assertions.assertEquals(200, response.getStatusLine().getStatusCode(), "Create appointment failed with:\n" + soapResponse);
-    return SoapUtils.getSoapResponse(soapResponse, MailConstants.E_CREATE_APPOINTMENT_RESPONSE,
-        CreateAppointmentResponse.class);
-  }
-
   private Msg appointmentOnSharedCalendar(CreateMountpointResponse mountpointResponse, Account userA, Account userB, List<String> attendees) {
     Msg msg = new Msg();
     msg.setFolderId(String.valueOf(mountpointResponse.getMount().getId()));