Subsecciones del 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, puede enviar los correos electrónicos directamente desde su aplicación, sin pasar por SMTP (Protocolo simple de transferencia de correo). Actualmente, solo admitimos solicitudes POST.
Dirección del servidor:
https://rsXXX-api.realsender.com/mail/send
Parámetros requeridos/obligatorios:
| Parámetro |
Descripción |
| usuario de API |
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 |
| sujeto |
asunto del correo electrónico |
| texto |
Cuerpo del correo electrónico en texto plano |
| html |
Cuerpo del correo electrónico en formato HTML |
Si todo está correcto, se enviará el mensaje y recibirá una respuesta JSON positiva:
{"success":true}
En caso de errores, obtendrá algo como esto:
{"success":false,"errorMsgs":["Por favor, proporcione el valor de 'subject'."]}
Detalles de la API
detalles de la API
El contenido debe enviarse utilizando la codificación internacional UTF-8.
Para comprobarlo, añada «€uro» al asunto y envíelo. Si la codificación es incorrecta, recibirá esta advertencia JSON:
{"success":false,"errorMsgs":["El valor de 'subject' no está codificado correctamente. Debe estar codificado en UTF-8."]}
Dependiendo de si ha 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/plano (solo texto) |
| html |
texto/html (solo HTML) |
| texto+html |
multipart/alternative (tanto texto como html) determinará qué parte se muestra. |
Parámetros no obligatorios/opcionales:
| Parámetro |
Descripción |
| denombre |
Descripción del remitente |
| para nombrar |
descripción del destinatario |
| responder |
Dirección de correo electrónico que recibirá las respuestas |
| ruta de retorno |
La dirección de correo electrónico que recibirá los correos rebotados debe figurar entre los remitentes autorizados de RealSender. |
| cc |
dirección de correo electrónico de copia carbón |
| nombre de la cuenta |
Descripción de la copia carbón |
| bcc |
dirección de correo electrónico con copia oculta |
| nombre_de_ccc |
Descripción de la copia carbón oculta |
| adjuntar |
Archivo(s) a adjuntar: puede(n) estar presente(s) varias veces en el formulario; peso máximo de 3 MB; el contenido del archivo debe ser parte de la solicitud HTTP POST multipart; se requiere enctype=“multipart/form-data” para INPUT TYPE=FILE |
Los campos Para, CC y CCO pueden contener una única dirección de correo electrónico o una lista de direcciones de correo electrónico separadas por comas.
En RealSender, el número total de destinatarios de cada correo electrónico está limitado a 25 (puede aumentarse hasta 100).
Las respuestas del servidor están en formato JSON (JavaScript Object Notation):
| Descripción |
Respuesta |
| Correo electrónico enviado |
{"éxito":verdadero} |
| Correo electrónico NO enviado |
{"éxito":falso,"errorMsgs":["..."]} |
Ejemplos de API
ejemplos de API
Método sin CURL para solicitudes POST con PHP
<?php $url = 'https://rsXXX-api.realsender.com/mail/send'; $data = array('apiuser' =>'el que te proporcionamos', 'apipass' => 'el que te proporcionamos', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => 'asunto del mensaje', 'text' => 'cuerpo del correo electrónico en texto plano', 'html' => 'cuerpo del correo electrónico en formato HTML'); // usa la clave 'http' incluso si envías la solicitud a 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); ?>
Método CURL para solicitud POST
curl -d 'apiuser=el que te proporcionamos&apipass=el que te proporcionamos&from=sender@example.com&to=recipient@example.com&subject=asunto del mensaje&text=cuerpo del correo electrónico en texto plano&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áximo 5: adjunto1, adjunto2, …)
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' => 'el que te proporcionamos', 'apipass' => 'el que te proporcionamos', 'from' => 'sender@example.com', 'to' => 'recipient@example.com', 'subject' => 'asunto del mensaje', 'text' => 'cuerpo del correo electrónico en texto plano', 'html' => 'cuerpo del correo electrónico en formato HTML'); 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 mediante
el método CURL.
curl -F 'apiuser=el que te proporcionamos' \ -F 'apipass=el que te proporcionamos' \ -F 'from=sender@example.com' \ -F 'to=recipient@example.com' \ -F 'subject=asunto del mensaje' \ -F 'text=cuerpo del correo electrónico en texto plano' \ -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