version 4.3.6

jasp402 · May 10, 2024 · 8b291fd · 8b291fd
1 parent 575778a
commit 8b291fd
Show file tree

Hide file tree

Showing 76 changed files with 553 additions and 53 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@
 /.cache/
 /qodana.yaml
 /todo.txt
+!/qodana.yaml
diff --git a/Writerside/c.list b/Writerside/c.list
@@ -2,5 +2,7 @@
 <!DOCTYPE categories
         SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
 <categories>
-    <category id="wrs" name="Writerside documentation" order="1"/>
+    <category id="external" name="External Information" order="1"/>
+    <category id="related" name="Related Articles" order="2"/>
+    <category id="wrs" name="Other Projects" order="3"/>
 </categories>
diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml
@@ -1,13 +1,36 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <sitemap priority="0.35" change-frequency="monthly"/>
 
-    <variables></variables>
+    <variables>
+        <custom-favicons>favico-48.ico</custom-favicons>
+        <header-logo>logo.png</header-logo>
+        <download-title>NPM Documentation</download-title>
+        <download-page>https://www.npmjs.com/package/easy-yopmail</download-page>
+        <showDownloadButton>true</showDownloadButton>
+        <primary-color>dracula</primary-color>
+    </variables>
     <build-profile instance="e">
+
         <variables>
-            <noindex-content>true</noindex-content>
-            <offline-docs>false</offline-docs>
+            <noindex-content>false</noindex-content>
+            <offline-docs>true</offline-docs>
         </variables>
     </build-profile>
+    <footer>
+        <copyright>Jasp402 | 2020-2024</copyright>
+
+        <social type="blog" href="link to a blog"></social>
+        <social type="twitter" href="link to a Twitter account"></social>
+        <social type="youtube" href="link to a Twitter account"></social>
+        <social type="linkedin" href="link to a Facebook account"></social>
+        <social type="email" href="link to a Facebook account"></social>
+
+        <link href="https://slack.example.com">Slack community</link>
+        <link href="https://stackoverflow.com">StackOverflow</link>
+        <link href="https://example.com/terms-an-conditions.html">Terms and conditions</link>
+        <link href="https://example.com/code-of-conduct.html">Code of Conduct</link>
+    </footer>
 
 </buildprofiles>
diff --git a/Writerside/cfg/glossary.xml b/Writerside/cfg/glossary.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE terms SYSTEM "https://resources.jetbrains.com/writerside/1.0/glossary.dtd">
+<terms>
+    <term name="GUI">Graphical User Interface</term>
+    <term name="tooltip">Tooltips show a definition when a user hovers over a term.</term>
+    <term name="runkit">This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including easy-yopmail.</term>
+</terms>
diff --git a/Writerside/e.tree b/Writerside/e.tree
@@ -5,6 +5,23 @@
 <instance-profile id="e"
                  name="EasyYopmail"
                  start-page="starter-topic.md">
-
     <toc-element topic="starter-topic.md"/>
+    <toc-element toc-title="Emails">
+        <toc-element topic="getMail.md"/>
+    </toc-element>
+    <toc-element toc-title="Inbox">
+        <toc-element topic="getInbox.md"/>
+        <toc-element topic="deleteInbox.md"/>
+    </toc-element>
+    <toc-element toc-title="Message">
+        <toc-element topic="readMessage.md"/>
+        <toc-element topic="writeMessage.md"/>
+        <toc-element topic="deleteMessage.md"/>
+    </toc-element>
+    <toc-element topic="Improvements.md"/>
+    <toc-element toc-title="Latest News">
+        <toc-element topic="Announcements.md"/>
+        <toc-element topic="Blog.md"/>
+    </toc-element>
+    <toc-element topic="Sponsors.md"/>
 </instance-profile>
diff --git a/Writerside/images/1.png b/Writerside/images/1.png
diff --git a/Writerside/images/1_dark.png b/Writerside/images/1_dark.png
diff --git a/Writerside/images/2.png b/Writerside/images/2.png
diff --git a/Writerside/images/2_dark.png b/Writerside/images/2_dark.png
diff --git a/Writerside/images/3.png b/Writerside/images/3.png
diff --git a/Writerside/images/3_dark.png b/Writerside/images/3_dark.png
diff --git a/Writerside/images/4.png b/Writerside/images/4.png
diff --git a/Writerside/images/4_dark.png b/Writerside/images/4_dark.png
diff --git a/Writerside/images/5.png b/Writerside/images/5.png
diff --git a/Writerside/images/5_dark.png b/Writerside/images/5_dark.png
diff --git a/Writerside/images/6.png b/Writerside/images/6.png
diff --git a/Writerside/images/6_dark.png b/Writerside/images/6_dark.png
diff --git a/Writerside/images/7.png b/Writerside/images/7.png
diff --git a/Writerside/images/7_dark.png b/Writerside/images/7_dark.png
diff --git a/Writerside/images/8.png b/Writerside/images/8.png
diff --git a/Writerside/images/8_dark.png b/Writerside/images/8_dark.png
diff --git a/Writerside/images/9.png b/Writerside/images/9.png
diff --git a/Writerside/images/9_dark.png b/Writerside/images/9_dark.png
diff --git a/Writerside/images/Easy-YOPmail_title.png b/Writerside/images/Easy-YOPmail_title.png
diff --git a/Writerside/images/baner-demo2.png b/Writerside/images/baner-demo2.png
diff --git a/Writerside/images/banner-4.png b/Writerside/images/banner-4.png
diff --git a/Writerside/images/banner-4_dark.png b/Writerside/images/banner-4_dark.png
diff --git a/Writerside/images/banner_2.png b/Writerside/images/banner_2.png
diff --git a/Writerside/images/banner_2_dark.png b/Writerside/images/banner_2_dark.png
diff --git a/Writerside/images/banner_3.png b/Writerside/images/banner_3.png
diff --git a/Writerside/images/banner_3_dark.png b/Writerside/images/banner_3_dark.png
diff --git a/Writerside/images/banner_4.png b/Writerside/images/banner_4.png
diff --git a/Writerside/images/banner_4_dark.png b/Writerside/images/banner_4_dark.png
diff --git a/Writerside/images/banners-demo3.png b/Writerside/images/banners-demo3.png
diff --git a/Writerside/images/banners-demoi.png b/Writerside/images/banners-demoi.png
diff --git a/Writerside/images/bot2.gif b/Writerside/images/bot2.gif
diff --git a/Writerside/images/code_animation.mp4 b/Writerside/images/code_animation.mp4
diff --git a/Writerside/images/code_animation_1.mp4 b/Writerside/images/code_animation_1.mp4
diff --git a/Writerside/images/easy-yopmail_install.gif b/Writerside/images/easy-yopmail_install.gif
diff --git a/Writerside/images/favico-48.ico b/Writerside/images/favico-48.ico
diff --git a/Writerside/images/fn_1.png b/Writerside/images/fn_1.png
diff --git a/Writerside/images/fn_1_dark.png b/Writerside/images/fn_1_dark.png
diff --git a/Writerside/images/fn_2.png b/Writerside/images/fn_2.png
diff --git a/Writerside/images/fn_2_dark.png b/Writerside/images/fn_2_dark.png
diff --git a/Writerside/images/fn_3.png b/Writerside/images/fn_3.png
diff --git a/Writerside/images/fn_3_dark.png b/Writerside/images/fn_3_dark.png
diff --git a/Writerside/images/fn_4.png b/Writerside/images/fn_4.png
diff --git a/Writerside/images/fn_4_dark.png b/Writerside/images/fn_4_dark.png
diff --git a/Writerside/images/fn_5.png b/Writerside/images/fn_5.png
diff --git a/Writerside/images/fn_5_dark.png b/Writerside/images/fn_5_dark.png
diff --git a/Writerside/images/fn_6.png b/Writerside/images/fn_6.png
diff --git a/Writerside/images/fn_6_dark.png b/Writerside/images/fn_6_dark.png
diff --git a/Writerside/images/logo.png b/Writerside/images/logo.png
diff --git a/Writerside/images/page-yopmail-create-mail-mini.png b/Writerside/images/page-yopmail-create-mail-mini.png
diff --git a/Writerside/images/page-yopmail-create-mail.png b/Writerside/images/page-yopmail-create-mail.png
diff --git a/Writerside/images/page-yopmail-inbox-mail.png b/Writerside/images/page-yopmail-inbox-mail.png
diff --git a/Writerside/images/page-yopmail-inbox-mail_mini.png b/Writerside/images/page-yopmail-inbox-mail_mini.png
diff --git a/Writerside/images/page-yopmail.png b/Writerside/images/page-yopmail.png
diff --git a/Writerside/images/page-yopmail_mini.png b/Writerside/images/page-yopmail_mini.png
diff --git a/Writerside/images/robot.gif b/Writerside/images/robot.gif
diff --git a/Writerside/images/yopmail.gif b/Writerside/images/yopmail.gif
diff --git a/Writerside/images/yopmail.png b/Writerside/images/yopmail.png
diff --git a/Writerside/redirection-rules.xml b/Writerside/redirection-rules.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
+<rules>
+    <!-- format is as follows
+    <rule id="<unique id>">
+        <accepts>page.html</accepts>
+    </rule>
+    -->
+    <rule id="7b67b394">
+        <description>Created after removal of "Empty XML Topic" from EasyYopmail</description>
+        <accepts>Empty-XML-Topic.html</accepts>
+    </rule>
+    <rule id="21c5a74f">
+        <description>Created after removal of "Section Starting Page" from EasyYopmail</description>
+        <accepts>Section-Starting-Page.html</accepts>
+    </rule>
+</rules>
diff --git a/Writerside/topics/Announcements.md b/Writerside/topics/Announcements.md
@@ -0,0 +1,3 @@
+# 📢 Announcements 
+
+Start typing here...
diff --git a/Writerside/topics/Blog.md b/Writerside/topics/Blog.md
@@ -0,0 +1,3 @@
+# 📰 Blog
+
+Start typing here...
diff --git a/Writerside/topics/Improvements.md b/Writerside/topics/Improvements.md
@@ -0,0 +1,3 @@
+# Improvements
+
+Start typing here...
diff --git a/Writerside/topics/Sponsors.md b/Writerside/topics/Sponsors.md
@@ -0,0 +1,3 @@
+# Sponsors
+
+Start typing here...
diff --git a/Writerside/topics/deleteInbox.md b/Writerside/topics/deleteInbox.md
@@ -0,0 +1,3 @@
+# deleteInbox()
+
+Start typing here...
diff --git a/Writerside/topics/deleteMessage.md b/Writerside/topics/deleteMessage.md
@@ -0,0 +1,3 @@
+# deleteMessage()
+
+Start typing here...
diff --git a/Writerside/topics/getInbox.md b/Writerside/topics/getInbox.md
@@ -0,0 +1,3 @@
+# getInbox()
+
+Start typing here...
diff --git a/Writerside/topics/getMail.md b/Writerside/topics/getMail.md
@@ -0,0 +1,3 @@
+# getMail()
+
+Start typing here...
diff --git a/Writerside/topics/readMessage.md b/Writerside/topics/readMessage.md
@@ -0,0 +1,82 @@
+# 📑 readMessage()
+
+# Definición
+The readMessage() function in Easy-Yopmail allows you to read the content of a specific email within a YOPmail inbox. It provides options to retrieve the content in plain text or HTML format, and even allows you to target specific elements within the email using CSS selectors.
+Parámetros de entrada
+Parámetro	Tipo	Descripción
+mail	String	La dirección de correo electrónico YOPmail (sin el dominio @yopmail.com).
+id	String	El ID único del correo electrónico que desea leer.
+options	Object	(Opcional) Un objeto con opciones adicionales para personalizar la lectura.
+Opciones dentro del parámetro options:
+format: (Opcional) Formato del contenido del correo electrónico. Puede ser "TXT" (texto plano) o "HTML" (HTML). Por defecto es "TXT".
+selector: (Opcional) Un selector CSS para apuntar a un elemento específico dentro del cuerpo del correo electrónico HTML.
+attribute: (Opcional) Si se proporciona un selector, este parámetro especifica el atributo del elemento que se va a devolver (por ejemplo, "href" para un enlace).
+pathToSave: (Opcional) Ruta para guardar el HTML del correo electrónico como un archivo.
+Salida
+La función readMessage() devuelve una promesa que se resuelve con un objeto que contiene la siguiente información:
+id: El ID del correo electrónico.
+submit: El asunto del correo electrónico.
+from: La dirección de correo electrónico del remitente.
+date: La fecha en que se recibió el correo electrónico.
+deliverability: Información sobre la entrega del correo electrónico.
+format: El formato del contenido devuelto ("TXT" o "HTML").
+selector: El selector CSS utilizado (si se proporciona).
+eq: El índice del elemento seleccionado (si se proporciona).
+attribute: El atributo del elemento seleccionado (si se proporciona).
+pathToSave: La ruta donde se guardó el HTML (si se proporciona).
+content: El contenido del correo electrónico en el formato especificado.
+info: Una lista de advertencias o mensajes informativos.
+Diagrama mermaid
+sequenceDiagram
+participant NodeJS
+participant EasyYopmail
+participant Yopmail
+NodeJS->>EasyYopmail: readMessage(mail, id, options)
+activate EasyYopmail
+EasyYopmail->>Yopmail: Request email content by ID
+Yopmail->>EasyYopmail: Return email content
+deactivate EasyYopmail
+NodeJS->>NodeJS: Process email content (format, selector, attribute)
+alt pathToSave option provided
+NodeJS->>EasyYopmail: Save email HTML to file
+activate EasyYopmail
+EasyYopmail->>FileSystem: Save HTML content
+deactivate EasyYopmail
+end
+Use code with caution.
+Mermaid
+Casos de uso prácticos
+Leer el contenido de texto plano de un correo electrónico:
+easyYopmail.readMessage('mi-correo', 'id-del-correo')
+.then(message => {
+console.log(message.content); // Contenido del correo en texto plano
+});
+Use code with caution.
+JavaScript
+Extraer un enlace de confirmación de un correo electrónico HTML:
+easyYopmail.readMessage('mi-correo', 'id-del-correo', { format: 'HTML', selector: 'a.confirmation-link', attribute: 'href' })
+.then(message => {
+console.log(message.content); // URL del enlace de confirmación
+});
+Use code with caution.
+JavaScript
+Guardar el contenido HTML completo de un correo electrónico en un archivo:
+easyYopmail.readMessage('mi-correo', 'id-del-correo', { format: 'HTML', pathToSave: './emails' })
+.then(message => {
+console.log('Correo electrónico guardado como archivo HTML');
+});
+Use code with caution.
+JavaScript
+Código de ejemplo
+const easyYopmail = require('easy-yopmail');
+
+easyYopmail.getInbox('[email protected]')
+.then(inbox => {
+const emailId = inbox.inbox[0].id;
+
+    easyYopmail.readMessage('[email protected]', emailId, { format: 'HTML' }) 
+    .then(message => {
+        console.log(message.content); // Contenido del correo electrónico en HTML
+    });
+});
+Use code with caution.