Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleAvailability

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.

...

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

Starting with katl-commons 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

Excerpt

Sends an email.

...

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'.

...

Code Block
string [] to = {"testJiraUser1", "testEmail@keplertestEmail@cprime.rocom", "testJiraUser2"};
string [] cc = {"testEmail2@keplertestEmail2@cprime.rocom"};
sendEmail("testFrom@keplertestFrom@cprime.rocom", 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@keplertestEmail@cprime.rocom(as to) and testEmail2@keplertestEmail2@cprime.rocom(as cc).

Example 3

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

...

Code Block
string [] to = {"testJiraUser1", "testEmail@keplertestEmail@cprime.rocom", "testJiraUser2"};
string [] cc = {"testEmail2@keplertestEmail2@cprime.rocom"};
sendEmail("testFrom@keplertestFrom@cprime.rocom", to, cc, "testSubject.tpl", "testBody.tpl", "en_US");

...

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.

Code Block
sendEmail("santa@keplersanta@cprime.rocom", {"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.

Code Block
sendEmail("santa@keplersanta@cprime.rocom", {"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.

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

...

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.

Code Block
sendEmail("santa@keplersanta@cprime.rocom", {"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.

Code Block
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.

Code Block
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

Note

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.

...