nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

ScriptRunner: Sending outlook invitation as custom mail

Christian Schlaefcke

Hi,

I want to use the ScriptRunner built-in script send custom email in order to send MS Outlook invitations.

I am already able to create an ICS-Attachment on the issue with a custom scriptrunner script. And I am able to send this attachment with the built-in script but in Outlook it would not be detected as an invitation mail.

In this stackoverflow-entry I found a hint about how to create proper Outlook invitations and I wonder if it would be possible to adopt this somehow.

Kind Regards,

Christian

Accepted answers

Christian Schlaefcke

Hi Jamie,

thank you for the hint! Kind of helpful was also the recipes area (Validating Attachments/Links in Transitions) of the script runner docs.

I had to fiddle around quite a while but combining the SR docs with another stackoverflow-entry was actually the breakthrough.

Here is what I put in the Condition and Configuration area of the Send a custom email post-function:

import com.atlassian.jira.component.ComponentAccessor
import org.apache.log4j.Logger
import org.apache.log4j.Level


import java.io.File


import javax.activation.DataHandler;


import javax.mail.util.ByteArrayDataSource;
import javax.mail.internet.MimeBodyPart
import javax.mail.internet.MimeMultipart
import javax.mail.internet.MimeUtility


def log = Logger.getLogger("my.company.SendOutlookInvitation")


log.setLevel(Level.DEBUG)
log.debug("#####################################")
def last_attachment = issue.attachments.last()
def file_name = last_attachment.filename.toString()
def file_type = last_attachment.mimetype.toString()
def file_id = last_attachment.id


log.debug("FILE_NAME: " + file_name)
log.debug("FILE_TYPE: " + file_type)


def attachmentPathManager = ComponentAccessor.getAttachmentPathManager().attachmentPath.toString()
def projectKey = issue.getProjectObject().getKey()
def file_path = attachmentPathManager + "/" + projectKey + "/" + issue.key + "/" + file_id + "/"
log.debug("FILE_PATH: " + file_path)


File f = new File(file_path);
if(f.exists() &amp;&amp; !f.isDirectory()) {
    mail.addHeader("method", "REQUEST");
    mail.addHeader("charset", "UTF-8");
    mail.addHeader("component", "VEVENT");
    log.debug("FILE_EXISTS: YES")
    log.debug("FILE_TEXT:" + f.text)
    def mp = new MimeMultipart("alternative")
    def calendarPart = new MimeBodyPart()
    calendarPart.setHeader("Content-Class", "urn:content-  classes:calendarmessage");
    calendarPart.setHeader("Content-ID", "calendar_message");
    calendarPart.setDataHandler(new DataHandler(new ByteArrayDataSource(f.text, "text/calendar")));
    mp.addBodyPart(calendarPart)
    mail.setMultipart(mp)
} else {
    log.debug("FILE_EXISTS: NO")
}


log.debug("#####################################")
true

I do not have to include any attachments with the general post-function config. This will be handled by this configuration script completely.

The above scripts expects that a proper ics file is already attached to the issue or will be attached during the current transition (in my case another SR script using the attachmentManager). In this second case the mail has to be send at the end of the post-functions so that attaching has already been performed.

Now the mail appears perfectly as an Outlook invitation thumbs-up smile

All comments

JamieA

You have full control over the Mail object, so you should be able to do it. The closest thing in the docs is https://scriptrunner.adaptavist.com/latest/jira/builtin-scripts.html#_adding_generated_attachments.

In the linked SO.com answer it says outlook ignores the ICS attachment. So you need to create and add a new mail part of type "text/calendar" with the contents of the ics file.

Christian Schlaefcke

Hi Jamie,

thank you for the hint! Kind of helpful was also the recipes area (Validating Attachments/Links in Transitions) of the script runner docs.

I had to fiddle around quite a while but combining the SR docs with another stackoverflow-entry was actually the breakthrough.

Here is what I put in the Condition and Configuration area of the Send a custom email post-function:

import com.atlassian.jira.component.ComponentAccessor
import org.apache.log4j.Logger
import org.apache.log4j.Level


import java.io.File


import javax.activation.DataHandler;


import javax.mail.util.ByteArrayDataSource;
import javax.mail.internet.MimeBodyPart
import javax.mail.internet.MimeMultipart
import javax.mail.internet.MimeUtility


def log = Logger.getLogger("my.company.SendOutlookInvitation")


log.setLevel(Level.DEBUG)
log.debug("#####################################")
def last_attachment = issue.attachments.last()
def file_name = last_attachment.filename.toString()
def file_type = last_attachment.mimetype.toString()
def file_id = last_attachment.id


log.debug("FILE_NAME: " + file_name)
log.debug("FILE_TYPE: " + file_type)


def attachmentPathManager = ComponentAccessor.getAttachmentPathManager().attachmentPath.toString()
def projectKey = issue.getProjectObject().getKey()
def file_path = attachmentPathManager + "/" + projectKey + "/" + issue.key + "/" + file_id + "/"
log.debug("FILE_PATH: " + file_path)


File f = new File(file_path);
if(f.exists() &amp;&amp; !f.isDirectory()) {
    mail.addHeader("method", "REQUEST");
    mail.addHeader("charset", "UTF-8");
    mail.addHeader("component", "VEVENT");
    log.debug("FILE_EXISTS: YES")
    log.debug("FILE_TEXT:" + f.text)
    def mp = new MimeMultipart("alternative")
    def calendarPart = new MimeBodyPart()
    calendarPart.setHeader("Content-Class", "urn:content-  classes:calendarmessage");
    calendarPart.setHeader("Content-ID", "calendar_message");
    calendarPart.setDataHandler(new DataHandler(new ByteArrayDataSource(f.text, "text/calendar")));
    mp.addBodyPart(calendarPart)
    mail.setMultipart(mp)
} else {
    log.debug("FILE_EXISTS: NO")
}


log.debug("#####################################")
true

I do not have to include any attachments with the general post-function config. This will be handled by this configuration script completely.

Now the mail appears perfectly as an Outlook invitation thumbs-up smile

JamieA

Nice job... minor thing, I'm not sure that's the best way to get the attachment file. If the issue has been moved that may not work IIRC.

Christian Schlaefcke

Thank you! In my case the attachment will be created on the same transition with first post function using another script - so in my case it could not happen that the attachment location would not fit to the issue key.

But I put a warning regarding this handling/precondition and maybe for other cases someone else finds a more robust implementation smile

Matthew Harkins

Christian and Jamie, Thanks for posting this! This was almost exactly what I needed. I was able to build on Christian's example above and now have a single block of code that injects a temporary attachment into a scriptrunner "send a custom email" post function to deliver an ics calendar invitation / reminder to an assignee for a task.

Connor Sims

Christian,

Would you share the script you used to create an ICS file and attach it to the issue?

Thanks,

Connor

roniz

Hi @Jamie Echlin, @Matthew Harkins, @Christian Schlaefcke- great post!!

I tried making this work, unfortunately with out much success:

I created a new custom field (type Text Field (single line)) by the name "UUID" and set is as a Custom script post-function:
import com.atlassian.jira.component.ComponentAccessor
def customFieldManager = ComponentAccessor.getCustomFieldManager()
def cf = customFieldManager.getCustomFieldObjectByName("UUID")
issue.setCustomFieldValue(cf, UUID.randomUUID().toString())
Is this ok? should I do any thing further? does this field need to be attached to a screen in the workflow? did not quirt understand its purpose..
In the next Status I created a post function "Send a custom email" i took @Matthew Harkins's scripts and in the condition changed

"Custom Start DateTime"--> "Estimated start time"
"Custom End DateTime" --> "Estimated complition time"
"Custom UUID" --> "UUID"

all the rest is the same

I did not do any thing with a ICS file- sould I?

and it did not work ):

Any thoughts please?

Many many thanks in advance!

Normann P_ Nielsen _Netic_

I like Matthews scripts works well - but how do I set the filename?

In Mac's Mail.app its becoming "Mail Attachment" and people cant see its an invite

Worksbetter in GMail.

BR,

Normann

Chris Dunne _Raledo_

This solution worked well for me but I had some problems with Outlook in Office 365. The email invitations were not being recognised and the email just looked like an ordinary email (no RSVP buttons), and there was no ICS file attached.

I changed one line from

calendarPart.setDataHandler(new DataHandler(new ByteArrayDataSource(iCal, 
"text/calendar")));

calendarPart.setDataHandler(new DataHandler(new ByteArrayDataSource(iCal, "text/calendar;method=REQUEST;name=\"meeting.ics\"")));

Initial tests look good and both Outlook and Gmail receive valid invitations.

Chris

Matthew Harkins

Nice work @Chris Dunne _Raledo_! I can second your fix. This enabled usable ical notifications for our o365 users and continued to function normally for our on premises users.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

scriptrunner

jira

jira-administration

jira-core