Mail samples
Aspectos básicos
Sección titulada «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.
Ejemplo de código sugerido
Sección titulada «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);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.getProperties("05d9b8e3-f9c1-4ace-9007-afd775dbbced")Métodos
Sección titulada «Métodos»getProperties
Sección titulada «getProperties»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getProperties(String uuid) | 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.getProperties("f0064cf3-4776-44c2-868a-f08697a6957e").toString()); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| delete(String uuid) | 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.delete("50b7a5b9-89d2-430e-bbc9-6a6e01662a71"); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| purge(String uuid) | void | La carpeta se elimina permanentemente del repositorio. |
Normalmente, purgará los correos hacia /okm:trash/userId - la papelera personal del usuario - pero también 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.purge("50b7a5b9-89d2-430e-bbc9-6a6e01662a71"); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| rename(String uuid, String newName) | void | Renombra 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.rename("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "new name"); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| move(String uuid, String dstId) | void | Mueve un correo a una carpeta o expediente. |
El valor del parámetro dstId debe ser un UUID de 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.move("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "055e4384-7c70-4456-b32b-f5a55a79861f"); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| public void copy(String mailId, String dstId, String newName) | Copia un correo en una carpeta o expediente. |
El valor del parámetro dstId debe ser un UUID de 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.copy("50b7a5b9-89d2-430e-bbc9-6a6e01662a71", "055e4384-7c70-4456-b32b-f5a55a79861f", "new_name"); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}extendedCopy
Sección titulada «extendedCopy»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| extendedCopy(String mailId, String dstId, bool categories, bool keywords, bool propertyGroups, bool notes, bool security, String newName) | Copia un correo junto con sus datos asociados en una carpeta o expediente. |
El valor del parámetro dstId debe ser un UUID de 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.extendedCopy("fe51797c-be0b-4076-8f4b-b4fffe8fd2bc", "055e4384-7c70-4456-b32b-f5a55a79861f", true, true, true, true, true, null); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}getChildren
Sección titulada «getChildren»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getChildren(String fldId) | List |
Devuelve una lista con 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.getChildren("055e4384-7c70-4456-b32b-f5a55a79861f")) { System.Console.WriteLine(mail); } } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}isValid
Sección titulada «isValid»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| isValid(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.isValid("50b7a5b9-89d2-430e-bbc9-6a6e01662a71"); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}getPath
Sección titulada «getPath»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getPath(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.getPath("50b7a5b9-89d2-430e-bbc9-6a6e01662a71")); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}createAttachment
Sección titulada «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
Sección titulada «deleteAttachment»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| deleteAttachment(String mailId, String docId) | void | Elimina un adjunto de un correo. |
El valor del parámetro docId puede ser un UUID de documento válido o una ruta.
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
Sección titulada «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
Sección titulada «sendMailWithAttachments»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| sendMailWithAttachments(String from, List String body, List |
Envía un mensaje de correo con un adjunto. |
El valor del parámetro dstId debe ser un UUID de carpeta o expediente, o una ruta. El parámetro dstId indica dónde se guardará el correo en el repositorio tras enviarse.
Otros parámetros:
- to es una lista de direcciones de correo de destino.
- subject es el asunto del correo.
- cc y bcc son listas de direcciones de correo de destino (opcional).
- docsId es una lista de UUIDs de documentos ya existentes en OpenKM que se enviarán como adjuntos en el correo (opcional).
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
Sección titulada «importEml»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| importEml(String dstId, String title, FileStream fs) | Importa un correo en formato EML. |
El valor del parámetro dstId debe ser un UUID de carpeta o expediente, o una ruta. El parámetro dstId indica dónde se guardará 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
Sección titulada «importMsg»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| importMsg(String dstId, String title, FileStream fs) | Importa un correo en formato MSG. |
El valor del parámetro dstId debe ser un UUID de carpeta o expediente, o una ruta. El parámetro dstId indica dónde se guardará 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()); } } }}setTitle
Sección titulada «setTitle»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| setTitle(String mailId, String title) | 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.setTitle("68ed7a93-005c-4ec6-ac01-bb151573c775", "new title"); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}sendMail
Sección titulada «sendMail»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| sendMail(String 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); ws.mail.sendMail("some@none.com", "Testing sending mail", "Test message body."); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}sendMail
Sección titulada «sendMail»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| sendMail(List |
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
Sección titulada «sendMail»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| sendMail(String from, List |
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()); } } }}setNodeClass
Sección titulada «setNodeClass»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| setNodeClass(String mailId, long ncId) | void | Establece la clase de nodo 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.setNodeClass("68ed7a93-005c-4ec6-ac01-bb151573c775", ncId); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}setDescription
Sección titulada «setDescription»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| setDescription(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.setDescription("68ed7a93-005c-4ec6-ac01-bb151573c775", "Any description"); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}getContent
Sección titulada «getContent»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getContent(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.getContent("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()); } } }}getThumbnail
Sección titulada «getThumbnail»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getThumbnail(String mailId, ThumbnailType type) | Stream | Devuelve los datos de la imagen de la miniatura. |
Tipos disponibles:
- ThumbnailType.THUMBNAIL_PROPERTIES (se muestra en la vista de propiedades)
- ThumbnailType.THUMBNAIL_LIGHTBOX (se muestra en el visor emergente)
- ThumbnailType.THUMBNAIL_SEARCH (se muestra en la vista de búsqueda)
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.getThumbnail("68ed7a93-005c-4ec6-ac01-bb151573c775", ThumbnailType.THUMBNAIL_PROPERTIES); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}setDispositionStage
Sección titulada «setDispositionStage»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| setDispositionStage(String uuid, long stage) | void | Establece la etapa de disposición 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); long stage = 1; ws.mail.setDispositionStage("f0064cf3-4776-44c2-868a-f08697a6957e", stage); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}createWizard
Sección titulada «createWizard»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| createWizard(String uuid, String title, FileStream fileStream, String type) | WizardNode | Crea un correo con un asistente. |
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.createWizard(fld.uuid, "Any title", filestream, Mail.ORIGIN_MSG); filestream.Close(); System.Console.WriteLine(wn.toString()); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}getMailsPaginated
Sección titulada «getMailsPaginated»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getMailsPaginated(String context, int offset, int limit, MailFilterQuery filter, String orderColumn, bool orderAsc) | SimpleNodeBaseResultSet | Devuelve una lista paginada de resultados de correos, filtrada por los valores del parámetro MailFilterQuery. |
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);MailFilterQuery filter = new MailFilterQuery(); filter.subject = ""; filter.attachments = AttachmentEnum.ALL; String orderColumn = "subject"; SimpleNodeBaseResultSet simpleNodeBaseResultSet = ws.mail.getMailsPaginated(0, 10, filter, orderColumn, true);
foreach (SimpleNodeBase simpleNodeBase in simpleNodeBaseResultSet) { System.Console.WriteLine(simpleNodeBase.toString()); } } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}getAccounts
Sección titulada «getAccounts»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getAccounts() | 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.getAccounts()) { System.Console.WriteLine(mail.toString()); } } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}getMailMessages
Sección titulada «getMailMessages»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getMailMessages(long accountId, long start) | MailServerMessages | Recupera una lista de mensajes del 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()); } } }}addAccount
Sección titulada «addAccount»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| addAccount(MailAccount mailAccount) | void | Añade 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; ws.mail.addAccount(mailAcount); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}updateAccount
Sección titulada «updateAccount»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| updateAccount(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.updateAccount(mailAcount); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}testAccount
Sección titulada «testAccount»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| testAccount(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.testAccount(mailAcount); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}deleteAccount
Sección titulada «deleteAccount»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| deleteAccount(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.deleteAccount(mailId); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}importMessages
Sección titulada «importMessages»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| importMessages(long mailAccountId, List |
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.importMessages(mailAccountId, messageIds); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}createFilter
Sección titulada «createFilter»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| createFilter(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.createFilter(mailAccountId, filter); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}updateFilter
Sección titulada «updateFilter»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| updateFilter(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.updateFilter(filter); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}deleteFilter
Sección titulada «deleteFilter»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| deleteFilter(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.deleteFilter(filterId); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}createRule
Sección titulada «createRule»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| createRule(long filterId, MailFilterRule rule) | void | Crea una regla para un filtro 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); 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.createRule(filterId, rule); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}updateRule
Sección titulada «updateRule»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| updateRule(MailFilterRule rule) | void | Actualiza 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); 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.updateRule(rule); } } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}deleteRule
Sección titulada «deleteRule»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| deleteRule(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.deleteRule(ruleId); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}getFilterRules
Sección titulada «getFilterRules»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getFilterRules(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.getFilterRules(filterId)) { System.Console.WriteLine(mfrule.toString()); } } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}forwardEmail
Sección titulada «forwardEmail»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| forwardEmail(String uuid, List |
void | Reenvía un correo a una lista de usuarios, roles o direcciones de correo externas. |
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);string mailUuid = "f123a950-0329-4d62-8328-0ff500fd42db"; List<string> users = new List<string>(); users.Add("userTest"); List<string> roles = new List<string>(); roles.Add("ROLE_USER"); List<string> mails = new List<string>(); mails.Add("test@none.com"); ws.mail.forwardEmail(mailUuid, users, roles, mails, "Any message"); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}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()); } } }}saveAsPdf
Sección titulada «saveAsPdf»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| saveAsPdf(String uuid, String newName, bool propertyGroups, bool security) | Document | Guarda el correo como un PDF en el repositorio de OpenKM. |
El valor del parámetro uuid debe ser un UUID de correo.
Cuando el valor del parámetro newName es null, el documento conservará el mismo nombre.
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"); Document docPdf = ws.mail.saveAsPdf(mail.uuid, mail.subject + ".pdf", true, true); System.Console.WriteLine("Document pdf: " + docPdf.path); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}getExtractedText
Sección titulada «getExtractedText»Descripción:
| Método | Valores de retorno | Descripción |
|---|---|---|
| getExtractedText(String uuid) | String | Obtiene el texto extraído. |
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.getExtractedText("50b7a5b9-89d2-430e-bbc9-6a6e01662a71")); } catch (Exception e) { System.Console.WriteLine(e.ToString()); } } }}