IMAUser.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.contrib.mailarchive;

/**
 * A "mailing-list user", containing both XWiki user profile and mail archive email address parts information for a
 * user.
 * 
 * @author jbousque
 * @version $Id$
 */
public interface IMAUser
{
    /**
     * @return The original address of this mailing-list "user".
     */
    String getOriginalAddress();

    /**
     * @return The email address.
     */
    String getAddress();

    /**
     * Computes a "displayable" version of this address. If Personal part is not empty, it is used. Else, the address
     * part in abbreviated form (stripped of part after '@' character) is returned.
     * 
     * @return The displayable version of this address.
     */
    String getDisplayName();

    /**
     * @return A matching wiki profile, or null if none was found.
     */
    String getWikiProfile();

}