Update Email docs to point to specific v. of mailcomposer

It's 0.1.15, which is quite far behind. Maybe we should update at some point.
This commit is contained in:
Sashko Stubailo
2015-10-02 14:34:24 -07:00
parent f97efe4c35
commit 99e8ddaa51
2 changed files with 25 additions and 16 deletions

View File

@@ -3488,7 +3488,7 @@ DocsData = {
"Email.send": {
"filepath": "email/email.js",
"kind": "function",
"lineno": 142,
"lineno": 151,
"locus": "Server",
"longname": "Email.send",
"memberof": "Email",
@@ -3544,7 +3544,7 @@ DocsData = {
}
},
{
"description": "<p>Array of attachment objects, as\ndescribed in the <a href=\"https://github.com/andris9/mailcomposer#add-attachments\">mailcomposer documentation</a>.</p>",
"description": "<p>Array of attachment objects, as\ndescribed in the <a href=\"https://github.com/andris9/mailcomposer/blob/7c0422b2de2dc61a60ba27cfa3353472f662aeb5/README.md#add-attachments\">mailcomposer documentation</a>.</p>",
"name": "attachments",
"optional": true,
"type": {
@@ -3575,7 +3575,7 @@ DocsData = {
}
],
"scope": "static",
"summary": "Send an email. Throws an `Error` on failure to contact mail server\nor if mail server returns an error. All fields should match\n[RFC5322](http://tools.ietf.org/html/rfc5322) specification."
"summary": "Send an email. Throws an `Error` on failure to contact mail server\nor if mail server returns an error. All fields should match\n[RFC5322](http://tools.ietf.org/html/rfc5322) specification.\n\nIf the `MAIL_URL` environment variable is set, actually sends the email.\nOtherwise, prints the contents of the email to standard out.\n\nNote that this package is based on mailcomposer version `0.1.15`, so make\nsure to refer to the documentation for that version if using the\n`attachments` or `mailComposer` options.\n[Click here to read the mailcomposer 0.1.15 docs](https://github.com/andris9/mailcomposer/blob/7c0422b2de2dc61a60ba27cfa3353472f662aeb5/README.md)."
},
"HTTP.call": {
"filepath": "http/httpcall_client.js",
@@ -5371,7 +5371,7 @@ DocsData = {
"Mongo.Collection#allow": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 787,
"lineno": 791,
"locus": "Server",
"longname": "Mongo.Collection#allow",
"memberof": "Mongo.Collection",
@@ -5421,7 +5421,7 @@ DocsData = {
"Mongo.Collection#deny": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 799,
"lineno": 803,
"locus": "Server",
"longname": "Mongo.Collection#deny",
"memberof": "Mongo.Collection",
@@ -5471,7 +5471,7 @@ DocsData = {
"Mongo.Collection#find": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 257,
"lineno": 261,
"locus": "Anywhere",
"longname": "Mongo.Collection#find",
"memberof": "Mongo.Collection",
@@ -5568,7 +5568,7 @@ DocsData = {
"Mongo.Collection#findOne": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 283,
"lineno": 287,
"locus": "Anywhere",
"longname": "Mongo.Collection#findOne",
"memberof": "Mongo.Collection",
@@ -5656,7 +5656,7 @@ DocsData = {
"Mongo.Collection#insert": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 427,
"lineno": 431,
"locus": "Anywhere",
"longname": "Mongo.Collection#insert",
"memberof": "Mongo.Collection",
@@ -5689,7 +5689,7 @@ DocsData = {
"Mongo.Collection#rawCollection": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 656,
"lineno": 660,
"locus": "Server",
"longname": "Mongo.Collection#rawCollection",
"memberof": "Mongo.Collection",
@@ -5702,7 +5702,7 @@ DocsData = {
"Mongo.Collection#rawDatabase": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 668,
"lineno": 672,
"locus": "Server",
"longname": "Mongo.Collection#rawDatabase",
"memberof": "Mongo.Collection",
@@ -5715,7 +5715,7 @@ DocsData = {
"Mongo.Collection#remove": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 451,
"lineno": 455,
"locus": "Anywhere",
"longname": "Mongo.Collection#remove",
"memberof": "Mongo.Collection",
@@ -5748,7 +5748,7 @@ DocsData = {
"Mongo.Collection#update": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 437,
"lineno": 441,
"locus": "Anywhere",
"longname": "Mongo.Collection#update",
"memberof": "Mongo.Collection",
@@ -5818,7 +5818,7 @@ DocsData = {
"Mongo.Collection#upsert": {
"filepath": "mongo/collection.js",
"kind": "function",
"lineno": 613,
"lineno": 617,
"locus": "Anywhere",
"longname": "Mongo.Collection#upsert",
"memberof": "Mongo.Collection",
@@ -5880,7 +5880,7 @@ DocsData = {
"filepath": "mongo/collection.js",
"instancename": "cursor",
"kind": "class",
"lineno": 690,
"lineno": 694,
"longname": "Mongo.Cursor",
"memberof": "Mongo",
"name": "Cursor",
@@ -6048,7 +6048,7 @@ DocsData = {
"Mongo.ObjectID": {
"filepath": "mongo/collection.js",
"kind": "class",
"lineno": 683,
"lineno": 687,
"locus": "Anywhere",
"longname": "Mongo.ObjectID",
"memberof": "Mongo",

View File

@@ -124,6 +124,15 @@ EmailTest.hookSend = function (f) {
* @summary Send an email. Throws an `Error` on failure to contact mail server
* or if mail server returns an error. All fields should match
* [RFC5322](http://tools.ietf.org/html/rfc5322) specification.
*
* If the `MAIL_URL` environment variable is set, actually sends the email.
* Otherwise, prints the contents of the email to standard out.
*
* Note that this package is based on mailcomposer version `0.1.15`, so make
* sure to refer to the documentation for that version if using the
* `attachments` or `mailComposer` options.
* [Click here to read the mailcomposer 0.1.15 docs](https://github.com/andris9/mailcomposer/blob/7c0422b2de2dc61a60ba27cfa3353472f662aeb5/README.md).
*
* @locus Server
* @param {Object} options
* @param {String} options.from "From:" address (required)
@@ -133,7 +142,7 @@ EmailTest.hookSend = function (f) {
* @param {String} [options.text|html] Mail body (in plain text and/or HTML)
* @param {Object} [options.headers] Dictionary of custom headers
* @param {Object[]} [options.attachments] Array of attachment objects, as
* described in the [mailcomposer documentation](https://github.com/andris9/mailcomposer#add-attachments).
* described in the [mailcomposer documentation](https://github.com/andris9/mailcomposer/blob/7c0422b2de2dc61a60ba27cfa3353472f662aeb5/README.md#add-attachments).
* @param {MailComposer} [options.mailComposer] A [MailComposer](https://github.com/andris9/mailcomposer)
* object representing the message to be sent. Overrides all other options. You
* can access the `mailcomposer` npm module at