Skip to end of metadata
Go to start of metadata

Availability

This routine is available starting with SIL Engine™ 1.0, changed in 1.1.14 for Jira 4.3.x / 4.4.x and 2.0.7 for Jira 5.x.

Syntax

sendEmail([from], to, [cc], subject, body_or_template, [language]

Starting with katl-commons 2.0.7, the syntax is following:

sendEmail(from, to, cc, subject, body_or_template, language, issue_key, regex_array

sendEmail(from, to, cc, subject, body_or_template, language, wildcard_path_array

Or

sendEmail(JEmailMessage)

Description

Sends an email.

To and cc are string arrays with any of email addresses, users or groups. Email is sent to all the users of the groups.

From is optional. If missing the email is sent from the default email address configured in Jira.

To pass the language specify the 'sender', 'to', 'cc', 'subject', 'body' and finally the 'language', as a string (for instance "en", "fr", "en_US", "ro", and so on). However, this is relevant only if you use templates as they support localization.

For example, an email sent with language "en" will look for templates in the folder called "en", inside the default template directory. If no such template is found, it will use the one in the default directory.

Also, starting with katl-commons-1.1.1, a default template placed in the default directory is mandatory for each template name used in your SIL programs. For example, if you want to use a template "t.tpl" using language "en_US", it is not only necessary to have "t.tpl" in the "en_US" folder, but you have to have a file "t.tpl" in the default directory.

If you don't specify the language parameter and you use templates, by default the messages are sent in the sender defined language. For the users that are Jira users ('to' or 'cc' are user names and not email addresses) the language defined in the user profile(for each user) is used for email sending. For the rest of the users the email is sent using the sender defined language.

Starting with version 4.0, the engine automatically detects HTML or plain text messages.

Parameters

Parameter name

Type

Required

Description

from

string

no

From address

to

string []

yes

Recipient list

cc

string []

no

CC'ed recipient list

subject

string

yes

Subject

body_or_template

string

yes

Message body, either direct or a template

language

string

no

Language used to send the email(relevant only if you use templates)

issue_keystringnoIssue to extract attachments from
regex_arraystring []if issue_key is presentName patterns to match the attachments from the issue
wildcard_path_arraystring []noAbsolute paths containing wildcards for attaching files from disk

Or

Parameter name

Type

Required

Description



JEmailMessage








JEmailMessage







yes







Predefined email message structure. The structure contains the following fields
Field NameField TypeRequired
tostring []yes
ccstring []no
bccstring []no
subjectstringyes
messagestringyes
fromstringno
attachmentsJEmailAttachment []no


Alias

For historical reasons, this routine may be named 'sendEmailFrom'.

Starting with version 4.0, 'sendHtmlEmail' was registered as an alias, too (there is no need for sendHtmlEmail anymore)

Example

Example 1

sendEmail("projectmanager", "teamleader1", "Transition executed", currentUser() + " has executed a transition");
// here we have to, cc, subject and body.
// The from and language parameters were omitted.

Example 2

If SendEmailLanguage has the value receiver_language, testJiraUser1 is a Jira user having the defined language French and testJiraUser2 is a Jira user having the defined language German.

string [] to = {"testJiraUser1", "testEmail@cprime.com", "testJiraUser2"};
string [] cc = {"testEmail2@cprime.com"};
sendEmail("testFrom@cprime.com", to, cc, "testSubject.tpl", "testBody.tpl");

Result: One email in French will be sent to testJiraUser1, one email in German for testJiraUser2 and one email in the sender defined language for testEmail@cprime.com(as to) and testEmail2@cprime.com(as cc).

Example 3

Is similar with example 2, but here the language parameter is used.

If SendEmailLanguage has the value receiver_language, testJiraUser1 is a Jira user having the defined language French and testJiraUser2 is a Jira user having the defined language German.

string [] to = {"testJiraUser1", "testEmail@cprime.com", "testJiraUser2"};
string [] cc = {"testEmail2@cprime.com"};
sendEmail("testFrom@cprime.com", to, cc, "testSubject.tpl", "testBody.tpl", "en_US");

Result: It will be sent one email in English(because of the en_US language parameter).

Example 4

This example will demonstrate the ability to attach files (to the email) selected from the attachments of the issue using regex patterns.

We will assume that the issue has three attachments: attachment1.txt, attachment2.txt and attachment3atxt (note that this last one does not have a dot to separate the extension).

Now let's see a few examples of regex patterns that will match some of the attachment. Note that we will use key to specify the current issue, but feel free to use any other issue key.

sendEmail("santa@cprime.com", {"jira-users"}, {}, "santa_subject.tpl", "santa_letter.tpl", key, {"attachment.*"}); 

This will match all of the attachments. Since we are using regex patterns, attachment.* will match anything that starts with attachment.

sendEmail("santa@cprime.com", {"jira-users"}, {}, "santa_subject.tpl", "santa_letter.tpl", key, {"attachment.\\.txt"}); 

This will match attachment1.txt and attachment2.txt. The first dot will match any character (the 1 and 2). Note that the second dot is escaped using double backslashes and will not match attachment3atxt.

sendEmail("santa@cprime.com", {"jira-users"}, {}, "santa_subject.tpl", "santa_letter.tpl", key, {"attachment1\\.txt", "attachment3atxt"}); 

This will match attachment1.txt and attachment3atxt.

Don't forget to use double backslashes when escaping special characters in regex patterns.

Example 5

You can also attach files directly from disk by specifying absolute paths. Note that you can also use * (anything) and ? (any single char) as wildcards.

sendEmail("santa@cprime.com", {"jira-users"}, {}, "santa_subject.tpl", "santa_letter.tpl", {"C:/gifts/jira-users*.gift"}); 

Example 6 - JEmailMessage

You can also use the JEmailMessage structure type when sending an email. This option can make the code a little cleaner.

JEmailMessage email;
email.to = {"testJiraUser1", "testEmail@cprime.com", "testJiraUser2"};
email.subject = "Email to Santa";
email.message = "Dear Santa, I want a train.";

sendEmail(email);

Here is the same example that includes adding attachments to the email. This requires the use of the JEmailAttachment structure type.

JEmailMessage email;
email.to = {"testJiraUser1", "testEmail@cprime.com", "testJiraUser2"};
email.subject = "Email to Santa";
email.message = "Dear Santa, I want a train.";


for(string a in attach) {   
    JEmailAttachment att;
    att.name = a;
    att.file = getAttachmentPath(key, a);
    email.attachments += att;
}

sendEmail(email);

Notes

If you would like to use templates for emails, see the Mail configuration page, as well as detailed explanations linked our template engine: SIL™ Template language. Specifically, read Email templates page.

 In order for the HTML to be rendered all right, it needs to be written right (using the <html> and <body> tags).


See also