(→Action signatures) |
m (formatting) |
||
| Line 10: | Line 10: | ||
===Send email=== | ===Send email=== | ||
| − | ;<code>[gn:sendEmail]|[toRecipients{n},ccRecipients{n},bccRecipients{n},subject{n},body{n},repeat,timeout,successMessage{n},failMessage{n},offlineMode,attachments,senderName]</code> | + | :;<code>[gn:sendEmail]|[toRecipients{n}, ccRecipients{n}, bccRecipients{n}, subject{n}, body{n}, repeat, timeout, successMessage{n}, failMessage{n}, offlineMode, attachments, senderName]</code> |
| − | {| class="wikitable sortable" style="font-size: 85%; text-align: left;" | + | :{| class="wikitable sortable" style="font-size: 85%; text-align: left;" |
|- | |- | ||
! scope="col" | Parameter | ! scope="col" | Parameter | ||
! scope="col" | Description | ! scope="col" | Description | ||
|- | |- | ||
| − | | [[source|toRecipients]]{n} | + | | <code>[[source|toRecipients]]{n}</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where "to" emails will be retrieved | [[source]] from where "to" emails will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** any [[source]] which supports [[Datatypes#text|text]] | + | ** any [[source]] which supports <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|ccRecipients]]{n} | + | | <code>[[source|ccRecipients]]{n}</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where "cc" emails will be retrieved | [[source]] from where "cc" emails will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** any [[source]] which supports [[Datatypes#text|text]] | + | ** any [[source]] which supports <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|bccRecipients]]{n} | + | | <code>[[source|bccRecipients]]{n}</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where "bcc" emails will be retrieved | [[source]] from where "bcc" emails will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** any [[source]] which supports [[Datatypes#text|text]] | + | ** any [[source]] which supports <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|subject]]{n} | + | | <code>[[source|subject]]{n}</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where email subject will be retrieved | [[source]] from where email subject will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** any [[source]] which supports [[Datatypes#text|text]] | + | ** any [[source]] which supports <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|body]]{n} | + | | <code>[[source|body]]{n}</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where email body will be retrieved | [[source]] from where email body will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** any [[source]] which supports [[Datatypes#text|text]] | + | ** any [[source]] which supports <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | repeat | + | | <code>repeat</code> |
| number which represents a number of attempts to send an email | | number which represents a number of attempts to send an email | ||
|- | |- | ||
| − | | timeout | + | | <code>timeout</code> |
| number which represents a number of miliseconds between attempts | | number which represents a number of miliseconds between attempts | ||
|- | |- | ||
| − | | [[source|successMessage]]{n} | + | | <code>[[source|successMessage]]{n}</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where email success message will be retrieved | [[source]] from where email success message will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** any [[source]] which supports [[Datatypes#text|text]] | + | ** any [[source]] which supports <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | [[source|failMessage]]{n} | + | | <code>[[source|failMessage]]{n}</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where email fail message will be retrieved | [[source]] from where email fail message will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** any [[source]] which supports [[Datatypes#text|text]] | + | ** any [[source]] which supports <code>[[Datatypes#text|text]]</code> |
|- | |- | ||
| − | | offlineMode | + | | <code>offlineMode</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
boolean which represents if the mail will be stored for offline email sending after all online attempts fail | boolean which represents if the mail will be stored for offline email sending after all online attempts fail | ||
|- | |- | ||
| − | | [[source|attachments]] | + | | <code>[[source|attachments]]</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where email attachments will be retrieved | [[source]] from where email attachments will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** any [[source]] which supports [[Datatypes#rowsColumn|rowsColumn]] | + | ** any [[source]] which supports <code>[[Datatypes#rowsColumn|rowsColumn]]</code> |
|- | |- | ||
| − | | [[source|senderName]] | + | | <code>[[source|senderName]]</code> |
| − | | <div style="text-align: right;">'''optional'''</div> | + | | <div style="text-align: right; background-color: #e5e5e5; padding-right: 7px">'''optional'''</div> |
[[source]] from where sender name will be retrieved | [[source]] from where sender name will be retrieved | ||
* Valid [[source|sources]]: | * Valid [[source|sources]]: | ||
| − | ** any [[source]] which supports [[Datatypes#text|text]] | + | ** any [[source]] which supports <code>[[Datatypes#text|text]]</code> |
|} | |} | ||
====Example==== | ====Example==== | ||
| − | <code>@variable/emailTo1;@variable/emailTo2</code> - "to" recipients<br> | + | :<code>@variable/emailTo1;@variable/emailTo2</code> - "to" recipients<br> |
| − | <code>@variable/emailCc</code> - "cc" recipient<br> | + | :<code>@variable/emailCc</code> - "cc" recipient<br> |
| − | <code>@variable/emailBcc</code> - "bcc" recipient<br> | + | :<code>@variable/emailBcc</code> - "bcc" recipient<br> |
| − | <code>@variable/emailSubject</code> - "subject" email parameter<br> | + | :<code>@variable/emailSubject</code> - "subject" email parameter<br> |
| − | <code>@variable/emailBody</code> - "body" email parameter<br> | + | :<code>@variable/emailBody</code> - "body" email parameter<br> |
| − | <code>1</code> - contains the number of sending attempts<br> | + | :<code>1</code> - contains the number of sending attempts<br> |
| − | <code>1000</code> - contains the number of miliseconds between each attempt<br> | + | :<code>1000</code> - contains the number of miliseconds between each attempt<br> |
| − | <code>@variable/successMessage</code> - success message content<br> | + | :<code>@variable/successMessage</code> - success message content<br> |
| − | <code>@variable/failMessage</code> - fail message content<br> | + | :<code>@variable/failMessage</code> - fail message content<br> |
| − | <code>true</code> - the email will be stored for offline email sending after all online attempts fail<br> | + | :<code>true</code> - the email will be stored for offline email sending after all online attempts fail<br> |
| − | <code>@variable/photoList(Fotos)</code> - contains the list of attachments<br> | + | :<code>@variable/photoList(Fotos)</code> - contains the list of attachments<br> |
| − | <code>@string/senderName</code> - contains the name of sender | + | :<code>@string/senderName</code> - contains the name of sender<br> |
| − | <code>[gn:act_sendEmail]| | + | :; ⤷ <code>[gn:act_sendEmail]|@variable/emailTo1; @variable/emailTo2, @variable/emailCc, ring/senderName]@variable/emailBcc, @variable/emailSubject, @variable/emailBody, 1, 1000, @variable/successMessage, @variable/failMessage, true, @variable/photoList(Fotos), @string/senderName]</code> |
| + | |||
<hr> | <hr> | ||
Revision as of 14:56, 12 July 2017
gn:act_sendEmail
- Description
- Used to send a silent email message to multiple recipients
- Action returns
- void
Action signatures
Send email
[gn:sendEmail]|[toRecipients{n}, ccRecipients{n}, bccRecipients{n}, subject{n}, body{n}, repeat, timeout, successMessage{n}, failMessage{n}, offlineMode, attachments, senderName]
Parameter Description toRecipients{n}optionalsource from where "to" emails will be retrieved
ccRecipients{n}optionalsource from where "cc" emails will be retrieved
bccRecipients{n}optionalsource from where "bcc" emails will be retrieved
subject{n}optionalsource from where email subject will be retrieved
body{n}optionalsource from where email body will be retrieved
repeatnumber which represents a number of attempts to send an email timeoutnumber which represents a number of miliseconds between attempts successMessage{n}optionalsource from where email success message will be retrieved
failMessage{n}optionalsource from where email fail message will be retrieved
offlineModeoptionalboolean which represents if the mail will be stored for offline email sending after all online attempts fail
attachmentsoptionalsource from where email attachments will be retrieved
- Valid sources:
- any source which supports
rowsColumn
- any source which supports
senderNameoptionalsource from where sender name will be retrieved
- Valid sources:
Example
@variable/emailTo1;@variable/emailTo2- "to" recipients@variable/emailCc- "cc" recipient@variable/emailBcc- "bcc" recipient@variable/emailSubject- "subject" email parameter@variable/emailBody- "body" email parameter1- contains the number of sending attempts1000- contains the number of miliseconds between each attempt@variable/successMessage- success message content@variable/failMessage- fail message contenttrue- the email will be stored for offline email sending after all online attempts fail@variable/photoList(Fotos)- contains the list of attachments@string/senderName- contains the name of sender
- ⤷
[gn:act_sendEmail]|@variable/emailTo1; @variable/emailTo2, @variable/emailCc, ring/senderName]@variable/emailBcc, @variable/emailSubject, @variable/emailBody, 1, 1000, @variable/successMessage, @variable/failMessage, true, @variable/photoList(Fotos), @string/senderName]
- ⤷
