Lluís Franco on Geeks.ms : Serie, Utilidad, LINQ

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (V)

Lluis Franco — Tue, 03 Mar 2009 16:28:00 GMT

Entradas anteriores de la serie:

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (I)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (II)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (III)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (IV)

Después de algunos días sin poder seguir con la serie porque han detenido a Bender hay que sacar adelante otros proyectos, volvemos a la carga con lo que promete ser la serie de artículos más larga que he publicado hasta ahora en este blog.

Antes de nada vamos a ponernos al día:

Que pretendemos?

Crear un add-in de Outlook que permita guardar nuestros correos en una librería de documentos de SharePoint (tanto MOSS como WSS).

Que necesitamos?

Cómo crear un complemento para Office (VSTO). visto
Cómo registrar acciones en los menús de la aplicación host (Outlook). visto
Cómo conectar con un servidor MOSS/WSS con diferentes credenciales de usuario (System.Net.NetworkCredential) visto
Cómo acceder a los sitios y listas de un site de MOSS/WSS (servicios Web de SharePoint). visto
Cómo interpretar la información XML devuelta por los servicios (LINQ to XML). visto
Cómo extender el modelo de objetos de SharePoint para acceder los valores devueltos por los servicios Web.
Cómo crear las columnas necesarias en una lista para guardar los metadatos del elementos de correo (From, To, Subject).
Cómo guardar un fichero en una biblioteca de documentos de SharePoint con control de versiones (DocLibHelper).
Cómo ejecutar distintos threads y mostrar el progreso (Callbacks).
Cómo distribuir nuestro complemento, creando un archivo MSI (Windows Installer packages).

Que vamos a ver hoy?

En este post vamos a centrarnos en cómo obtener datos de los servicios Web de SharePoint. En nuestro caso necesitamos obtener las colecciones de sitios, las librerías de cada uno de los sitios, y las carpetas de cada librería para mostrarlos en una ventana que permita al usuario seleccionar la ubicación en la que desea guardar los elementos de coreo:

Del mismo modo, vamos a necesitar obtener las columnas de la librería seleccionada, para comprobar si ya existen las columnas para almacenar los metadatos de los elementos de correo, y en caso contrario proceder a crearlas (esto va a ir muy bien para posteriormente poder clasificar los elementos).

Extendiendo el modelo de objetos de SharePoint

En el post anterior ya vimos que habíamos declarado algunas clases de apoyo (como la clase ‘SPSiteInfo’) para que nuestros métodos (como el método ‘getSiteSubSites’ que también vimos en el anterior post) pudiesen devolver colecciones genéricas de éestos tipos de datos, lo cual es mucho más manejable que pelearnos con el XML que devuelven los servicios Web de SharePoint.

Los métodos que vamos a crear son:

getSiteSubSites: Devuelve una lista genérica de objetos ‘SPSiteInfo’, a partir de un servicio Web websProxy.Webs
getSiteLists: Devuelve una lista genérica de objetos ‘SPListInfo’, a partir de un servicio Web listsProxy.Lists
getListFolders: Devuelve una lista genérica de objetos ‘SPFolderInfo’, a partir de un servicio Web listsProxy.Lists
getListColumns: Devuelve una lista genérica de objetos ‘SPFolderInfo’, a partir de un servicio Web listsProxy.Lists y de un listID (GUID)
createMetadataColumns: Crea las columnas de metadatos definidas en los settings del add-in en una lista, a partir de un servicio Web listsProxy.Lists y de un listID (GUID).

Las clases de apoyo son:

public class SPSiteInfo

    public string Title { get; set; }

    public string URL { get; set; }

    public SPSiteInfo()

//

    public SPSiteInfo(string title, string url)

        Title = title;

        URL = url;

public class SPListInfo

    public Guid ID { get; set; }

    public string Title { get; set; }

    public string URL { get; set; }

    public SPListInfo()

//

    public SPListInfo(Guid id, string title, string url)

        ID = id;

        Title = title;

        URL = url;

public class SPFolderInfo

    public string Title { get; set; }

    public string URL { get; set; }

    public SPFolderInfo()

//

    public SPFolderInfo(string title, string url)

        Title = title;

        URL = url;

public class SPColumnInfo

    public string ID { get; set; }

    public string Type { get; set; }

    public string DisplayName { get; set; }

    public string Name { get; set; }

    public bool Hidden { get; set; }

    public bool Sealed { get; set; }

    public bool ReadOnly { get; set; }

    public SPColumnInfo()

//

    public SPColumnInfo(string id, string type,

        string displayName, string name, bool hidden,

        bool issealed, bool isreadonly)

        ID = id;

        Type = type;

        DisplayName = displayName;

        Name = name;

        Hidden = hidden;

        Sealed = issealed;

        ReadOnly = isreadonly;

Y el código de los métodos será el siguiente:

public class SharePointExtensions

    public static List<SPSiteInfo> getSiteSubSites(websProxy.Webs sharePointWebs)

try

            XmlNode websResult = sharePointWebs.GetWebCollection();

            XDocument results = XDocument.Parse(websResult.OuterXml);

            XName name = XName.Get("Web", "http://schemas.microsoft.com/sharepoint/soap/");

            var webs = from item in results.Descendants(name)

                       select new SPSiteInfo

                           item.Attribute("Title").Value,

                           item.Attribute("Url").Value

);

            return webs.ToList();

        catch (Exception ex)

            throw ex;

    public static List<SPListInfo> getSiteLists(listsProxy.Lists sharePointLists)

try

            XmlNode listsResult = sharePointLists.GetListCollection();

            XDocument results = XDocument.Parse(listsResult.OuterXml);

            XName name = XName.Get("List", "http://schemas.microsoft.com/sharepoint/soap/");

            var lists = from item in results.Descendants(name)

                        where item.Attribute("ServerTemplate").Value.ToString() ==

                            Properties.Settings.Default.SERVER_TEMPLATE

                        select new SPListInfo

                            new Guid(item.Attribute("ID").Value),

                            item.Attribute("Title").Value,

                            item.Attribute("DefaultViewUrl").Value

);

            return lists.ToList();

        catch (Exception ex)

            throw ex;

    public static List<SPFolderInfo> getListFolders(listsProxy.Lists sharePointLists,

        string listName, string listText, string folderURL)

try

            XmlDocument xmlDoc = new System.Xml.XmlDocument();

            XmlNode ndQuery = xmlDoc.CreateNode(XmlNodeType.Element, "Query", "");

            XmlNode ndViewFields =

              xmlDoc.CreateNode(XmlNodeType.Element, "ViewFields", "");

            XmlNode ndQueryOptions = null;

            if (listName != folderURL)

                ndQueryOptions = xmlDoc.CreateNode(

                    XmlNodeType.Element, "QueryOptions", "");

                ndQueryOptions.InnerXml = string.Format(

                    "<Folder>{0}/{1}</Folder>", listName, folderURL);

            XName name = XName.Get("data", "urn:schemas-microsoft-com:rowset");

            XmlNode ndListItems =

                    sharePointLists.GetListItems(listText, null, ndQuery,

                    ndViewFields, null, ndQueryOptions, null);

            XDocument results = XDocument.Parse(ndListItems.OuterXml);

            var folders = from item in results.Descendants(name).Elements()

                          where item.Attribute("ows_ContentType").Value == "Carpeta"

                          select new SPFolderInfo

                             item.Attribute("ows_BaseName").Value,

                             item.Attribute("ows_ServerUrl").Value

);

            return folders.ToList();

        catch (Exception ex)

            throw ex;

    public static List<SPColumnInfo> getListColumns(listsProxy.Lists sharePointLists, string siteID)

try

            List<SPColumnInfo> columns =new List<SPColumnInfo>();

            XmlNode listsResult = sharePointLists.GetList(siteID);

            XDocument results = XDocument.Parse(listsResult.OuterXml);

            XName name = XName.Get("Field", "http://schemas.microsoft.com/sharepoint/soap/");

            var lists = from item in results.Descendants(name)

                        select item;

            foreach (var item in lists.ToList())

                XAttribute aID = item.Attribute("ID");

                XAttribute aType = item.Attribute("Type");

                XAttribute aDisplayName = item.Attribute("DisplayName");

                XAttribute aName = item.Attribute("Name");

                XAttribute aHidden = item.Attribute("Hidden");

                XAttribute aSealed = item.Attribute("Sealed");

                XAttribute aReadOnly = item.Attribute("ReadOnly");

                if (aID != null && aType != null && aDisplayName != null &&

                    aName != null)

                    bool ishidden = false;

                    bool issealed = false;

                    bool isreadonly = false;

                    if (aHidden != null && aHidden.Value.ToString() == "TRUE") ishidden = true;

                    if (aSealed != null && aSealed.Value.ToString() == "TRUE") issealed = true;

                    if (aReadOnly != null && aReadOnly.Value.ToString() == "TRUE") isreadonly = true;

                    columns.Add(new SPColumnInfo(

                        aID.Value.ToString(),

                        aType.Value.ToString(),

                        aDisplayName.Value.ToString(),

                        aName.Value.ToString(),

                        ishidden, issealed, isreadonly));

            return columns;

        catch (Exception ex)

            throw ex;

    public static void createMetadataColumns(listsProxy.Lists sharePointLists, string listID)

        int createColumnsCount = 0;

        if (!Properties.Settings.Default.OPTION_CREATE_METADATA_COLUMNS) return;

        var cols = from c in SharePointExtensions.getListColumns(

                   sharePointLists, listID)

                   where c.Hidden == false && c.Sealed == false && c.ReadOnly == false

                   select c;

        Dictionary<string, SPColumnInfo> columns = cols.ToDictionary(c => c.Name);

        string newFieldsList = "";

        if (!columns.ContainsKey(Properties.Settings.Default.COL_SUBJECT))

            string subjectfield =

                @"<Method ID='1'><Field Type='Text' DisplayName='{0}' MaxLength='255'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_SUBJECT);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_TO))

            string subjectfield =

                @"<Method ID='2'><Field Type='Text' DisplayName='{0}' MaxLength='255'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_TO);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_CC))

            string subjectfield =

                @"<Method ID='3'><Field Type='Text' DisplayName='{0}' MaxLength='255'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_CC);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_BCC))

            string subjectfield =

                @"<Method ID='4'><Field Type='Text' DisplayName='{0}' MaxLength='255'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_BCC);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_FROM))

            string subjectfield =

                @"<Method ID='5'><Field Type='Text' DisplayName='{0}' MaxLength='255'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_FROM);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_SENT))

            string subjectfield =

                @"<Method ID='6'><Field Type='DateTime' DateOnly='FALSE' DisplayName='{0}'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_SENT);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_SIZE))

            string subjectfield =

                @"<Method ID='7'><Field Type='Number' DisplayName='{0}'/></Method>";

            newFieldsList += string.Format(subjectfield, Properties.Settings.Default.COL_SIZE);

            createColumnsCount++;

        if (!columns.ContainsKey(Properties.Settings.Default.COL_IMPORTANCE))

            string subjectfield =

                @"<Method ID='8'><Field Type='Choice' DisplayName='{0}'>;

                  <Default>{1}</Default>

                  <CHOICES>

                    <CHOICE>{2}</CHOICE>

                    <CHOICE>{3}</CHOICE>

                    <CHOICE>{4}</CHOICE>

                  </CHOICES>

                </Field></Method>"

            newFieldsList += string.Format(subjectfield,

                Properties.Settings.Default.COL_IMPORTANCE,

                Properties.Settings.Default.COL_IMPORTANCE_MEDIUM,

                Properties.Settings.Default.COL_IMPORTANCE_HIGH,

                Properties.Settings.Default.COL_IMPORTANCE_MEDIUM,

                Properties.Settings.Default.COL_IMPORTANCE_LOW);

            createColumnsCount++;

        if (createColumnsCount > 0)

            XmlNode ndList = sharePointLists.GetList(listID);

            XmlNode ndVersion = ndList.Attributes["Version"];

            XmlDocument xmlDoc = new System.Xml.XmlDocument();

            XmlNode ndNewFields = xmlDoc.CreateNode(XmlNodeType.Element, "Fields", "");

            ndNewFields.InnerXml = newFieldsList;

try

                XmlNode ndReturn =

                   sharePointLists.UpdateList(listID,

                   null, ndNewFields, null, null,

                   ndVersion.Value);

            catch (Exception ex)

                throw ex;

Y con esto ya estamos en disposición de mostrar un cuadro de diálogo al usuario, para que seleccione la ubicación en el servidor de SharePoint dónde quiere guardar los elementos de correo.

En el próximo post veremos cómo guardar los elementos de corro en la ubicación seleccionada, creando las columnas de metadatos (si así lo hemos definido), y actualizando el valor de éstas columnas para guardar los valores de los campos de correo (Asunto, De, Para, Fecha, Tamaño, etc.).

Os recuerdo que al terminar la serie publicaré la solución con el código completo, por si a alguien le sirve.

Espero no demorarme tanto en escribir el próximo post!

Nos vemos, un saludo desde Andorra!

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (IV)

Lluis Franco — Tue, 10 Feb 2009 14:31:00 GMT

Entradas anteriores de la serie:

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (I)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (II)

SharePoint 2007 + Outlook 2007: Guardar correos de forma masiva (III)

He estado un par de días sin poder continuar con la serie, pero es que el trabajo aprieta y no siempre nos podemos dedicar a lo que más nos gusta...

Recapitulando: Cosas que necesitamos para nuestro add-in:

Cómo crear un complemento para Office (VSTO). visto en el post anterior.
Cómo registrar acciones en los menús de la aplicación host (Outlook). Lo veremos ahora.
Cómo conectar con un servidor MOSS/WSS con diferentes credenciales de usuario (System.Net.NetworkCredential) Esto también lo veremos ahora.
Cómo acceder a los sitios y listas de un site de MOSS/WSS (servicios Web de SharePoint). visto en el post anterior.
Cómo interpretar la información XML devuelta por los servicios (LINQ to XML). Y esto también lo veremos ahora.
El resto de cosas las veremos en los próximos días...

Hoy nos centraremos en mostrar cómo agregar opciones a los menús de Outlook (para lanzar nuestras acciones personalizadas), ver cómo conectar con un sitio de SharePoint con las credenciales predeterminadas, o bien proporcionando un usuario y password. Y además veremos cómo interpretar el resultado devuelto por los servicios Web, ya que el usar LINQ to XML va a facilitarnos en mucho la tarea de lidiar con XML puro y duro.

Demos un vistazo al futuro, a lo que va a ser este Add-In (solo Bender puede viajar al futuro):

1 - Una vez registradas nuestras propias acciones en el menú de Outlook, éstas permitirán guardar los elementos selecionados:

2 – Aparecerá una ventana en la que podremos se leccionar la biblioteca de documentos y la carpeta destino:

3 – Una vez seleccionada la carpeta, mostraremos una ventana de progreso en un hilo separado para que el usuario pueda seguir interactuando con Outlook:

4 – Una vez terminado, si vamos a la biblioteca de documentos aparecerán los documentos (y más adelante también los metadatos):

Vayamos por partes:

Registrar acciones en un menú de Outlook:

Registrar el menú es sencillo, sólo debemos modificar el código del evento ‘ItemContextMenuDisplay’ (como ya vimos en el post anterior), y llamar a un método ‘RegisterMenu’ que se encarga de agregar nuestras acciones al menú contextual de Outlook.

void Application_ItemContextMenuDisplay(

    Microsoft.Office.Core.CommandBar CommandBar,

    Microsoft.Office.Interop.Outlook.Selection Selection)

    RegisterMenu(CommandBar, false);

void RegisterMenu(Microsoft.Office.Core.CommandBar CommandBar, bool IsFolder)

    Office.CommandBarPopup cmdSaveToMOSS =

        (Office.CommandBarPopup)CommandBar.FindControl(

        missing, missing, "STSMOSS", missing, missing);

    if (cmdSaveToMOSS == null)

        cmdSaveToMOSS = (Office.CommandBarPopup)CommandBar.Controls.Add(

                Office.MsoControlType.msoControlPopup, missing,

                missing, missing, false);

        if (cmdSaveToMOSS != null)

            cmdSaveToMOSS.Caption = Properties.Resources.CONTEXT_MENU_CAPTION;

            cmdSaveToMOSS.Tag = "STMOSS";

            cmdSaveToMOSS.BeginGroup = true;

            Office.CommandBarButton btnSaveToMOSS =

                (Office.CommandBarButton)cmdSaveToMOSS.Controls.Add(

                Office.MsoControlType.msoControlButton, missing, missing, missing, missing);

            btnSaveToMOSS.Caption = Properties.Resources.CONTEXT_MENU_SENDBUTTON;

            btnSaveToMOSS.FaceId = 65;

            btnSaveToMOSS.Tag = IsFolder.ToString();

            btnSaveToMOSS.Style = MsoButtonStyle.msoButtonIconAndCaption;

            btnSaveToMOSS.Picture = getImage();

            btnSaveToMOSS.Click += new Microsoft.Office.Core.

                _CommandBarButtonEvents_ClickEventHandler(saveToMOSS_Click);

            Office.CommandBarButton btnConfigurationMOSS =

                (Office.CommandBarButton)cmdSaveToMOSS.Controls.Add(

                Office.MsoControlType.msoControlButton, missing, missing, missing, missing);

            btnConfigurationMOSS.Caption = Properties.Resources.CONTEXT_MENU_CONFIGURATIONBUTTON;

            btnConfigurationMOSS.BeginGroup = true;

            btnConfigurationMOSS.Style = MsoButtonStyle.msoButtonIconAndCaption;

            btnConfigurationMOSS.Click += new Microsoft.Office.Core.

                _CommandBarButtonEvents_ClickEventHandler(configurationMOSS_Click);

            cmdSaveToMOSS.Visible = true;

Este código crea un elemento menú y le agrega dos opciones (‘btnSaveToMOSS’ y ‘btnConfigurationMOSS’). A continuación establece sus propiedades y asigna los event handlers a sendas rutinas que se ejecutarán al pulsar sobre ellas.

void saveToMOSS_Click(Microsoft.Office.Core.CommandBarButton Ctrl, ref bool CancelDefault)

    CancelDefault = true;

    MessageBox.Show("Save");

void configurationMOSS_Click(Microsoft.Office.Core.CommandBarButton Ctrl, ref bool CancelDefault)

    CancelDefault = true;

    MessageBox.Show("Config");

Conectar con un servidor MOSS/WSS con diferentes credenciales de usuario:

En algunas ocasiones tal vez nos interese conectar con un sitio de SharePoint y no hacer uso de las credenciales predeterminadas (por defecto el token del usuario de Windows). En estos casos, debemos hacer uso de la clase ‘System.Net.NetworkCredential’, pasando los valores de usuario y password (y opcionalmente dominio) para acceder al sitio. En este caso he creado unas sencillas funciones que devuelven un objeto de tipo ‘ICredentials’ que posteriormente usaremos en la propiedad ‘Credentials’ de los proxies de los servicios Web:

public static System.Net.ICredentials getCredentials()

    return System.Net.CredentialCache.DefaultCredentials;

public static System.Net.ICredentials getCredentials(string user, string password, string domain)

    return new System.Net.NetworkCredential(user, password, domain);

Interpretar el resultado devuelto por los servicios Web (LINQ to XML):

En el post anterior vimos que el resultado devuelto por los métodos de un servicio Web dista mucho de ser fácilmente interpretable, ya que nos devuelve un objeto de tipo XmlNode, de modo que debemos analizar el DOM para obtener el resultado deseado. En nuestro caso, vamos a realizar una llamada al método ‘GetWebCollection()’, que devuelve un XmlNode con los nombres de las webs (sites) de un sitio de SharePoint. Pero vamos a utilizar LINQ to XML para obtener sólo los elementos de un tipo determinado, y además vamos a obtener aquellos atributos que nos interesan. Y lo mejor es que todo se hace una sola sentencia:

public static List<SPSiteInfo> getSiteSubSites(websProxy.Webs sharePointWebs)

try

        XmlNode websResult = sharePointWebs.GetWebCollection();

        XDocument results = XDocument.Parse(websResult.OuterXml);

        XName name = XName.Get("Web", "http://schemas.microsoft.com/sharepoint/soap/");

        var webs = from item in results.Descendants(name)

                   select new SPSiteInfo

                       item.Attribute("Title").Value,

                       item.Attribute("Url").Value

);

        return webs.ToList();

    catch (Exception ex)

        throw ex;

A destacar en el código anterior el uso de un elemento XName para obtener sólo los elementos de tipo Web:

A continuación basta con seleccionar los atributos deseados de cada elemento XML (en nuestro caso título y url) e ir creando objetos que almacenaremos en una colección. Aquí utilizo una sencilla clase llamada ‘SPSiteInfo’ para devolver una lista genérica. Esta clase tiene sólo dos propiedades de tipo string (Title y URL) y un constructor en el que le pasamos ambos valores:

public class SPSiteInfo

    public string Title { get; set; }

    public string URL { get; set; }

    public SPSiteInfo()

//

    public SPSiteInfo(string title, string url)

        Title = title;

        URL = url;

De este modo, ya tenemos una función que nos devuelve una colección de objetos ‘SPSiteInfo’. Emplearemos este mismo procedimiento para recuperar las bibliotecas de documentos de un sitio, las carpetas de una biblioteca de documentos, e incluso las columnas de una biblioteca de documentos.

Pero ello lo veremos en el próximo post, que hay que volver a las trincheras... :-)

PD – Os recuerdo que al final de la serie publicaré el código fuente del proyecto de ejemplo.