Mail samples

Aspectos básicos

En la mayoría de los métodos verá el parámetro llamado “mailId”. El valor de este parámetro puede ser un UUID de correo válido.

Consejo

Ejemplo de fldId:

• Usando UUID -> “50b7a5b9-89d2-430e-bbc9-6a6e01662a71”

Ejemplo de código sugerido

Primero debe crear el objeto webservice:

OKMWebservices ws = OKMWebservicesFactory.newInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto webservice “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en el servicio web, la sesión se mantiene en el objeto webservice. A partir de ahí puede usar el resto de métodos de la API.

Llegados a este punto, puede usar todos los métodos de Mail desde la clase “mail”, tal y como se muestra a continuación:

ws.mail.getMailProperties("05d9b8e3-f9c1-4ace-9007-afd775dbbced")

Métodos

getMailProperties

Descripción:

Método	Valores de retorno	Descripción
getMailProperties(String mailId)	Mail	Devuelve las propiedades del correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                System.Console.WriteLine(ws.mail.getMailProperties("f0064cf3-4776-44c2-868a-f08697a6957e").toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteMail

Descripción:

Método	Valores de retorno	Descripción
deleteMail(String mailId)	void	Elimina un correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                ws.mail.deleteMail("50b7a5b9-89d2-430e-bbc9-6a6e01662a71");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

purgeMail

Descripción:

Método	Valores de retorno	Descripción
purgeMail(String mailId)	void	La carpeta se elimina permanentemente del repositorio.

Precaución

Una vez purgado un correo, solo puede restaurarse a partir de una copia de seguridad anterior del repositorio. La acción de purga elimina el correo de forma permanente del repositorio.

• Normalmente se purgan correos en /okm:trash/userId - la ubicación personal de la papelera del usuario - pero es posible purgar directamente cualquier correo del repositorio.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                ws.mail.purgeMail("50b7a5b9-89d2-430e-bbc9-6a6e01662a71");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

renameMail

Descripción:

Método	Valores de retorno	Descripción
renameMail(String mailId, String newName)	Mail	Renombra un correo.

Nota

Desde la interfaz de OpenKM, el asunto se usa para mostrar el nombre del correo en la tabla del explorador de ficheros. Eso significa que el cambio tendrá efecto internamente en la ruta del correo, pero no será visible en la interfaz por defecto.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                ws.mail.renameMail("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "new name");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

moveMail

Descripción:

Método	Valores de retorno	Descripción
moveMail(String mailId, String dstId)	void	Mueve un correo a una carpeta o expediente.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                ws.mail.moveMail("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "055e4384-7c70-4456-b32b-f5a55a79861f");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

copyMail

Descripción:

Método	Valores de retorno	Descripción
public void copyMail(String mailId, String dstId, String newName)	Mail	Copia un correo a una carpeta o expediente.

Precaución

Solo se copian los permisos de seguridad al destino; los metadatos, palabras clave, etc. de la carpeta no se copian.

Consulte el método “extendedCopy” para esta funcionalidad.

• Los valores del parámetro dstId deben ser el UUID de una carpeta o expediente.
• Cuando el valor del parámetro newName es null, el correo conservará el mismo nombre.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                ws.mail.copyMail("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "055e4384-7c70-4456-b32b-f5a55a79861f", "new_name");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

extendedMailCopy

Descripción:

Método	Valores de retorno	Descripción
extendedMailCopy(String mailId, String dstId, bool categories, bool keywords, bool propertyGroups, bool notes,             bool wiki, bool security, String newName)	Mail	Copia un correo con los datos asociados a una carpeta o expediente.

Nota

Por defecto solo se copian los datos binarios y los permisos de seguridad; los metadatos, palabras clave, etc. de la carpeta no se copian.

Adicionalmente:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro de grupos de metadatos es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copiarán los valores originales de las notas.
• Cuando el parámetro wiki es true, se copian los valores originales del wiki.
• Cuando se indica newName, se renombra el correo.
• Cuando el parámetro security es true, se copiará la configuración de seguridad original.

• Los valores del parámetro dstId deben ser el UUID de una carpeta o expediente.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                ws.mail.extendedMailCopy("fe51797c-be0b-4076-8f4b-b4fffe8fd2bc", "055e4384-7c70-4456-b32b-f5a55a79861f", true, true, true, true, true, true, null);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getMailChildren

Descripción:

Método	Valores de retorno	Descripción
getMailChildren(String fldId)	List	Devuelve una lista de todos los correos cuyo padre es fldId.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                foreach (Mail mail in ws.mail.getMailChildren("055e4384-7c70-4456-b32b-f5a55a79861f"))
                {
                    System.Console.WriteLine(mail);
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

isValidMail

Descripción:

Método	Valores de retorno	Descripción
isValidMail(String mailId)	Boolean	Devuelve un booleano que indica si el nodo es un correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                // Return true
                ws.mail.isValidMail("50b7a5b9-89d2-430e-bbc9-6a6e01662a71");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getMailPath

Descripción:

Método	Valores de retorno	Descripción
getMailPath(String mailId)	String	Convierte un UUID de correo en una ruta de carpeta.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                System.Console.WriteLine(ws.mail.getMailPath("50b7a5b9-89d2-430e-bbc9-6a6e01662a71"));
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createAttachment

Descripción:

Método	Valores de retorno	Descripción
createAttachment(String mailId, String docName, InputStream is)	Document	Guarda un adjunto en el correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using System.IO;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                 ws.login(user, password);
                 FileStream fs = new FileStream("E:\\logo.png", FileMode.Open);
                 ws.mail.createAttachment("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "log.png", fs);
                 fs.Dispose();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteAttachment

Descripción:

Método	Valores de retorno	Descripción
deleteAttachment(String mailId, String docId)	void	Elimina un adjunto de un correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                ws.mail.deleteAttachment("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "e339f14b-4d3a-489c-91d3-05e4575709d2");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getAttachments

Descripción:

Método	Valores de retorno	Descripción
getAttachments(String mailId)	List	Recupera una lista con todos los documentos adjuntos de un correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                 ws.login(user, password);
                 foreach (Document doc in ws.mail.getAttachments("50b7a5b9-89d2-430e-bbc9-6a6e01662a71"))
                 {
                     System.Console.WriteLine(doc);
                 }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

sendMailWithAttachments

Descripción:

Método	Valores de retorno	Descripción
sendMailWithAttachments(List to, List cc, List bcc, List replyTo, String subject, String body, List docsId, String uuid)	Mail	Envía un mensaje de correo con un adjunto.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente. El parámetro dstId indica dónde se almacenará el correo en el repositorio tras enviarse.
• Otros parámetros:

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                List<String> to = new List<String>();
                to.Add("destination@mail.com");
                List<String> cc = new List<String>();
                List<String> bcc = new List<String>();
                List<String> docsId = new List<String>();                List<String> replyTo= new List<String>();
                docsId.Add("7aa523e0-06cf-4733-b8c8-cc74d8b2716d");
                docsId.Add("f123a950-0329-4d62-8328-0ff500fd42db");
                ws.mail.sendMailWithAttachments(to, cc, bcc, replyTo, "some subject", "This mail its a test.", docsId, "055e4384-7c70-4456-b32b-f5a55a79861f");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

sendMailWithAttachments

Descripción:

Método	Valores de retorno	Descripción
sendMailWithAttachments(String from, List to, List cc, List bcc, List replyTo, String subject, String body, List docsId, String uuid)	Mail	Envía un mensaje de correo con un adjunto.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente. El parámetro dstId indica dónde se almacenará el correo en el repositorio tras enviarse.
• Otros parámetros:

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);                string from = "test@none.com";
                List<String> to = new List<String>();
                to.Add("destination@mail.com");
                List<String> cc = new List<String>();
                List<String> bcc = new List<String>();
                List<String> docsId = new List<String>();                List<String> replyTo= new List<String>();
                docsId.Add("7aa523e0-06cf-4733-b8c8-cc74d8b2716d");
                docsId.Add("f123a950-0329-4d62-8328-0ff500fd42db");
                ws.mail.sendMailWithAttachments(from, to, cc, bcc, replyTo, "some subject", "This mail its a test.", docsId, "055e4384-7c70-4456-b32b-f5a55a79861f");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

importEml

Descripción:

Método	Valores de retorno	Descripción
importEml(String dstId, String title, FileStream fs)	Mail	Importa un correo en formato EML.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente. El parámetro dstId indica dónde se almacenará el correo en el repositorio tras enviarse.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using System.IO;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                FileStream filestream = new FileStream("C:\\Documents\\test.eml", FileMode.Open);
                Mail mail = ws.mail.importEml("f123a950-0329-4d62-8328-0ff500fd42db", "Test", filestream);
                System.Console.WriteLine(mail);
                filestream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

importMsg

Descripción:

Método	Valores de retorno	Descripción
importMsg(String dstId, String title, FileStream fs)	Mail	Importa un correo en formato MSG.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente. El parámetro dstId indica dónde se almacenará el correo en el repositorio tras enviarse.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
using System.IO;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                FileStream filestream = new FileStream("C:\\Documents\\test.msg", FileMode.Open);
                Mail mail = ws.mail.importMsg("f123a950-0329-4d62-8328-0ff500fd42db", "Test", filestream);
                System.Console.WriteLine(mail);
                filestream.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setMailTitle

Descripción:

Método	Valores de retorno	Descripción
setMailTitle(String mailId, String title)	Mail	Establece el título del correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                ws.mail.setMailTitle("68ed7a93-005c-4ec6-ac01-bb151573c775", "new title");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

sendMail

Descripción:

Método	Valores de retorno	Descripción
sendMail(List to, String subject, String body)	Void	Envía un correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                List<String> to = new List<string>();
                to.Add("some@mail.com");
                ws.mail.sendMail(to, "Testing sending mail from OpenKM", "Test message body.");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

sendMail

Descripción:

Método	Valores de retorno	Descripción
sendMail(String from, List to, String subject, String body)	Void	Envía un correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);                string from = "test@mome.com"
                List<String> to = new List<string>();
                to.Add("some@mail.com");
                ws.mail.sendMail(from, to, "Testing sending mail from OpenKM", "Test message body.");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

setMailDescription

Descripción:

Método	Valores de retorno	Descripción
setMailDescription(String mailId, String description)	void	Establece el título del correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                ws.mail.setMailDescription("68ed7a93-005c-4ec6-ac01-bb151573c775", "Any description");
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getMailContent

Descripción:

Método	Valores de retorno	Descripción
getMailContent(String mailId)	Stream	Establece el título del correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                 ws.login(user, password);
                 Stream s = ws.mail.getMailContent("68ed7a93-005c-4ec6-ac01-bb151573c775");                 FileStream mailFile = new FileStream("C:\\mailtest.msg", FileMode.OpenOrCreate);                 s.CopyTo(mailFile);                 s.Close();                 mailFile.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getMailThumbnail

Descripción:

Método	Valores de retorno	Descripción
getMailThumbnail(String mailId, String type)	Stream	Devuelve los datos de la imagen miniatura.

Nota

Cada tipo de miniatura tiene sus propias dimensiones de imagen.

• Tipos disponibles:

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
            try
            {                ws.login(user, password);
                Stream s = ws.mail.getMailThumbnail("68ed7a93-005c-4ec6-ac01-bb151573c775", ThumbnailType.THUMBNAIL_PROPERTIES);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createWizardMail

Descripción:

Método	Valores de retorno	Descripción
createWizardMail(String uuid, String title, FileStream fileStream, String type)	WizardNode	Crea un correo con un asistente.

Nota

El nodo Wizard contiene los pasos que puede seguir el asistente:

• Grupos de metadatos
• Palabras clave
• Categorías

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                Folder fld = ws.createFolder("f123a950-0329-4d62-8328-0ff500fd42db", "Test");                FileStream filestream = new FileStream("C:\\testing.msg", FileMode.Open, FileAccess.Read);                WizardNode wn = ws.mail.createWizardMail(fld.uuid, "Any title", filestream, Mail.ORIGIN_MSG);                filestream.Close();                System.Console.WriteLine(wn.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getMailAccounts

Descripción:

Método	Valores de retorno	Descripción
getMailAccounts()	List	Recupera una lista de las cuentas de correo del usuario.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);
                foreach (MailAccount mail in ws.mail.getMailAccounts())
                {
                    System.Console.WriteLine(mail.toString());
                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getMailMessages

Descripción:

Método	Valores de retorno	Descripción
getMailMessages(long accountId, long start)	MailServerMessages	Recupera una lista de mensajes en el servidor de correo para una cuenta de correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                                ws.login(user, password);                long accoundId = 1;                long start = 1;                MailServerMessages msm = ws.mail.getMailMessages(accoundId, start);
                System.Console.WriteLine(msm.toString());
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

addMailAccount

Descripción:

Método	Valores de retorno	Descripción
addMailAccount(MailAccount mailAccount)	void	Añade una cuenta de correo.

Nota

Es una buena práctica crear una cuenta y verificar la configuración del correo con testMailAccount(MailAccount mail).

Cuando no se establece el usuario, la cuenta se añadirá por defecto al usuario que ha iniciado sesión.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                MailAccount mailAcount = new MailAccount();                mailAcount.mailProtocol = MailAccount.PROTOCOL_IMAPS;                mailAcount.mailUser = "test@none.com";                mailAcount.mailPassword = "123456";                mailAcount.mailHost = "imap.gmail.com";                mailAcount.mailFolder = "OpenKM";                mailAcount.active = true;                mailAcount.recursive = true;                ws.mail.addMailAccount(mailAcount);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateMailAccount

Descripción:

Método	Valores de retorno	Descripción
updateMailAccount(MailAccount mailAccount)	void	Actualiza los datos de configuración principales de una cuenta de correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                MailAccount mailAcount = new MailAccount();                mailAcount.id = 1;// Valid mail account id;                mailAcount.mailProtocol = MailAccount.PROTOCOL_IMAPS;                mailAcount.mailUser = "test@none.com";                mailAcount.mailPassword = "123456";                mailAcount.mailHost = "imap.gmail.com";                mailAcount.mailFolder = "OpenKM";                mailAcount.active = false;                mailAcount.mailMarkDeleted = false;                mailAcount.recursive = false;                ws.mail.updateMailAccount(mailAcount);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

testMailAccount

Descripción:

Método	Valores de retorno	Descripción
testMailAccount(MailAccount mailAccount)	void	Verifica la conectividad de una cuenta de correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                MailAccount mailAcount = new MailAccount();                mailAcount.mailProtocol = MailAccount.PROTOCOL_IMAPS;                mailAcount.mailUser = "test@none.com";                mailAcount.mailPassword = "123456";                mailAcount.mailHost = "imap.gmail.com";                mailAcount.mailFolder = "OpenKM";                mailAcount.active = true;                mailAcount.recursive = true;                // Test mail account                ws.mail.testMailAccount(mailAcount);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteMailAccount

Descripción:

Método	Valores de retorno	Descripción
deleteMailAccount(long mailAccountId)	void	Elimina una cuenta de correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                long mailId = 1; //Valid mail id                ws.mail.deleteMailAccount(mailId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

importMailMessages

Descripción:

Método	Valores de retorno	Descripción
importMailMessages(long mailAccountId, List messageIds)	void	Importa mensajes de una cuenta de correo concreta.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                List<long> messageIds = new List<long>();                messageIds.Add(1);                long mailAccountId = 1; // Valid mail id                ws.mail.importMailMessages(mailAccountId, messageIds);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createMailFilter

Descripción:

Método	Valores de retorno	Descripción
createMailFilter(long mailAccountId, MailFilter mailFilter)	void	Añade un filtro a una cuenta de correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                Folder fld = ws.createFolder("f123a950-0329-4d62-8328-0ff500fd42db", "FilterFolder");                // Valid mail account id                long mailAccountId = 1;                MailFilter filter = new MailFilter();                filter.order = 0;                filter.grouping = false;                filter.exclusive = true;                filter.active = false;                filter.node = fld.uuid;                ws.mail.createMailFilter(mailAccountId, filter);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateMailFilter

Descripción:

Método	Valores de retorno	Descripción
updateMailFilter(MailFilter mailFilter)	void	Actualiza el filtro de una cuenta de correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                MailFilter filter = new MailFilter();                filter.id = 1; // Valid filter id                filter.grouping = true;                filter.exclusive = false;                filter.active = true;                ws.mail.updateMailFilter(filter);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteMailFilter

Descripción:

Método	Valores de retorno	Descripción
deleteMailFilter(long mailFilterId)	void	Elimina un filtro de una cuenta de correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                                long filterId = 1; // Valid filter id                ws.mail.deleteMailFilter(filterId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

createMailRule

Descripción:

Método	Valores de retorno	Descripción
createMailRule(long filterId, MailFilterRule rule)	void	Crea una regla para un filtro de correo.

Consejo

Parámetros del filtro de la cuenta de correo:

• Field: Establece el campo del correo que evaluará la regla.
  Las opciones disponibles son: _From, To, Subject y Content
  _                     - MailFilterRule.FIELD_FROM
                       - MailFilterRule.FIELD_TO
                       - MailFilterRule.FIELD_SUBJECT
                       - MailFilterRule.FIELD_CONTENT
                       - MailFilterRule.FIELD_ATTACHMENT

• Operation: Establece la operación que se usará en el proceso de evaluación.
  Las opciones disponibles son: Contains y Equals - MailFilterRule.OPERATION_EQUALS
                       - MailFilterRule.OPERATION_NOT_EQUALS
                       - MailFilterRule.OPERATION_CONTAINS
                       - MailFilterRule.OPERATION_ENDS_WITH
                       - MailFilterRule.OPERATION_STARTS_WITH

• Value: Establece el valor que se usará en el proceso de evaluación.

• Active: Establece si la regla está habilitada o no.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                                MailFilterRule rule = new MailFilterRule();                rule.operation = MailFilterRule.OPERATION_CONTAINS;                rule.value = "test";                rule.field = MailFilterRule.FIELD_FROM;                rule.active = false;                long filterId = 1;// Valid filter id                 ws.mail.createMailRule(filterId, rule);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

updateMailRule

Descripción:

Método	Valores de retorno	Descripción
updateMailRule(MailFilterRule rule)	void	Actualiza una regla de una cuenta de correo.

Consejo

Parámetros del filtro de la cuenta de correo:

• Field: Establece el campo del correo que evaluará la regla.

• Operation: Establece la operación que se usará en el proceso de evaluación.

• Value: Establece el valor que se usará en el proceso de evaluación.

• Active: Establece si la regla está activada o no.

Nota

Las opciones disponibles son:

• MailFilterRule.FIELD_FROM
• MailFilterRule.FIELD_TO
• MailFilterRule.FIELD_SUBJECT
• MailFilterRule.FIELD_CONTENT
• MailFilterRule.FIELD_ATTACHMENT

Nota

Las opciones disponibles son:

• MailFilterRule.OPERATION_EQUALS
• MailFilterRule.OPERATION_NOT_EQUALS
• MailFilterRule.OPERATION_CONTAINS
• MailFilterRule.OPERATION_ENDS_WITH
• MailFilterRule.OPERATION_STARTS_WITH

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                                List<MailFilterRule> rules = ws.getMailFilterRules(filter.id);                if (rules != null && rules.Count > 0)                {                    // Update rule                    MailFilterRule rule = new MailFilterRule();                    rule.id = rules[0].id;                    rule.operation = MailFilterRule.OPERATION_EQUALS;                    rule.value = "Any";                    rule.field = MailFilterRule.FIELD_SUBJECT;                    rule.active = true;                    ws.mail.updateMailRule(rule);                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

deleteMailRule

Descripción:

Método	Valores de retorno	Descripción
deleteMailRule(long ruleId)	void	Elimina una regla de una cuenta de correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                                long ruleId = 1; // Valid rule id                ws.mail.deleteMailRule(ruleId);
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getMailFilterRules

Descripción:

Método	Valores de retorno	Descripción
getMailFilterRules(long filterId)	List	Recupera una lista con todas las reglas de filtro asociadas.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                long filterId = 1; // Valid filter id                foreach (MailFilterRule mfrule in ws.mail.getMailFilterRules(filterId))                {                     System.Console.WriteLine(mfrule.toString());                }
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}

getPdf

Descripción:

Método	Valores de retorno	Descripción
getPdf(String uuid)	Stream	Devuelve un PDF del correo.

Ejemplo:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;using com.openkm.sdk4csharp.impl;

namespace OKMRest
{
    public class Program
    {
        static void Main(string[] args)
        {
            String host = "http://localhost:8080/openkm";
            String username = "okmAdmin";
            String password = "admin";
            OKMWebservice ws = OKMWebservicesFactory.newInstance(host);

            try
            {
                ws.login(user, password);                Mail mail = ws.mail.getMailProperties("4b88cbe9-e73d-45fc-bac0-35e0d6e59e43");                Stream stream = ws.mail.getPdf(mail.uuid);                FileStream mailFile = new FileStream("D:\\" + mail.subject + ".pdf", FileMode.OpenOrCreate, FileAccess.ReadWrite);                stream.CopyTo(mailFile);                stream.Close();                mailFile.Close();
            }
            catch (Exception e)
            {
                System.Console.WriteLine(e.ToString());
            }
        }
    }
}