Subsecciones sobre el envío a través de la API

Descripción general de la API

RealSender te permite enviar mensajes de correo electrónico a través de una API (interfaz de programación de aplicaciones).

De esta forma, puedes enviar los correos electrónicos directamente desde tu aplicación, sin pasar por el protocolo SMTP (Simple Mail Transfer Protocol). Actualmente solo admitimos solicitudes POST.


Dirección del servidor:
https://rsXXX-api.realsender.com/mail/send


Parámetros obligatorios:

Parámetro
Descripción
apiuser nombre de usuario de autenticación
apipass contraseña de autenticación
de dirección de correo electrónico del remitente
a dirección de correo electrónico del destinatario
tema asunto del correo electrónico
texto cuerpo del correo electrónico en texto sin formato
html Cuerpo del correo electrónico en formato HTML

Si todo va bien, el mensaje se enviará y recibirás una respuesta JSON positiva:
{"success":true}

Si se producen errores, aparecerá un mensaje similar a este:
{"success":false,"errorMsgs":["Please provide the 'subject' value."]}


Detalles de la API

Detalles de la API

El contenido debe enviarse utilizando el juego de caracteres internacional UTF-8.
Para comprobarlo, añade «€uro» en el asunto y envíalo. Si el juego de caracteres es incorrecto, recibirás esta advertencia en formato JSON:

{"success":false,"errorMsgs":["The 'subject' value is not correctly encoded. It must be UTF-8 encoded."]}


Dependiendo de si has rellenado uno o ambos campos, «texto» y «html», los mensajes se enviarán utilizando uno de estos «Content-Type»:

Parámetro
Descripción
texto texto sin formato (solo texto)
html texto/html (solo html)
texto+html multipart/alternative (tanto texto como HTML)
: la configuración del cliente de correo electrónico determinará qué parte se muestra

Parámetros no obligatorios/opcionales:

Parámetro
Descripción
nombre de origen descripción del remitente
toname descripción del destinatario
responder a dirección de correo electrónico en la que se recibirán las respuestas
ruta de retorno La dirección de correo electrónico que recibirá los mensajes devueltos es
; debe figurar entre los remitentes autorizados de RealSender.
cc dirección de correo electrónico en copia
ccname descripción de la copia al carbón
CCO dirección de correo electrónico en copia oculta
nombre de copia oculta Descripción de la copia oculta
adjuntar archivo(s) que se adjuntarán: puede aparecer varias veces en el formulario; tamaño máximo: 3 MB
el contenido del archivo debe formar parte de la solicitud HTTP POST multiparte
se requiere el atributo «enctype=“multipart/form-data”» para el elemento INPUT TYPE=FILE

Los campos «Para», «CC» y «CCO» pueden contener una sola dirección de correo electrónico o una lista de direcciones separadas por comas.
!! En RealSender, el número total de destinatarios por cada correo electrónico está limitado a 25 (se puede aumentar hasta 100).


Las respuestas del servidor están en formato JSON (JavaScript Object Notation):

Descripción
Respuesta
correo electrónico enviado {"success":true}
El correo electrónico NO se ha enviado {"success":false,"errorMsgs":["..."]}

Ejemplos de API

Ejemplos de API

Solicitud POST a
Método sin CURL con PHP

<?php
$url = 'https://rsXXX-api.realsender.com/mail/send';
$data = array('apiuser' => 'the one we provided you', 'apipass' => 'the one we provided you', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => 'subject of the message', 'text' => 'email body in plain text', 'html' => 'email body in HTML format');

// use key 'http' even if you send the request to https://...
$options = array(
    'http' => array(
        'header'  => "Content-type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data),
    ),
);
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);

var_dump($result);
?>

Solicitud POST
Método CURL

curl -d 'apiuser=el que te hemos facilitado&apipass=el que te hemos facilitado you&from=sender@example.com&to=recipient@example.com&subject=asunto del mensaje&text=cuerpo del correo electrónico en texto sin formato&html=cuerpo del correo electrónico en formato HTML'https://rsXXX-api.realsender.com/mail/send

Ejemplos de API con archivos adjuntos

Ejemplos de API con archivos adjuntos

Solicitud POST con archivos adjuntos (máx. 5: attach1, attach2, …)
Método sin CURL con PHP

<?php
require_once 'HTTP/Request2.php';

$config = array('use_brackets' => false,
               );

$request = new HTTP_Request2('https://rsXXX-api.realsender.com/mail/send',
                             HTTP_Request2::METHOD_POST,
                             $config);

$data = array('apiuser' => 'the one we provided you',
              'apipass' => 'the one we provided you',
              'from' => 'sender@example.com',
              'to' => 'recipient@example.com',
              'subject' => 'subject of the message',
              'text' => 'email body in plain text',
              'html' => 'email body in HTML format');
foreach ($data as $k => $d) {
    $request->addPostParameter($k, $d);
};
$request->addUpload('attach1', './sample.pdf', 'sample.pdf', 'application/pdf');
$request->addUpload('attach2', './sample.txt', 'sample.txt', 'text/plain');

$result  = $request->send();
var_dump($result);
?>

Solicitud POST con archivos adjuntos
Método CURL

curl -F 'apiuser=el que te hemos facilitado' \
      -F 'apipass=el que te hemos facilitado' \
      -F 'from=sender@example.com' \
      -F 'to=recipient@example.com' \
      -F 'subject=asunto del mensaje' \
      -F 'text=cuerpo del correo electrónico en texto sin formato' \
      -F 'html=cuerpo del correo electrónico en formato HTML' \
      -F 'attach=@sample.pdf;type=application/pdf' \
      -F 'attach=@sample.txt;type=text/plain' \
      https://rsXXX-api.realsender.com/mail/send