OKMMail

Conceptos básicos

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

Consejo

Ejemplo de mailId:

• Usando UUID -> “c52f9ea0-0d6c-45da-bae4-d72b66f42da3”;
• Usando la ruta -> “/okm:root/2937b81d-0b10-4dd0-a426-9acbd80be1c9-some subject”

Sobre el parámetro llamado “fldId”, el valor de este parámetro puede ser el UUID o la ruta de una carpeta válida, o un nodo de tipo expediente (record).

Consejo

Ejemplo de fldId:

• Usando UUID -> “c52f9ea0-0d6c-45da-bae4-d72b66f42da3”;
• Usando la ruta -> “/okm:root/test”

Además, en todos los métodos verá un parámetro llamado “token”. Cuando se accede a la aplicación mediante SOAP, el proceso de inicio de sesión devuelve un token, que se utiliza para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución por defecto de la aplicación debe utilizar el valor “null”, que indica a la aplicación que debe utilizar la “sesión del usuario”.

Consejo

En casos especiales puede “promocionarse a Administrador” utilizando el “token de administrador”.

String systemToken = DbSessionManager.getInstance().getSystemToken();

Métodos

create

Descripción:

Método	Valores devueltos	Descripción
create(String token, Mail mail)	Mail	Crea un nuevo correo y devuelve como resultado un objeto Mail.

Nota

Formatos permitidos para las cuentas de correo:

• “\“John King\” jking@mail.com”
• “jking@mail.com”

Nota

La ruta permitida para el correo es:

MSGID + “-” + sanitized(subject).

Nota

Valores de los tipos MIME:

• Mail.MIME_TEXT para el formato de correo de texto.
• Mail.MIME_HTML para el formato de correo html.

Valores de origen:

• Mail.ORIGIN_MSG para el formato de correo .msg.
• Mail.ORIGIN_EML para el formato de correo .eml.
• Mail.ORIGIN_API para el correo creado desde la API.
• Mail.ORIGIN_POP3 para el correo importado desde una cuenta pop3.
• Mail.ORIGIN_IMAP para el correo importado desde una cuenta imap.

Precaución

El resto de variables de Mail ( mail ) no tendrán ningún efecto en la creación del correo.

• La variable path del parámetro mail debe estar inicializada. Indica la ruta de la carpeta en OpenKM.
• Otras variables obligatorias:

Ejemplo:

package com.openkm;

import java.util.Arrays;
import java.util.Calendar;

import org.owasp.encoder.Encode;

import com.openkm.api.OKMMail;
import com.openkm.bean.Mail;

public class Test {
    public static void main(String[] args) {
        try {
            Mail mail = new Mail();

            // Mail path = msgId + escaped(subject)
            String msgId = "2937b81d-0b10-4dd0-a426-9acbd80be1c9";
            String subject = "some subject";
            String mailPath = "/okm:root/"+ msgId + "-" + escape(subject);
            mail.setPath(mailPath);

            // Other format for mail "some name <no_reply@openkm.com>"
            mail.setFrom("<no_reply@openkm.com>");
            mail.setTo((String[])Arrays.asList("anonymous@gmail.com").toArray());

            // You should set real dates
            mail.setSentDate(Calendar.getInstance());
            mail.setReceivedDate(Calendar.getInstance());
            mail.setContent("some content");
            mail.setMimeType(Mail.MIME_TEXT);
            mail.setSubject(subject);
            mail.setOrigin(Mail.ORIGIN_API);

            // Get only as an approximation of real size for these sample
            mail.setSize(mail.toString().getBytes("UTF-8").length);
            OKMMail.getInstance().create(null, mail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    private static String escape(String name) {
        String ret = cleanup(name);

        // Fix XSS issues
        ret = Encode.forHtml(ret);

        return ret;
    }

    private static String cleanup(String name) {
        String ret = name.replace("/", "");
        ret = ret.replace("*", "");
        ret = ret.replaceAll("\\s+", " ").trim();
        return ret;
    }
}

getProperties

Descripción:

Método	Valores devueltos	Descripción
getProperties(String token, String mailId)	Mail	Devuelve las propiedades del correo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.bean.Mail;

public class Test {
    public static void main(String[] args) {
        try {
            Mail mail = OKMMail.getInstance().getProperties(null, "064ff51a-b815-4f48-a096-b4946876784f");
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createAttachment

Descripción:

Método	Valores devueltos	Descripción
createAttachment(String token, String mailId, String docName, InputStream is)	Document	Añade un adjunto al correo.

Ejemplo:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.poi.util.IOUtils;

import com.openkm.api.OKMMail;
import com.openkm.bean.Document;

public class Test {
    public static void main(String[] args) {
        InputStream is = null;
        try {
            is = new FileInputStream("/home/test/sample.pdf");
            Document doc = OKMMail.getInstance().createAttachment(null, "064ff51a-b815-4f48-a096-b4946876784f", "sample.pdf", is);
            System.out.println(doc);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
    }
}

deleteAttachment

Descripción:

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

Ejemplo:

package com.openkm;

import java.io.InputStream;

import org.apache.poi.util.IOUtils;

import com.openkm.api.OKMMail;

public class Test {
    public static void main(String[] args) {
        InputStream is = null;
        try {
            OKMMail.getInstance().deleteAttachment(null, "064ff51a-b815-4f48-a096-b4946876784f", "f123a950-0329-4d62-8328-0ff500fd42db");
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
    }
}

getAttachments

Descripción:

Método	Valores devueltos	Descripción
getAttachments(String token, String mailId)	List	Devuelve una lista con todos los adjuntos de un correo.

Ejemplo:

package com.openkm;

import java.io.InputStream;

import org.apache.poi.util.IOUtils;

import com.openkm.api.OKMMail;
import com.openkm.bean.Document;

public class Test {
    public static void main(String[] args) {
        InputStream is = null;
        try {
            for (Document doc : OKMMail.getInstance().getAttachments(null, "064ff51a-b815-4f48-a096-b4946876784f")) {
                System.out.println(doc);
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
    }
}

delete

Descripción:

Método	Valores devueltos	Descripción
delete(String token, String mailId)	void	Elimina un correo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.bean.Folder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMMail.getInstance().delete(null, "064ff51a-b815-4f48-a096-b4946876784f");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purge

Descripción:

Método	Valores devueltos	Descripción
purge(String token, String mailId)	void	El correo se elimina definitivamente del repositorio.

Precaución

Cuando se purga un correo, solo podrá restaurarse a partir de una copia de seguridad previa del repositorio. La acción de purga elimina el correo definitivamente del repositorio.

• Normalmente purgará correos de /okm:trash/userId (las ubicaciones de la papelera personal del usuario), pero es posible purgar directamente cualquier correo de todo el repositorio.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;

public class Test {
    public static void main(String[] args) {
        try {
            OKMMail.getInstance().purge(null, "064ff51a-b815-4f48-a096-b4946876784f");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

rename

Descripción:

Método	Valores devueltos	Descripción
rename(String token, String mailId, String newName)	Mail	Renombra un correo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.bean.Folder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMMail.getInstance().rename(null, "064ff51a-b815-4f48-a096-b4946876784f", "newname");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

move

Descripción:

Método	Valores devueltos	Descripción
move(String token, String mailId, String dstId)	void	Mueve un correo a una carpeta o expediente.

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.bean.Folder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMMail.getInstance().move(null, "064ff51a-b815-4f48-a096-b4946876784f", "/okm:root/move/destination");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copy

Descripción:

Método	Valores devueltos	Descripción
copy(String token, String mailId, String dstId)	void	Copia un correo en una carpeta o expediente.

Precaución

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

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

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.bean.Folder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMMail.getInstance().copy(null, "064ff51a-b815-4f48-a096-b4946876784f", "/okm:root/move/destination");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copy

Descripción:

Método	Valores devueltos	Descripción
copy(String token, String mailId, String dstId, String newName)	void	Copia un correo en una carpeta o expediente.

Precaución

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

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

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.bean.Folder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMMail.getInstance().copy(null, "064ff51a-b815-4f48-a096-b4946876784f", "/okm:root/move/destination", "newname");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extendedCopy

Descripción:

Método	Valores devueltos	Descripción
extendedCopy(String token, String mailId, String dstId, ExtendedAttributes extAttr)	void	Copia un correo con los datos asociados en una carpeta o expediente.

Nota

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

Parámetros de atributos extendidos adicionales:

• 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 propertyGroups 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 copiarán los valores originales de la wiki.

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.bean.ExtendedAttributes;

public class Test {
    public static void main(String[] args) {
        try {
            ExtendedAttributes extAttr = new ExtendedAttributes();
            extAttr.setKeywords(true);
            OKMMail.getInstance().extendedCopy(null, "064ff51a-b815-4f48-a096-b4946876784f","/okm:root/test", extAttr);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extendedCopy

Descripción:

Método	Valores devueltos	Descripción
extendedCopy(String token, String mailId, String dstId, ExtendedAttributes extAttr, String newName)	void	Copia un correo con los datos asociados en una carpeta o expediente.

Nota

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

Parámetros de atributos extendidos adicionales:

• 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 propertyGroups 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 copiarán los valores originales de la wiki.

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.bean.ExtendedAttributes;

public class Test {
    public static void main(String[] args) {
        try {
            ExtendedAttributes extAttr = new ExtendedAttributes();
            extAttr.setKeywords(true);
            OKMMail.getInstance().extendedCopy(null, "064ff51a-b815-4f48-a096-b4946876784f","/okm:root/test", extAttr, "new_name");

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChilds

Descripción:

Método	Valores devueltos	Descripción
getChilds(String token, String fldId)	List	Devuelve una lista con todos los correos cuyo padre es mailId.

Peligro

Este método está obsoleto en favor del método getChildren. Le recomendamos no utilizarlo, porque se eliminará en un futuro próximo.

• El parámetro mailId puede ser una carpeta o un nodo de tipo expediente (record).

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.bean.Mail;

public class Test {
    public static void main(String[] args) {
        try {
            for (Mail mail : OKMMail.getInstance().getChilds(null, "/okm:root/test")) {
                System.out.println(mail);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildren

Descripción:

Método	Valores devueltos	Descripción
getChildren(String token, String fldId)	List	Devuelve una lista con todos los correos cuyo padre es mailId.

• El parámetro mailId puede ser una carpeta o un nodo de tipo expediente (record).

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.bean.Mail;

public class Test {
    public static void main(String[] args) {
        try {
            for (Mail mail : OKMMail.getInstance().getChildren(null, "/okm:root/test")) {
                System.out.println(mail);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isValid

Descripción:

Método	Valores devueltos	Descripción
isValid(String token, String mailId)	boolean	Devuelve un valor booleano que indica si el nodo es un correo o no.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;

public class Test {
    public static void main(String[] args) {
        try {
            boolean valid =  OKMMail.getInstance().isValid(null, "064ff51a-b815-4f48-a096-b4946876784f");
            System.out.println(valid);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPath

Descripción:

Método	Valores devueltos	Descripción
getPath(String token, String uuid)	String	Convierte el UUID de una carpeta en la ruta de un correo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;

public class Test {
    public static void main(String[] args) {
        try {
            String path =  OKMMail.getInstance().getPath(null, "064ff51a-b815-4f48-a096-b4946876784f");
            System.out.println(path);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

sendMail

Descripción:

Método	Valores devueltos	Descripción
sendMail(String token, List recipients, String subject, String body)	void	Envía un correo.

Ejemplo:

package com.openkm;

import java.util.ArrayList;
import java.util.List;

import com.openkm.api.OKMMail;

public class Test {
    public static void main(String[] args) {
        try {
            StringBuffer body = new StringBuffer();
            body.append("Test message body.");
            List<String> recipients = new ArrayList<>();
            recipients.add("some@mail.com");
            OKMMail.getInstance().sendMail(null, recipients, "Testing sending mail from OpenKM", body.toString());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setTitle

Descripción:

Método	Valores devueltos	Descripción
setTitle(String token, String mailId, String title)	void	Establece el título del correo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;

public class Test {
    public static void main(String[] args) {
        try {
            OKMMail.getInstance().setTitle(null, "064ff51a-b815-4f48-a096-b4946876784", "new title");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

sendMailWithAttachments

Descripción:

Método	Valores devueltos	Descripción
sendMailWithAttachments(String token, List toRecipients, String subject, String body, List docsId, String dstId)	Mail	Envía un mensaje de correo con adjuntos.

• Los valores del parámetro dstId deben ser el UUID o la ruta de una carpeta o de un expediente. El parámetro dstId indica dónde se almacenará el correo en el repositorio una vez enviado.
• Otros parámetros:

Ejemplo:

package com.openkm;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import com.openkm.api.OKMMail;
import com.openkm.bean.Mail;

public class Test {
    public static void main(String[] args) {
        try {
            List<String> toRecipients = Arrays.asList("destination@mail.com");
            List<String> docsId = Arrays.asList("f123a950-0329-4d62-8328-0ff500fd42db","/okm:root/logo.png");
            Mail mail = OKMMail.getInstance().sendMailWithAttachments(null, toRecipients, "some subject", "some body", docsId, "/okm:root/tmp");
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

sendMailWithAttachments

Descripción:

Método	Valores devueltos	Descripción
sendMailWithAttachments(String token, List toRecipients, List ccRecipients, List bccRecipients, String subject,             String body, List docsId, String dstId)	Mail	Envía un mensaje de correo con adjuntos.

• Los valores del parámetro dstId deben ser el UUID o la ruta de una carpeta o de un expediente. El parámetro dstId indica dónde se almacenará el correo en el repositorio una vez enviado.
• Otros parámetros:

Ejemplo:

package com.openkm;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import com.openkm.api.OKMMail;
import com.openkm.bean.Mail;

public class Test {
    public static void main(String[] args) {
        try {
            List<String> toRecipients = Arrays.asList("destination@mail.com");
            List<String> ccRecipients = new ArrayList<>();
            List<String> bccRecipients = new ArrayList<>();
            List<String> docsId = Arrays.asList("f123a950-0329-4d62-8328-0ff500fd42db","/okm:root/logo.png");
            Mail mail = OKMMail.getInstance().sendMailWithAttachments(null, toRecipients, ccRecipients, bccRecipients, "some subject", "some body", docsId, "/okm:root/tmp");
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

sendMailWithAttachments

Descripción:

Método	Valores devueltos	Descripción
sendMailWithAttachments(String token, List toRecipients, List ccRecipients, List bccRecipients,             List replyToMails, String subject, String body, List docsId, String dstId)	Mail	Envía un mensaje de correo con adjuntos.

• Los valores del parámetro dstId deben ser el UUID o la ruta de una carpeta o de un expediente. El parámetro dstId indica dónde se almacenará el correo en el repositorio una vez enviado.
• Otros parámetros:

Ejemplo:

package com.openkm;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import com.openkm.api.OKMMail;
import com.openkm.bean.Mail;

public class Test {
    public static void main(String[] args) {
        try {
            List<String> toRecipients = Arrays.asList("destination@mail.com");
            List<String> ccRecipients = new ArrayList<>();
            List<String> bccRecipients = new ArrayList<>();
            List<String> replyToMails = new ArrayList<>();
            List<String> docsId = Arrays.asList("f123a950-0329-4d62-8328-0ff500fd42db","/okm:root/logo.png");
            Mail mail = OKMMail.getInstance().sendMailWithAttachments(null, toRecipients, ccRecipients, bccRecipients, replyToMails, "some subject", "some body", docsId, "/okm:root/tmp");
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

importEml

Descripción:

Método	Valores devueltos	Descripción
importEml(String path, String title, InputStream is)	Mail	Importa un correo en formato EML.

• Los valores del parámetro path deben ser la ruta de una carpeta o de un expediente. El parámetro path indica dónde se almacenará el correo en el repositorio una vez importado.

Ejemplo:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

import com.openkm.api.OKMMail;
import com.openkm.bean.Mail;

public class Test {
    public static void main(String[] args) {
        InputStream is = null;
        try {
            is = new FileInputStream("/home/files/test.eml");
            Mail mail = OKMMail.getInstance().importEml("d88cff0d-903a-4c5a-82ea-8e6dbd100d65", "some title", is);
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
    }
}

importMsg

Descripción:

Método	Valores devueltos	Descripción
importMsg(String path, String title, InputStream is)	Mail	Importa un correo en formato MSG.

• Los valores del parámetro path deben ser la ruta de una carpeta o de un expediente. El parámetro path indica dónde se almacenará el correo en el repositorio una vez importado.

Ejemplo:

package com.openkm;

import java.io.FileInputStream;
import java.io.InputStream;

import org.apache.commons.io.IOUtils;

import com.openkm.api.OKMMail;
import com.openkm.bean.Mail;

public class Test {
    public static void main(String[] args) {
        InputStream is = null;
        try {
            is = new FileInputStream("/home/files/test.msg");
            Mail mail = OKMMail.getInstance().importMsg("d88cff0d-903a-4c5a-82ea-8e6dbd100d65", "some title", is);
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
    }
}