Attachments with custom form service

[andersonshatch]

I'm thinking of using mailrise (which uses apprise underneath) to receive emailed PDF scans from my printer, with the destination being paperless-ngx.
The custom form service gets pretty close to doing this with the following URL: forms://username:password@paperless/api/documents/post_document%2F
(I had to URL encode the trailing slash to %2F as it'd get stripped off otherwise, and the endpoint only works with the trailing slash)

This API endpoint requires the file attachment to be in the multipart request named document, where the current version names attachments like file01, file02... and doesn't allow any customisation.
It'd be good to allow specifying the name of the multipart part in the URL.

The API endpoint also only takes in 1 attachment. Whilst it probably isn't an issue for my use-case - the printer will just send one attachment per email -- it'd be good to have an option to send several requests when several attachments are provided.
And, this would be needed when you can customise the part name, otherwise all attachments will be sent with that name. Paperless-ngx at least, will then just see the last attachment only.

[caronc]

Pretty sure this might be covered for you. The problem with Apprise is that it does a lot, but it's very poorly documented. I think this might be one of those cases.

--attach /path/tomyfile.pdf is well known to Apprise, but what isn't is the URL version which grants you parameters.

So the following would also work and rename the file:
--attach file:///path/tomyfile.pdf?name=file01

I'm not sure if this is the effect you're looking for?

[andersonshatch]

Hmm, I don't think I have access to that path URL, as it's generated internally by Mailrise.
I also am not sure this would be what I want. I think what you propose there would result in the name of the file being sent as 'file01', but I need to adjust the part name it's sent in instead.
As I understand it, the part name is generated here. In some local testing, just setting that to instead read as below gets me to what I need:

files.append((
                        'document', (
                            attachment.name,
                            open(attachment.path, 'rb'),
                            attachment.mimetype)
                    ))

But this kind of hard-coding is clearly not generally useful for the service, I'm aware.
This is how files are currently coming through, as seen when testing on webhook.site:

But the API I am working with, only looks at parts named document, which I think I can only achieve with the above patch?

[caronc]

I'm not sure if this is a change required by Apprise then in this case, or mailrise. I'll ping @YoRyan for this thoughts.

[caronc]

Fair enough; my apologizes, i have a PR going at #827 which should address this request (and also support other variations). it is only applied to the form:// and forms:// schemas though.

(i snuck in a few other fixes as well that are minor that somewhat pollute the PR, but not by much)

[YoRyan]

Nothing to apologize for. We are all here to solve problems. 😁

[andersonshatch]

Thank you both for your help, the linked PR works great for this need!

[caronc]

Great, i just need to fix up the code coverage (bring it back to 100%) and then I'll merge it

[caronc]

@andersonshatch - Merged; so it will be part of the next release.