mirror of
https://github.com/node-red/node-red-nodes.git
synced 2025-03-01 10:37:43 +00:00
Move English help to en-US directory (#592)
* Move English help about e-mail node to en-US directory * Move English help about rbe node to en-US directory * Move English help about tail node to en-US directory * Move English help about twitter node to en-US directory * Move English help about feedparse node to en-US directory * Move English help about sentiment node to en-US directory
This commit is contained in:
Kazuhito Yokoi
committed by
Dave Conway-Jones
Dave Conway-Jones
parent
676ba58210
commit
870a2146c0
@@ -1,4 +1,3 @@
|
||||
|
||||
<script type="text/x-red" data-template-name="e-mail">
|
||||
<div class="form-row">
|
||||
<label for="node-input-name"><i class="fa fa-envelope"></i> <span data-i18n="email.label.to"></span></label>
|
||||
@@ -61,27 +60,6 @@
|
||||
<div class="form-tips" id="node-tip"><span data-i18n="[html]email.tip.cred"></span></div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="e-mail">
|
||||
<p>Sends the <code>msg.payload</code> as an email, with a subject of <code>msg.topic</code>.</p>
|
||||
<p>The default message recipient can be configured in the node, if it is left
|
||||
blank it should be set using the <code>msg.to</code> property of the incoming message. If left blank
|
||||
you can also specify any or all of: <code>msg.cc</code>, <code>msg.bcc</code>, <code>msg.replyTo</code>, <code>msg.inReplyTo</code>, <code>msg.references</code> properties.</p>
|
||||
<p>You may optionally set <code>msg.from</code> in the payload which will override the <code>userid</code>
|
||||
default value.</p>
|
||||
<h3>GMail users</h3>
|
||||
<p>If you are accessing GMail you may need to either enable <a target="_new" href="https://support.google.com/mail/answer/185833?hl=en">an application password</a>,
|
||||
or enable <a target="_new" href="https://support.google.com/accounts/answer/6010255?hl=en">less secure access</a> via your Google account settings.</p>
|
||||
<h3>Details</h3>
|
||||
<p>The payload can be html format.</p>
|
||||
<p>If the payload is a binary buffer then it will be converted to an attachment.
|
||||
The filename should be set using <code>msg.filename</code>. Optionally <code>msg.description</code> can be added for the body text.</p>
|
||||
<p>Alternatively you may provide <code>msg.attachments</code> which should contain an array of one or
|
||||
more attachments in <a href="https://nodemailer.com/message/attachments/" target="_new">nodemailer</a> format.</p>
|
||||
<p>If required by your recipient you may also pass in a <code>msg.envelope</code> object, typically containing extra from and to properties.</p>
|
||||
<p>If you have own signed certificates, Nodemailer can complain about that and refuse sending the message. In this case you can try switching off TLS.</p>
|
||||
<p>Note: uses SMTP with SSL to port 465.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
(function() {
|
||||
RED.nodes.registerType('e-mail',{
|
||||
@@ -237,38 +215,6 @@
|
||||
</script>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="e-mail in">
|
||||
<p>Repeatedly gets emails from an IMAP server and forwards on as a msg if not already seen.</p>
|
||||
<p>The subject is loaded into <code>msg.topic</code> and <code>msg.payload</code> is the plain text body.
|
||||
If there is text/html then that is returned in <code>msg.html</code>. <code>msg.from</code> and <code>msg.date</code> are also set if you need them.</p>
|
||||
<p>Additionally <code>msg.header</code> contains the complete header object including
|
||||
<i>to</i>, <i>cc</i> and other potentially useful properties.</p>
|
||||
<p>It can optionally mark the message as Read (default), Delete it, or leave unmarked (None).</p>
|
||||
<p>Uses the imap module.</p>
|
||||
<p><b>Note:</b> this node <i>only</i> gets the most recent single email from the inbox, so set the repeat (polling) time appropriately.</p>
|
||||
<p>Note: uses IMAP with SSL to port 993.</p>
|
||||
<p>Any attachments supplied in the incoming email can be found in the <code>msg.attachments</code> property. This will be an array of objects where
|
||||
each object represents a specific attachments. The format of the object is:</p>
|
||||
|
||||
<pre>
|
||||
{
|
||||
contentType: // The MIME content description
|
||||
fileName: // A suggested file name associated with this attachment
|
||||
transferEncoding: // How was the original email attachment encodded?
|
||||
contentDisposition: // Unknown
|
||||
generatedFileName: // A suggested file name associated with this attachment
|
||||
contentId: // A unique generated ID for this attachment
|
||||
checksum: // A checksum against the data
|
||||
length: // Size of data in bytes
|
||||
content: // The actual content of the data contained in a Node.js Buffer object
|
||||
// We can turn this into a base64 data string with content.toString('base64')
|
||||
}
|
||||
</pre>
|
||||
<p>For POP3, the default port numbers are 110 for plain TCP and 995 for SSL. For IMAP the port numbers are 143 for plain TCP and 993 for SSL.</p>
|
||||
<p>The maximum refresh interval is 2147483 seconds (24.8 days).</p>
|
||||
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
(function() {
|
||||
RED.nodes.registerType('e-mail in',{
|
||||
|
||||
53
social/email/locales/en-US/61-email.html
Normal file
53
social/email/locales/en-US/61-email.html
Normal file
@@ -0,0 +1,53 @@
|
||||
<script type="text/x-red" data-help-name="e-mail">
|
||||
<p>Sends the <code>msg.payload</code> as an email, with a subject of <code>msg.topic</code>.</p>
|
||||
<p>The default message recipient can be configured in the node, if it is left
|
||||
blank it should be set using the <code>msg.to</code> property of the incoming message. If left blank
|
||||
you can also specify any or all of: <code>msg.cc</code>, <code>msg.bcc</code>, <code>msg.replyTo</code>, <code>msg.inReplyTo</code>, <code>msg.references</code> properties.</p>
|
||||
<p>You may optionally set <code>msg.from</code> in the payload which will override the <code>userid</code>
|
||||
default value.</p>
|
||||
<h3>GMail users</h3>
|
||||
<p>If you are accessing GMail you may need to either enable <a target="_new" href="https://support.google.com/mail/answer/185833?hl=en">an application password</a>,
|
||||
or enable <a target="_new" href="https://support.google.com/accounts/answer/6010255?hl=en">less secure access</a> via your Google account settings.</p>
|
||||
<h3>Details</h3>
|
||||
<p>The payload can be html format.</p>
|
||||
<p>If the payload is a binary buffer then it will be converted to an attachment.
|
||||
The filename should be set using <code>msg.filename</code>. Optionally <code>msg.description</code> can be added for the body text.</p>
|
||||
<p>Alternatively you may provide <code>msg.attachments</code> which should contain an array of one or
|
||||
more attachments in <a href="https://nodemailer.com/message/attachments/" target="_new">nodemailer</a> format.</p>
|
||||
<p>If required by your recipient you may also pass in a <code>msg.envelope</code> object, typically containing extra from and to properties.</p>
|
||||
<p>If you have own signed certificates, Nodemailer can complain about that and refuse sending the message. In this case you can try switching off TLS.</p>
|
||||
<p>Note: uses SMTP with SSL to port 465.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="e-mail in">
|
||||
<p>Repeatedly gets emails from an IMAP server and forwards on as a msg if not already seen.</p>
|
||||
<p>The subject is loaded into <code>msg.topic</code> and <code>msg.payload</code> is the plain text body.
|
||||
If there is text/html then that is returned in <code>msg.html</code>. <code>msg.from</code> and <code>msg.date</code> are also set if you need them.</p>
|
||||
<p>Additionally <code>msg.header</code> contains the complete header object including
|
||||
<i>to</i>, <i>cc</i> and other potentially useful properties.</p>
|
||||
<p>It can optionally mark the message as Read (default), Delete it, or leave unmarked (None).</p>
|
||||
<p>Uses the imap module.</p>
|
||||
<p><b>Note:</b> this node <i>only</i> gets the most recent single email from the inbox, so set the repeat (polling) time appropriately.</p>
|
||||
<p>Note: uses IMAP with SSL to port 993.</p>
|
||||
<p>Any attachments supplied in the incoming email can be found in the <code>msg.attachments</code> property. This will be an array of objects where
|
||||
each object represents a specific attachments. The format of the object is:</p>
|
||||
|
||||
<pre>
|
||||
{
|
||||
contentType: // The MIME content description
|
||||
fileName: // A suggested file name associated with this attachment
|
||||
transferEncoding: // How was the original email attachment encodded?
|
||||
contentDisposition: // Unknown
|
||||
generatedFileName: // A suggested file name associated with this attachment
|
||||
contentId: // A unique generated ID for this attachment
|
||||
checksum: // A checksum against the data
|
||||
length: // Size of data in bytes
|
||||
content: // The actual content of the data contained in a Node.js Buffer object
|
||||
// We can turn this into a base64 data string with content.toString('base64')
|
||||
}
|
||||
</pre>
|
||||
<p>For POP3, the default port numbers are 110 for plain TCP and 995 for SSL. For IMAP the port numbers are 143 for plain TCP and 993 for SSL.</p>
|
||||
<p>The maximum refresh interval is 2147483 seconds (24.8 days).</p>
|
||||
|
||||
</script>
|
||||
|
||||
@@ -1,4 +1,3 @@
|
||||
|
||||
<script type="text/x-red" data-template-name="feedparse">
|
||||
<div class="form-row">
|
||||
<label for="node-input-url"><i class="fa fa-globe"></i> <span data-i18n="feedparse.label.feedurl"></span></label>
|
||||
@@ -14,14 +13,6 @@
|
||||
</div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="feedparse">
|
||||
<p>Monitors an RSS/atom feed for new entries.</p>
|
||||
<p>The <code>msg.topic</code> contains the original article link. The <code>msg.payload</code>
|
||||
contains the description, and <code>msg.article</code> contains the complete article object,
|
||||
which has properties such as <code>.title</code>, <code>.summary</code>, <code>.date</code> and so on.</p>
|
||||
<p>The Refresh interval cannot be greater than 35790 minutes (approx 24.8 days).
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
RED.nodes.registerType('feedparse',{
|
||||
category: 'advanced-input',
|
||||
|
||||
7
social/feedparser/locales/en-US/32-feedparse.html
Normal file
7
social/feedparser/locales/en-US/32-feedparse.html
Normal file
@@ -0,0 +1,7 @@
|
||||
<script type="text/x-red" data-help-name="feedparse">
|
||||
<p>Monitors an RSS/atom feed for new entries.</p>
|
||||
<p>The <code>msg.topic</code> contains the original article link. The <code>msg.payload</code>
|
||||
contains the description, and <code>msg.article</code> contains the complete article object,
|
||||
which has properties such as <code>.title</code>, <code>.summary</code>, <code>.date</code> and so on.</p>
|
||||
<p>The Refresh interval cannot be greater than 35790 minutes (approx 24.8 days).
|
||||
</script>
|
||||
@@ -1,4 +1,3 @@
|
||||
|
||||
<script type="text/x-red" data-template-name="twitter-credentials">
|
||||
<div class="form-row">
|
||||
<label for="node-config-input-screen_name"><i class="fa fa-twitter"></i> <span data-i18n="twitter.label.twitter-id"></span></label>
|
||||
@@ -32,15 +31,6 @@
|
||||
</div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="twitter-credentials">
|
||||
<p>Authentication for the Twitter API</p>
|
||||
<p>Earlier versions of this node provided one-click authentication. Twitter removed the ability
|
||||
to do that in June 2018. You must now register your own application with
|
||||
<a href="https://developer.twitter.com/">Twitter</a> and generate your own access tokens.</p>
|
||||
|
||||
</script>
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
(function() {
|
||||
var twitterConfigNodeId = null;
|
||||
@@ -109,33 +99,6 @@
|
||||
<div class="form-tips"><span data-i18n="[html]twitter.tip"></span></div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="twitter in">
|
||||
<p>Twitter input node. Can be used to search either:
|
||||
<ul><li>the public stream for tweets containing the configured search term</li>
|
||||
<li>tweets from accounts that the authenticated user follows</li>
|
||||
<li>tweets by specified users</li>
|
||||
<li>direct messages received by the authenticated user</li>
|
||||
</ul></p>
|
||||
<h3>Outputs</h3>
|
||||
<dl class="message-properties">
|
||||
<dt>payload <span class="property-type">string</span></dt>
|
||||
<dd>the text of the tweet</dd>
|
||||
<dt>topic <span class="property-type">string</span></dt>
|
||||
<dd>set to <code>tweets/<i>screen_name</i></code></dd>
|
||||
<dt>tweet <span class="property-type">object</span></dt>
|
||||
<dd>the full tweet object returned by the Twitter API</dd>
|
||||
<dt>location <span class="property-type">object</span></dt>
|
||||
<dd>location information associated with the tweet, if known</dd>
|
||||
</dl>
|
||||
<h3>Details</h3>
|
||||
<p>When searching for multiple terms, use a space for <i>and</i> and comma `,` for <i>or</i>.</p>
|
||||
<p>The full tweet object is documented <a href="https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/tweet-object" target="_new">here</a>.</p>
|
||||
<p><b>Note:</b> this node is subject to the rate limiting restrictions of the Twitter
|
||||
API. It polls the API once a minute for updates. If you deploy frequently you may
|
||||
exceed the limit. The node will automatically delay polling until the end of the current
|
||||
rate limiting window.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
RED.nodes.registerType('twitter in',{
|
||||
category: 'social-input',
|
||||
@@ -204,7 +167,6 @@
|
||||
});
|
||||
</script>
|
||||
|
||||
|
||||
<script type="text/x-red" data-template-name="twitter out">
|
||||
<div class="form-row">
|
||||
<label for="node-input-twitter"><i class="fa fa-user"></i> <span data-i18n="twitter.label.twitter-id"></span></label>
|
||||
@@ -216,27 +178,6 @@
|
||||
</div>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="twitter out">
|
||||
<p>Send tweets and direct messages.</p>
|
||||
<h3>Inputs</h3>
|
||||
<dl class="message-properties">
|
||||
<dt>payload <span class="property-type">string</span></dt>
|
||||
<dd>Sent as the body of the tweet. See below for how to send a Direct Message</dd>
|
||||
<dt class="optional">media <span class="property-type">buffer</span></dt>
|
||||
<dd>A Buffer of an image to attach to the tweet</dd>
|
||||
<dt class="optional">params <span class="property-type">object</span></dt>
|
||||
<dd>Additional parameters to pass to the Twitter status update API.</dd>
|
||||
</dl>
|
||||
<h3>Details</h3>
|
||||
<p>This nodes sends a tweet for the authenticated user. If <code>msg.media</code>
|
||||
is set and contains a Buffer, it is attached as an image.</p>
|
||||
<p>To send a Direct Message, the payload should be formatted as: <code>D {username} {message}</code>.</p>
|
||||
<p>Note that you cannot attach an image to a direct message.</p>
|
||||
<p>If <code>msg.params</code> exists and is an object of name:value pairs, they
|
||||
will be included in the request to the Twitter api. The available values are documented
|
||||
<a href="https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update#parameters" target="_new">here</a>.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/javascript">
|
||||
RED.nodes.registerType('twitter out',{
|
||||
category: 'social-output',
|
||||
|
||||
55
social/twitter/locales/en-US/27-twitter.html
Normal file
55
social/twitter/locales/en-US/27-twitter.html
Normal file
@@ -0,0 +1,55 @@
|
||||
<script type="text/x-red" data-help-name="twitter-credentials">
|
||||
<p>Authentication for the Twitter API</p>
|
||||
<p>Earlier versions of this node provided one-click authentication. Twitter removed the ability
|
||||
to do that in June 2018. You must now register your own application with
|
||||
<a href="https://developer.twitter.com/">Twitter</a> and generate your own access tokens.</p>
|
||||
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="twitter in">
|
||||
<p>Twitter input node. Can be used to search either:
|
||||
<ul><li>the public stream for tweets containing the configured search term</li>
|
||||
<li>tweets from accounts that the authenticated user follows</li>
|
||||
<li>tweets by specified users</li>
|
||||
<li>direct messages received by the authenticated user</li>
|
||||
</ul></p>
|
||||
<h3>Outputs</h3>
|
||||
<dl class="message-properties">
|
||||
<dt>payload <span class="property-type">string</span></dt>
|
||||
<dd>the text of the tweet</dd>
|
||||
<dt>topic <span class="property-type">string</span></dt>
|
||||
<dd>set to <code>tweets/<i>screen_name</i></code></dd>
|
||||
<dt>tweet <span class="property-type">object</span></dt>
|
||||
<dd>the full tweet object returned by the Twitter API</dd>
|
||||
<dt>location <span class="property-type">object</span></dt>
|
||||
<dd>location information associated with the tweet, if known</dd>
|
||||
</dl>
|
||||
<h3>Details</h3>
|
||||
<p>When searching for multiple terms, use a space for <i>and</i> and comma `,` for <i>or</i>.</p>
|
||||
<p>The full tweet object is documented <a href="https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/tweet-object" target="_new">here</a>.</p>
|
||||
<p><b>Note:</b> this node is subject to the rate limiting restrictions of the Twitter
|
||||
API. It polls the API once a minute for updates. If you deploy frequently you may
|
||||
exceed the limit. The node will automatically delay polling until the end of the current
|
||||
rate limiting window.</p>
|
||||
</script>
|
||||
|
||||
<script type="text/x-red" data-help-name="twitter out">
|
||||
<p>Send tweets and direct messages.</p>
|
||||
<h3>Inputs</h3>
|
||||
<dl class="message-properties">
|
||||
<dt>payload <span class="property-type">string</span></dt>
|
||||
<dd>Sent as the body of the tweet. See below for how to send a Direct Message</dd>
|
||||
<dt class="optional">media <span class="property-type">buffer</span></dt>
|
||||
<dd>A Buffer of an image to attach to the tweet</dd>
|
||||
<dt class="optional">params <span class="property-type">object</span></dt>
|
||||
<dd>Additional parameters to pass to the Twitter status update API.</dd>
|
||||
</dl>
|
||||
<h3>Details</h3>
|
||||
<p>This nodes sends a tweet for the authenticated user. If <code>msg.media</code>
|
||||
is set and contains a Buffer, it is attached as an image.</p>
|
||||
<p>To send a Direct Message, the payload should be formatted as: <code>D {username} {message}</code>.</p>
|
||||
<p>Note that you cannot attach an image to a direct message.</p>
|
||||
<p>If <code>msg.params</code> exists and is an object of name:value pairs, they
|
||||
will be included in the request to the Twitter api. The available values are documented
|
||||
<a href="https://developer.twitter.com/en/docs/tweets/post-and-engage/api-reference/post-statuses-update#parameters" target="_new">here</a>.</p>
|
||||
</script>
|
||||
Reference in New Issue
Block a user