GraphQL: Add sendEmailToFriend mutation (#5368)

* checkpoint

* add navigation

* small updates

* update example

* convert paragraph to note

* update opening sentence

Author: keharper

_data/toc/graphql.yml

@@ -184,6 +184,9 @@ pages:
         - label: revokeCustomerToken mutation
           url: /graphql/mutations/revoke-customer-token.html
 
+        - label: sendEmailToFriend mutation
+          url: /graphql/mutations/send-email-to-friend.html
+
         - label: setBillingAddressesOnCart mutation
           url: /graphql/mutations/set-billing-address.html
 

guides/v2.3/graphql/mutations/send-email-to-friend.md

@@ -0,0 +1,129 @@
+---
+group: graphql
+title: sendEmailToFriend mutation
+---
+
+Use the `sendEmailToFriend` mutation to allow Magento to send a message on behalf of a customer to the specified email addresses.
+
+{:.bs-callout-info}
+The **Stores** > **Configuration** > **Catalog** > **Email to a friend** > **Enabled** field must be set to **Yes** to implement this mutation.
+
+## Syntax
+
+`mutation: {sendEmailToFriend(input: SendEmailToFriendInput): {SendEmailToFriendOutput}}`
+
+## Example usage
+
+The following example sends a message to two friends.
+
+**Request**
+
+```graphql
+mutation {
+  sendEmailToFriend(
+    input: {
+      product_id: 10
+      sender: {
+        name: "Veronica Cost"
+        email: "[email protected]"
+        message: "Sarah needs this! http://luma.example.com/savvy-shoulder-tote.html"
+      }
+      recipients: [
+        { name: "Amie Franklin", email: "[email protected]" }
+        { name: "Tomoko", email: "[email protected]" }
+      ]
+    }
+  ) {
+    sender {
+      name
+      email
+    }
+    recipients {
+      name
+      email
+    }
+  }
+}
+```
+
+**Response**
+
+```json
+{
+  "data": {
+    "sendEmailToFriend": {
+      "sender": {
+        "name": "Veronica Cost",
+        "email": "[email protected]",
+      },
+      "recipients": [
+        {
+          "name": "Amie Franklin",
+          "email": "[email protected]"
+        },
+        {
+          "name": "Tomoko",
+          "email": "[email protected]"
+        }
+      ]
+    }
+  }
+}
+```
+
+## Input attributes
+
+The `SendEmailToFriendInput` object contains the following attributes:
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`product_id` | Int! | The ID of the product that the customer is referencing
+`recipients` | [SendEmailToFriendRecipientInput]! | An array containing information about each recipient
+`sender` | SendEmailToFriendSenderInput! | Information about the customer and the content of the message
+
+### SendEmailToFriendRecipientInput object {#SendEmailToFriendRecipientInput}
+
+The `SendEmailToFriendRecipientInput` object must contain the following attributes:
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`email` | String! | The email address of the recipient
+`name` | String! | The name of the recipient
+
+### SendEmailToFriendSenderInput object {#SendEmailToFriendSenderInput}
+
+The `SendEmailToFriendSenderInput` object must contain the following attributes:
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`email` | String! | The email address of the sender
+`message` | String! | The text of the message to be sent
+`name` | String! | The name of the sender
+
+## Output attributes
+
+The `SendEmailToFriendOutput` object contains the following attributes:
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`recipients` | [SendEmailToFriendRecipient] | An array containing information about each recipient
+`sender` | SendEmailToFriendSender | Information about the customer and the content of the message
+
+### SendEmailToFriendRecipient object
+
+The `SendEmailToFriendRecipientInput` object can contain the following attributes:
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`email` | String | The email address of the recipient
+`name` | String | The name of the recipient
+
+### SendEmailToFriendSender object
+
+The `SendEmailToFriendSender` object can contain the following attributes:
+
+Attribute |  Data Type | Description
+--- | --- | ---
+`email` | String | The email address of the sender
+`message` | String | The text of the message
+`name` | String | The name of the sender