OKMMail

Conceptos básicos

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

Consejo

Ejemplo de mailId:

• Usando UUID -> “0747c0cb-5e4a-4088-92a9-ab97b401af75”;

Respecto al parámetro llamado “fldId”, el valor de este parámetro puede ser un UUID de carpeta o de nodo de expediente válido.

Consejo

Ejemplo de fldId:

• Usando UUID -> “b67fe3ae-bcca-4947-b8ea-0cc7aedd4474”;

Además, en todos los métodos verá un parámetro llamado “token”. Como la tarea de Cron se ejecuta en segundo plano sin autenticación, los métodos usados en ese escenario podrían usar el parámetro token. Desde el contexto de ejecución por defecto de la aplicación, debe usar el valor “null”, que indica que la aplicación debe usar la “sesión del usuario”.

Consejo

En casos especiales puede ser “promovido a Administrador” usando el “token de administrador”.

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

Métodos

create

Descripción:

Método	Valores de retorno	Descripción
create(String token, Mail mail, InputStream is)	Mail	Crea un nuevo nodo de correo a partir de un bean Mail y un input stream.

• El bean mail debe tener el path establecido a una ruta de carpeta o expediente válida donde se almacenará el correo.
• El parámetro is es el contenido binario del correo (formato EML o MSG).

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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        InputStream is = null;
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            is = new FileInputStream("/home/openkm/message.eml");
            Mail mail = new Mail();
            mail.setPath("/okm:root/test/message.eml");
            Mail newMail = okmMail.create(null, mail, is);
            System.out.println(newMail);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
    }
}

getProperties

Descripción:

Método	Valores de retorno	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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            Mail mail = okmMail.getProperties(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75");
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createAttachment

Descripción:

Método	Valores de retorno	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.commons.io.IOUtils;

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

public class Test {

    public static void main(String[] args) {
        InputStream is = null;
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            is = new FileInputStream("/home/openkm/sample.pdf");
            Document doc = okmMail.createAttachment(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", "sample.pdf", is);
            System.out.println(doc);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
    }
}

deleteAttachment

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            okmMail.deleteAttachment(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", "c98d704f-c9f2-4f75-9923-878300b36b52");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAttachments

Descripción:

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

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            for (Document doc : okmMail.getAttachments(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75")) {
                System.out.println(doc);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

delete

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            okmMail.delete(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purge

Descripción:

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

Precaución

Cuando se purga un correo, solo podrá restaurarse desde una copia de seguridad anterior del repositorio. La acción de purga elimina el correo del repositorio de forma permanente.

• Normalmente purgará correos ubicados en /okm:trash/userId — 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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            okmMail.purge(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

rename

Descripción:

Método	Valores de retorno	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.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            okmMail.rename(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", "newname");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

move

Descripción:

Método	Valores de retorno	Descripción
move(String token, String mailId, 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:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            okmMail.move(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", "3636f3bb-779c-4851-b145-0d53e0702b0f");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copy

Descripción:

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

Precaución

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

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

• El valor del parámetro dstId debe ser un UUID de carpeta o expediente.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            okmMail.copy(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", "3636f3bb-779c-4851-b145-0d53e0702b0f");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copy

Descripción:

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

Precaución

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

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

• 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:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            okmMail.copy(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", "3636f3bb-779c-4851-b145-0d53e0702b0f", "newname");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extendedCopy

Descripción:

Método	Valores de retorno	Descripción
extendedCopy(String token, String mailId, String dstId, ExtendedAttributes extAttr)	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. del correo no se copian.

Parámetros adicionales de atributos extendidos:

• 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 del wiki.

• El valor del parámetro dstId debe ser un UUID de carpeta o expediente.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            ExtendedAttributes extAttr = new ExtendedAttributes();
            extAttr.setNotes(true);
            extAttr.setKeywords(true);
            extAttr.setCategories(true);
            extAttr.setPropertyGroups(true);
            okmMail.extendedCopy(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", "3636f3bb-779c-4851-b145-0d53e0702b0f", extAttr);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extendedCopy

Descripción:

Método	Valores de retorno	Descripción
extendedCopy(String token, String mailId, String dstId, ExtendedAttributes extAttr, 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. del correo no se copian.

Parámetros adicionales de atributos extendidos:

• 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 del wiki.

• 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:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            ExtendedAttributes extAttr = new ExtendedAttributes();
            extAttr.setNotes(true);
            extAttr.setKeywords(true);
            extAttr.setCategories(true);
            extAttr.setPropertyGroups(true);
            okmMail.extendedCopy(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", "3636f3bb-779c-4851-b145-0d53e0702b0f", extAttr, "new_name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildren

Descripción:

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

• El parámetro fldId puede ser un nodo de carpeta o de expediente.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            for (Mail mail : okmMail.getChildren(null, "3636f3bb-779c-4851-b145-0d53e0702b0f")) {
                System.out.println(mail);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isValid

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            boolean valid = okmMail.isValid(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75");
            System.out.println(valid);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPath

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            String path = okmMail.getPath(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75");
            System.out.println(path);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

sendMail

Descripción:

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

Precaución

Este método está obsoleto. Use en su lugar sendMail(String token, String from, List recipients, String subject, String body).

Ejemplo:

package com.openkm;

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

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

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

sendMail (con from)

Descripción:

Método	Valores de retorno	Descripción
sendMail(String token, String from, List recipients, String subject, String body)	void	Envía un correo especificando la dirección del remitente.

• Use esta sobrecarga para especificar una dirección from personalizada para el correo saliente.

Ejemplo:

package com.openkm;

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

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

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

setTitle

Descripción:

Método	Valores de retorno	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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            okmMail.setTitle(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", "new title");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

sendMailWithAttachments

Descripción:

Método	Valores de retorno	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 adjunto.

• El valor del parámetro dstId debe ser un UUID de carpeta o expediente. El parámetro dstId indica dónde se almacenará el correo en el repositorio después de enviarse.
• 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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            List<String> toRecipients = Arrays.asList("gnujavasergio@mail.com");
            List<String> ccRecipients = new ArrayList<>();
            List<String> bccRecipients = new ArrayList<>();
            List<String> replyToMails = new ArrayList<>();
            List<String> docsId = Arrays.asList("b153c4b7-3d1c-4589-bd42-0ed0f34fd338", "d168924d-e801-426d-a222-00124a1461bd");

            Mail mail = okmMail.sendMailWithAttachments(null, toRecipients, ccRecipients, bccRecipients, replyToMails,
                    "some subject", "some body", docsId, "b67fe3ae-bcca-4947-b8ea-0cc7aedd4474");
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

sendMailWithAttachments (con from)

Descripción:

Método	Valores de retorno	Descripción
sendMailWithAttachments(String token, String from, List toRecipients, List ccRecipients, List bccRecipients, List replyToMails, String subject, String body, List docsId, String dstId)	Mail	Envía un mensaje de correo con adjunto, especificando la dirección del remitente.

• El parámetro from establece una dirección de remitente personalizada para el correo saliente.
• El valor del parámetro dstId debe ser un UUID de carpeta o expediente. El parámetro dstId indica dónde se almacenará el correo en el repositorio después de enviarse.
• 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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            String from = "sender@example.com";
            List<String> toRecipients = Arrays.asList("gnujavasergio@mail.com");
            List<String> ccRecipients = new ArrayList<>();
            List<String> bccRecipients = new ArrayList<>();
            List<String> replyToMails = new ArrayList<>();
            List<String> docsId = Arrays.asList("b153c4b7-3d1c-4589-bd42-0ed0f34fd338");

            Mail mail = okmMail.sendMailWithAttachments(null, from, toRecipients, ccRecipients, bccRecipients, replyToMails,
                    "some subject", "some body", docsId, "b67fe3ae-bcca-4947-b8ea-0cc7aedd4474");
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

importEml

Descripción:

Método	Valores de retorno	Descripción
importEml(String token, String fldId, String title, InputStream is)	Mail	Importa un correo en formato EML.

• El valor del parámetro fldId debe ser un UUID de carpeta o expediente. El parámetro fldId indica dónde se almacenará el correo en el repositorio después de importarse.

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;
import com.openkm.util.ContextWrapper;

public class Test {

  public static void main(String[] args) {
    InputStream is = null;
        try {
          OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            is = new FileInputStream("/home/openkm/sample1.eml");
            Mail mail = okmMail.importEml(null, "b67fe3ae-bcca-4947-b8ea-0cc7aedd4474", "some title", is);
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
  }
}

importMsg

Descripción:

Método	Valores de retorno	Descripción
importMsg(String token, String fldId, String title, InputStream is)	Mail	Importa un correo en formato MSG.

• El valor del parámetro fldId debe ser un UUID de carpeta o expediente. El parámetro fldId indica dónde se almacenará el correo en el repositorio después de importarse.

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;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        InputStream is = null;
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            is = new FileInputStream("/home/openkm/test subject.msg");
            Mail mail = okmMail.importMsg(null, "b67fe3ae-bcca-4947-b8ea-0cc7aedd4474", "some title", is);
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            IOUtils.closeQuietly(is);
        }
    }
}

setNodeClass

Descripción:

Método	Valores de retorno	Descripción
setNodeClass(String token, String uuid, long ncId)	void	Establece el NodeClass.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            long ncId = 2;
            okmMail.setNodeClass(null, "7ce1b4a8-4ade-4dce-8d7d-4e99a6cd368b", ncId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setDispositionStage

Descripción:

Método	Valores de retorno	Descripción
setDispositionStage(String token, String uuid, long stage)	void	Establece la etapa de disposición

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            long stage = 1;
            okmMail.setDispositionStage(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", stage);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setDescription

Descripción:

Método	Valores de retorno	Descripción
setDescription(String token, String uuid, String description)	void	Establece la descripción.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            okmMail.setDescription(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75", "some description");
            Mail mail = okmMail.getProperties(null, "0747c0cb-5e4a-4088-92a9-ab97b401af75");
            System.out.println(mail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getContent

Descripción:

Método	Valores de retorno	Descripción
getContent(String token, String mailId)	InputStream	Recupera el contenido del correo (datos binarios).

Ejemplo:

package com.openkm;

import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;

import org.apache.commons.io.IOUtils;

import com.openkm.api.OKMMail;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            OutputStream fos = new FileOutputStream("/home/openkm/test.eml");
            InputStream is = okmMail.getContent(null, "b405a504-d8cb-4166-ac51-22f68acee8c5");
            IOUtils.copy(is, fos);
            IOUtils.closeQuietly(is);
            IOUtils.closeQuietly(fos);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createWizard

Descripción:

Método	Valores de retorno	Descripción
createWizard(String token, String path, String title, InputStream is, String type)	WizardNode	Crea un nuevo correo con un wizard.

Nota

El WizardNode contiene una lista de acciones pendientes que deben realizarse para completar el proceso de creación del documento. Estas pueden ser:

• Añadir palabra clave
• Añadir categorías
• Añadir metadatos

• El parámetro path debe ser cualquier PATH de carpeta o expediente válido.
• Tipos disponibles:

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;
import com.openkm.bean.WizardNode;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            InputStream is = new FileInputStream("/home/openkm/sample2.eml");
            WizardNode wn = okmMail.createWizard(null, "/okm:root/test", "test title", is, Mail.ORIGIN_EML);
            System.out.print(wn);
            IOUtils.closeQuietly(is);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getExtractedText

Descripción:

Método	Valores de retorno	Descripción
getExtractedText(String token, String uuid)	String	Devuelve un String con el texto extraído por el proceso de extracción de texto.

Precaución

Lamentablemente no hay forma directa de saber desde la API si un documento se ha procesado o no, porque esta información solo se almacena a nivel de base de datos.

A pesar de esta restricción, solo los usuarios administradores pueden realizar consultas a la base de datos desde la API para recuperar esta información. Consulte Repository samples para acceder a información a nivel de base de datos.

Nota

Más información en Statistics.

• Cuando se sube un documento a OpenKM, entra en la cola de extracción de texto. Hay una tarea de crontab que procesa esta cola periódicamente y extrae el contenido de los documentos.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMMail;import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            String text = okmMail.getExtractedText(null, "46762f90-82c6-4886-8d21-ad3017dd78a7");
            System.out.println(text);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

forwardEmail

Descripción:

Método	Valores de retorno	Descripción
forwardEmail(String token, String uuid, List users, List roles, List mails, String message)	Mail	Reenvía un correo a una lista de usuarios, roles o direcciones de correo externas.

Ejemplo:

package com.openkm;

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

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMMail okmMail = ContextWrapper.getContext().getBean(OKMMail.class);
            String mailUuid = "f123a950-0329-4d62-8328-0ff500fd42db";
            List<String> users = new ArrayList<>();
            users.add("userTest");
            List<String> roles = new ArrayList<>();
            roles.add("ROLE_USER");
            List<String> mails = new ArrayList<>();
            mails.add("test@none.com");

            Mail forwardedMail = okmMail.forwardEmail(null, mailUuid, users, roles, mails, "Any message");
            System.out.println(forwardedMail);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}