Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update existing documentation for SMS-related plugins #1247

Open
joergschultzelutter opened this issue Nov 28, 2024 · 3 comments
Open

Update existing documentation for SMS-related plugins #1247

joergschultzelutter opened this issue Nov 28, 2024 · 3 comments

Comments

@joergschultzelutter
Copy link
Contributor

💡 Update the documentation pages for all existing SMS messenger modules

I was contacted by a user who extensively uses my Apprise DAPNET module (which is part of Apprise's SMS messenger group). Similar to all messenger modules in this particular group, the DAPNET plugin is not capable of transmitting both title and body input data files (whereas submitted by the user). Whenever the user supplies title data, this data is ignored by Apprise - see also

# A title can not be used for SMS Messages.  Setting this to zero will
# cause any title (if defined) to get placed into the message body.
title_maxlen = 0

To me, this constraint make total sense as any SMS-related messengers aren't capable of transmitting title data. However, when looking at the SMS category's plugin documentation pages, all of these pages convey the idea that sending a mesage with body and title is possible. Example:

# Assuming our {APIKey} is gank339l7jk3cjaE
# Assuming our {FromPhoneNo} - is in the US somewhere making our country code +1
#                            - identifies as 1-123-555-1223
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   msgbird://gank339l7jk3cjaE/11235551223

# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   msgbird://gank339l7jk3cjaE/1-(123) 555-1223

This difference between documentation and reality 😄 caused some confusion for my contact as he was wondering why the title information was always suppressed.

💡 Suggested change
For all SMS messenger modules, update the documentation pages and indicate that the title information is ignored.

Thanks
Joerg

@caronc
Copy link
Owner

caronc commented Dec 18, 2024

Sorry for the delay, i promise this hasn't been forgotten. Will try to look further into it soon

@caronc
Copy link
Owner

caronc commented Dec 20, 2024

As an update to this, I can follow through, but in actual fact, the title isn't ignored, it's just prepended to the body. But perhaps this spedfic wording is what your asking be updated to all documents?

@joergschultzelutter
Copy link
Contributor Author

Thanks for following up on this issue. In order to avoid over-complicating things:

Rather than updating all documents: how about adding 1-2 explanatory sentences below the https://github.com/caronc/apprise?tab=readme-ov-file#sms-notifications header?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants