com.seleniumtests.connectors.mails.EWSClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
There is a newer version: 4.23.18
/**
 * Orignal work: Copyright 2015 www.seleniumtests.com
 * Modified work: Copyright 2016 www.infotel.com
 * 				Copyright 2017-2019 B.Hecquet
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * 	http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.seleniumtests.connectors.mails;

import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;

import javax.mail.MessagingException;

import com.seleniumtests.customexception.ConfigurationException;
import com.seleniumtests.customexception.CustomSeleniumTestsException;

import microsoft.exchange.webservices.data.core.ExchangeService;
import microsoft.exchange.webservices.data.core.PropertySet;
import microsoft.exchange.webservices.data.core.enumeration.misc.ExchangeVersion;
import microsoft.exchange.webservices.data.core.enumeration.property.BasePropertySet;
import microsoft.exchange.webservices.data.core.enumeration.property.WellKnownFolderName;
import microsoft.exchange.webservices.data.core.enumeration.search.FolderTraversal;
import microsoft.exchange.webservices.data.core.service.folder.Folder;
import microsoft.exchange.webservices.data.core.service.item.EmailMessage;
import microsoft.exchange.webservices.data.core.service.item.Item;
import microsoft.exchange.webservices.data.core.service.schema.FolderSchema;
import microsoft.exchange.webservices.data.core.service.schema.ItemSchema;
import microsoft.exchange.webservices.data.credential.ExchangeCredentials;
import microsoft.exchange.webservices.data.credential.WebCredentials;
import microsoft.exchange.webservices.data.property.complex.Attachment;
import microsoft.exchange.webservices.data.property.complex.EmailAddress;
import microsoft.exchange.webservices.data.property.complex.FolderId;
import microsoft.exchange.webservices.data.property.complex.Mailbox;
import microsoft.exchange.webservices.data.property.complex.MessageBody;
import microsoft.exchange.webservices.data.search.FindFoldersResults;
import microsoft.exchange.webservices.data.search.FolderView;
import microsoft.exchange.webservices.data.search.ItemView;
import microsoft.exchange.webservices.data.search.filter.SearchFilter;


public class EWSClient extends EmailClientImpl {
	
	private Mailbox mb;
	
	private ExchangeService service;
	private FolderId rootFolderId;
	private FolderId defaultFolderId;
	private Integer timeOffset;		// in hours to correct time beween robot and server
	private HashMap folders = new HashMap<>();

	/**
	 * Constructor
	 * @param host				server address
	 * @param username			login for server
	 * @param password			password for server
	 * @param folder			folder to read
	 * @param imapPort			port to use to connect
	 * @param timeOffset		workaround when server does not report the same time
	 * @throws Exception 
	 */
	public EWSClient(String host, String username, String password, String email, String domain, String folder, ExchangeVersion version, Integer timeOffset) throws Exception {
		
		super();
		// connection to server
		
		connect(host, username, password, email, domain, version);
		
		defaultFolderId = findFolder(folder);
		this.timeOffset = timeOffset; 
		if (folder != null) {
			setLastMessageIndex();
		} 
		this.folder = defaultFolderId.getFolderName().name();
		
	}
	
	/**
	 * search a folder in mailbox
	 * @param folderName
	 * @return
	 * @throws Exception 
	 */
	private FolderId findFolder(String folderName) throws Exception {
		
		if (folders.containsKey(folderName)) {
			return folders.get(folderName);
		}
		
		if (folderName.equals(WellKnownFolderName.Inbox.name())) {
			FolderId fId = new FolderId(WellKnownFolderName.Inbox, mb);
			folders.put(folderName, fId);
			return fId;
		}
		
		// search folder
		FolderView view = new FolderView(100);
        view.setPropertySet(new PropertySet(BasePropertySet.IdOnly));
        view.getPropertySet().add(FolderSchema.DisplayName);
        view.setTraversal(FolderTraversal.Deep);
        FindFoldersResults findFolderResults = service.findFolders(rootFolderId, view);

        for(Folder f: findFolderResults) {
            if (f.getDisplayName().equals(folderName)) {
            	folders.put(folderName, f.getId());
                return f.getId();
            }
        }
        throw new ConfigurationException("folder " + folderName + " does not exist for this account");
	}
	
	/**
	 * connect to folder on email server
	 * @param host				server address
	 * @param username			login for server
	 * @param password			password for server
	 * @param email				email address we would like to read messages on
	 * @param domain			email associated to email address
	 * @throws URISyntaxException 
	 */
	private void connect(String host, String username, String password, String email, String domain, ExchangeVersion version) throws URISyntaxException  {
		
		service = new ExchangeService(version);
		ExchangeCredentials credentials = new WebCredentials(username, password, domain);
		service.setCredentials(credentials);
		service.setUrl(new URI("https://" + host + "/EWS/Exchange.asmx"));
		
		// mailbox to use (a mailbox could have several emails
		mb = new Mailbox();
		mb.setAddress(email);

		rootFolderId = new FolderId(WellKnownFolderName.Root, mb);
	}
	
	/**
	 * Se deconnecte du serveur
	 */
	@Override
	public void disconnect() {
		// nothing as we use API
	}
	
	/**
	 * Récupère la liste des évenements
	 * @param password
	 * @throws MalformedURLException
	 */
	public void getEvents(String password) throws MalformedURLException {
		// TODO: implement
		throw new CustomSeleniumTestsException("calendar is not implemented");
	}
	
	/**
	 * get list of all emails in folder
	 * 
	 * @param folderName		folder to read
	 * @param firstMessageTime	date from which we should get messages
	 * @throws MessagingException
	 * @throws IOException
	 */
	@Override
	public List getEmails(String folderName, int firstMessageIndex, LocalDateTime firstMessageTime) throws Exception {

		if (folderName == null) {
			throw new ConfigurationException("folder should not be empty");
		}
		
		FolderId folderId = findFolder(folderName);
		Folder folder = Folder.bind(service, folderId);
		
		List emails = new ArrayList<>();
		List preFilteredItems;
		
		// filter messages
		if (searchMode == SearchMode.BY_INDEX || firstMessageTime == null) {
			lastMessageIndex = folder.getTotalCount();
			preFilteredItems = service.findItems(folderId, new ItemView(lastMessageIndex - firstMessageIndex + 1)).getItems();
		} else {
			SearchFilter.SearchFilterCollection filter = new SearchFilter.SearchFilterCollection();
			filter.add(new SearchFilter.IsGreaterThan(ItemSchema.DateTimeReceived, Date.from(firstMessageTime.plusHours(timeOffset).atZone(ZoneId.systemDefault()).toInstant())));
			preFilteredItems = service.findItems(folderId, filter, new ItemView(Math.max(1, lastMessageIndex))).getItems();
		}
			
		for (Item item: preFilteredItems) {

			item.load();
			List attachments = new ArrayList<>();
			for (Attachment att: item.getAttachments()) {
				attachments.add(att.getName());
			}

			emails.add(new Email(item.getSubject(), item.getBody().toString(), "", item.getDateTimeReceived().toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime(), attachments));
		}

		return emails;
	}
	
	/**
	 * define last message index on the server, so that on next request, we only get the newly received messages
	 * @throws Exception 
	 */
	@Override
	public void setLastMessageIndex() throws Exception {
		Folder folder = Folder.bind(service, defaultFolderId);
		lastMessageIndex = folder.getTotalCount();
	}
	
	/**
	 * define last message index on the server
	 * 
	 * @param messageIndex	index for the reference message
	 */
	@Override
	public void setLastMessageIndex(int messageIndex) {
		lastMessageIndex = messageIndex;
	}

	@Override
	public int getLastMessageIndex() {
		return lastMessageIndex;
	}

	/**
	 * Sends a message
	 * @param to	list of recipients
	 * @param title	email title
	 * @param body	content of the email
	 */
	@Override
	public void sendMessage(List to, String title, String body) throws Exception {
		EmailMessage message = new EmailMessage(service);
		message.setSubject(title);
		message.setBody(new MessageBody(body));
		for (String address: to) {
			message.getToRecipients().add(new EmailAddress(address));
		}
		message.sendAndSaveCopy();
		
	}
}