Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Syntax
Table plus
applyColStyleToCelltrue
heading0
columnTypess,s,s,s
heading0
multiplefalse
columnAttributesstyle="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold,
enableSortingfalse

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

Package

Alias

Pkg Usage

Description

Excerpt
hiddentrue

Sends an email.

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.

...

Table plus
applyColStyleToCelltrue
columnTypess,s,s,s
heading0
multiplefalse
enableSortingfalse

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_key

String

No

Issue to extract attachments from

regex_array

String []

No

Name patterns to match the attachments from the issue

wildcard_path_array

String []

No

Absolute paths containing wildcards for attaching files from disk

Return Type

...

Examples

Example 1

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

...

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);

See also

Filter by label (Content by label)
showLabelsfalse
max25
showSpacefalse
cqllabel = "system_routine" and space = currentSpace ( )
labelsarray_routines