Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/odroe/easysms
Easy to use, simple configuration can send SMS messages to Phone. Easily expandable gateways, messages customized according to scenarios.
https://github.com/odroe/easysms
dart easysms flutter flutter-plugin sms
Last synced: 2 months ago
JSON representation
Easy to use, simple configuration can send SMS messages to Phone. Easily expandable gateways, messages customized according to scenarios.
- Host: GitHub
- URL: https://github.com/odroe/easysms
- Owner: odroe
- License: bsd-3-clause
- Created: 2020-07-24T09:46:52.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T19:11:58.000Z (4 months ago)
- Last Synced: 2024-10-29T14:22:13.121Z (3 months ago)
- Topics: dart, easysms, flutter, flutter-plugin, sms
- Language: Dart
- Homepage: https://pub.dev/packages/easysms
- Size: 129 KB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# EasySMS
Easy to use, simple configuration can send SMS messages to Phone. Easily expandable gateways, messages customized according to scenarios.
[](https://pub.dev/packages/easysms)
[](https://github.com/odroe/easysms/actions/workflows/test.yml)
## Installation
This will add a line like this to your packages `pubspec.yaml` (and run an implicit `dart pub get`):
```yaml
dependencies:
easysms: latest
```
Or install it from the command line:
```shell
dart pub add easysms
```
## Features
- **Gateway**: Support multiple gateways, you can customize the gateway according to your needs.
- **Message**: Support multiple message templates, you can customize the message according to your needs.
- **Universal**: Universal design, no need to write separate handlers for each service provider.
- **Strategy**: Support gateway selection strategy.
- **Retry**: Support gateway and strategy based retry mechanism.
## Sponsors
EasySMS is an [BSD-3 Clause licensed](LICENSE) open source project with its ongoing development made possible entirely by the support of these awesome backers. If you'd like to join them, please consider [sponsoring Odroe development](https://github.com/sponsors/odroe).
## Usage
```dart
import 'package:easysms/easysms.dart';
final easysms = EasySMS(
gateways: [...] // Gateway list
);
final message = Message.fromValues(
template: '',
data: {
'SignName': "",
'TemplateParamSet': [
'',
'',
// ...
],
},
);
main() async {
final phone = PhoneNumber('', '');
final response = await easysms.send([phone], message);
print('Status: ${response.first.success}'); // true or false
}
```
## Message
You can create your own scene messages based on the message:
```dart
import 'package:easysms/easysms.dart';
class OneTimePasswordMessage implements Message {
final String password;
final Duration ttl;
OneTimePasswordMessage(this.password, this.ttl);
@override
Future> toData(Gateway gateway) {
// ...
}
@override
Future toTemplate(Gateway gateway) {
// ...
}
@override
Future toText(Gateway gateway) {
// ...
}
}
```
### Built-in Message
#### `formValues`
```dart
final message = Message.fromValues(
text: '',
template: '',
data: {
// ...
},
);
```
#### `fromCallbacks`
```dart
final message = Message.fromCallbacks(
text: (gateway) async => '',
template: (gateway) async => '',
data: (gateway) async => {
// ...
},
);
```
## Gateways
| Gateway | Platform | Description |
| ------------------------ | ---------------------------------------------------------- | ------------------------- |
| `TencentCloudSmsGateway` | [Tencent Cloud SMS](https://cloud.tencent.com/product/sms) | Tencent Cloud SMS gateway |
| `SmsBaoGateway` | [短信宝](https://www.smsbao.com/) | 短信宝 SMS gateway |
**If the platform you need to use is not listed here, you have several ways to support it:**
1. Create an [issue](https://github.com/odroe/easysms/issues/new) to request support for the platform.
2. Create an [pull request](https://github.com/odroe/easysms/pulls) to add support for the platform.
3. You can create a gateway Dart package yourself,
4. You can implement the gateway yourself in your project without telling anyone.
### How to create a gateway
You must depend on the `easysms` package and implement the `Gateway` interface:
```dart
import 'package:easysms/easysms.dart';
class MyGateway implements Gateway {
@override
Future> send(
Iterable to, Message message, http.Client client) async {
// ...
}
}
```
You can refer to [all the gateways](/lib/) we have implemented.
## Strategies
EasySMS allows you to customize the gateway selection strategy.
```dart
class MyStrategy implements Strategy {
@override
Future select(Iterable gateways) async {
// ...
}
}
```
We implemented a built-in strategy, for example, you can use the `OrderStrategy`:
```dart
final easysms = EasySMS(
gateways: [...],
strategy: const OrderStrategy(),
);
```
**Note**: The `OrderStrategy` will select the gateway in the order of the gateway list.
## Contributing
We welcome contributions! Please read our [contributing guide](CONTRIBUTING.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to EasySMS.
Thank you to all the people who already contributed to Odroe!
[](https://github.com/odroe/prisma-dart/graphs/contributors)
## Stay in touch
- [Website](https://odroe.com)
- [Twitter](https://twitter.com/odroeinc)
- [Discord](https://discord.gg/r27AjtUUbV)