Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pagopa-archive/selfcare-ms-notification-manager

Microservice responsible for sending notification to user. Mail can send using SMTP server, as default, or AWS SES service.
https://github.com/pagopa-archive/selfcare-ms-notification-manager

Last synced: 2 months ago
JSON representation

Microservice responsible for sending notification to user. Mail can send using SMTP server, as default, or AWS SES service.

Host: GitHub
URL: https://github.com/pagopa-archive/selfcare-ms-notification-manager
Owner: pagopa-archive
Archived: true
Created: 2022-01-24T11:56:49.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-06-05T11:00:35.000Z (8 months ago)
Last Synced: 2024-12-10T17:13:23.201Z (2 months ago)
Language: Java
Homepage:
Size: 261 KB
Stars: 0
Watchers: 7
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        # Microservice ms-notification-manager

Microservice responsible for sending notification to user. Mail can send using SMTP server, as default, or AWS SES service. For use AWS SES you must set MAIL_CONNECTOR_TYPE as 'aws', it will use aws credential described below to authenticate request.

## Required Configuration Properties

Before running you must set these properties as environment variables. AWS_SES_ACCESS_KEY_ID and AWS_SES_SECRET_ACCESS_KEY must be valued is MAIL_CONNECTOR_TYPE is 'aws'.

| **Property**                                  | **Environment Variable**                 | **Default** | **Required** |

|-----------------------------------------------|------------------------------------------|-------------|:------------:|

| jwt.signingKey
                           | JWT_TOKEN_PUBLIC_KEY                     |             |     yes      |

|spring.mail.host
                          | MAIL_SERVER_HOST                         |             |     yes      |

|spring.mail.port                               | MAIL_SERVER_PORT                         |             |     yes      |

|spring.mail.username                           | MAIL_SERVER_USERNAME                     |             |     yes      |

|spring.mail.password                           | MAIL_SERVER_PASSWORD                     |             |     yes      |

|spring.mail.properties.mail.smtp.auth          | MAIL_SERVER_SMTP_AUTH                    |             |     yes      |

|spring.mail.properties.mail.smtp.*.enable      | MAIL_SERVER_SMTP_TLS_ENABLE              |             |     yes      |

|spring.mail.protocol                           | MAIL_SERVER_PROTOCOL                     |             |     yes      |

## Running the application

You can run your application using:

```shell script

./mvnw install

./mvnw spring-boot:run -pl app

```

Application will respond to the url http://localhost:8080

## All Configuration Properties

| **Application properties** |

|:--------------------------:|

| **Property** | **Environment Variable** | **Default** | **Required** |

|--------------|-------------------------|-------------|:------------:|

|server.port|MS_NOTIFICATION_MANAGER_SERVER_PORT|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|spring.application.name| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|spring.application.version| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|spring.profiles.include| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|spring.zipkin.enabled| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|spring.sleuth.baggage.remote-fields| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|spring.sleuth.baggage.correlation-fields| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|info.build.artifact| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|info.build.name| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|info.build.description| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|info.build.version| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|logging.level.it.pagopa.selfcare| MS_NOTIFICATION_MANAGER_LOG_LEVEL |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

|logging.pattern.level| n/a |[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/app/src/main/resources/config/application.yml)| yes |

| **Email Connector Configurations** |

|:----------------------------------:|

| **Property** | **Environment Variable** | **Default** | **Required** |

|--------------|-------------------------|-------------|:------------:|

|spring.mail.host|MAIL_SERVER_HOST|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes |

|spring.mail.port|MAIL_SERVER_PORT|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes |

|spring.mail.username|MAIL_SERVER_USERNAME|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes |

|spring.mail.password|MAIL_SERVER_PASSWORD|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes |

|spring.mail.properties.mail.smtp.auth|MAIL_SERVER_SMTP_AUTH|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes|

|spring.mail.properties.mail.smtp.starttls.enable|MAIL_SERVER_SMTP_TLS_ENABLE|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes|

|spring.mail.protocol|MAIL_SERVER_PROTOCOL|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes|

|spring.mail.connector.type|MAIL_CONNECTOR_TYPE|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes|

|aws.ses.secret-id|AWS_SES_ACCESS_KEY_ID|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes|

|aws.ses.secret-key|AWS_SES_SECRET_ACCESS_KEY|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes|

|aws.ses.region|AWS_SES_REGION|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/connector/email/src/main/resources/config/email.properties)| yes|

| **Email Core Configurations** |

|:-----------------------------:|

| **Property** | **Environment Variable** | **Default** | **Required** |

|--------------|--------------------------|-------------|:------------:|

|notification_manager.mail.customer-care|CUSTOMER_CARE_MAIL|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/core/src/main/resources/config/email-core-config.properties)| yes |

|notification_manager.mail.no-reply|NO_REPLY_MAIL|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/core/src/main/resources/config/email-core-config.properties)| yes |

|notification_manager.mail.customer-care-subject-prefix|CUSTOMER_CARE_MAIL_SUBJECT_PREFIX|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/core/src/main/resources/config/email-core-config.properties)| yes |

|notification_manager.mail.user-subject-prefix|NOTIFICATION_TO_USER_SUBJECT_PREFIX|[default_property](https://github.com/pagopa/selfcare-ms-notification-manager/blob/release-dev/core/src/main/resources/config/email-core-config.properties)| yes |