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

New Script: Mailrise (SMTP Gateway) #1340

Closed
wants to merge 10 commits into from

Conversation

choehn86
Copy link

@choehn86 choehn86 commented Jan 9, 2025

🛠️ Note:
We are meticulous about merging code into the main branch, so please understand that pull requests not meeting the project's standards may be rejected. It's never personal!
🎮 Note for game-related scripts: These have a lower likelihood of being merged.


✍️ Description

This pull request is for a new script to establish a Mailrise LXC (https://github.com/YoRyan/mailrise/), an SMTP gateway for Apprise notifications.


🛠️ Type of Change

Please check the relevant options:

  • Bug fix (non-breaking change that resolves an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change unexpectedly)
  • New script (a fully functional and thoroughly tested script or set of scripts)

✅ Prerequisites

The following steps must be completed for the pull request to be considered:

  • Self-review performed (I have reviewed my code to ensure it follows established patterns and conventions.)
  • Testing performed (I have thoroughly tested my changes and verified expected functionality.)
  • Documentation updated (I have updated any relevant documentation)

📋 Additional Information (optional)

This is my first script contribution and first pull request, open to any critiques or suggestions (even if it's not ultimately accepted for merging)

@choehn86 choehn86 requested a review from a team as a code owner January 9, 2025 03:34
Copy link
Contributor

github-actions bot commented Jan 9, 2025

Script validation

❌ We found issues in the following changed files:

Not executable:

  • ct/mailrise.sh
  • install/mailrise-install.sh
  • json/mailrise.json

Copyright header line missing or invalid:

  • json/mailrise.json

Author header line missing or invalid:

  • json/mailrise.json

License header line missing or invalid:

  • install/mailrise-install.sh
  • json/mailrise.json

Source header line missing or invalid:

  • install/mailrise-install.sh
  • json/mailrise.json

Script formatting

❌ We found issues in the formatting of the following changed files:

diff ct/mailrise.sh.orig ct/mailrise.sh
--- ct/mailrise.sh.orig
+++ ct/mailrise.sh
@@ -25,18 +25,18 @@
 catch_errors
 
 function update_script() {
-    header_info
-    check_container_storage
-    check_container_resources
-    if [[ ! -f /usr/local/bin/mailrise ]]; then
-        msg_error "No ${APP} Installation Found!"
-        exit
-    fi
-    msg_info "Updating ${APP} LXC"
-    pip3 install mailrise --upgrade &>/dev/null
-    systemctl restart mailrise.service
-    msg_ok "Updated Successfully"
+  header_info
+  check_container_storage
+  check_container_resources
+  if [[ ! -f /usr/local/bin/mailrise ]]; then
+    msg_error "No ${APP} Installation Found!"
     exit
+  fi
+  msg_info "Updating ${APP} LXC"
+  pip3 install mailrise --upgrade &>/dev/null
+  systemctl restart mailrise.service
+  msg_ok "Updated Successfully"
+  exit
 }
 
 start
diff install/mailrise-install.sh.orig install/mailrise-install.sh
--- install/mailrise-install.sh.orig
+++ install/mailrise-install.sh
@@ -5,7 +5,7 @@
 # License: MIT
 # https://github.com/community-scripts/ProxmoxVE/raw/main/LICENSE
 
-source /dev/stdin <<< "$FUNCTIONS_FILE_PATH"
+source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
 color
 verb_ip6
 catch_errors

@github-actions github-actions bot added new script A change that adds a new script website A change to the website labels Jan 9, 2025
ct/mailrise.sh Outdated Show resolved Hide resolved
install/mailrise-install.sh Outdated Show resolved Hide resolved
install/mailrise-install.sh Outdated Show resolved Hide resolved
install/mailrise-install.sh Show resolved Hide resolved
install/mailrise-install.sh Outdated Show resolved Hide resolved
json/mailrise.json Outdated Show resolved Hide resolved
choehn86 and others added 5 commits January 9, 2025 10:44
updated copyright/author
Co-authored-by: Michel Roegl-Brunner <[email protected]>
Co-authored-by: Michel Roegl-Brunner <[email protected]>
corrected copyright/author/license, added source
Added link to discussion/guide
@MickLesk
Copy link
Member

MickLesk commented Jan 9, 2025

Is this worth to add? 1 year no commit

@michelroegl-brunner
Copy link
Member

Oh i did not check that before. You might be right here.

@MickLesk
Copy link
Member

Any Feedback? Or we close this tomorrow

@MickLesk
Copy link
Member

MickLesk commented Jan 16, 2025

Closing due to lack of response. Please feel free to reopen or create a new PR if needed. @choehn86

@MickLesk MickLesk closed this Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new script A change that adds a new script website A change to the website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants