0.1.1 |
|
---|---|
0.1.0 |
|
#109 in #步骤
16KB
205 代码行
Delta Chat 提供者信息
添加条目
首先检查提供者的文件是否已存在,如果已存在,请跳转到 编辑条目 部分。
将 [提供者名称].md 添加到以下格式中的 _providers 文件夹
---
name: [provider name]
domains: [ email domains of the provider / can also be yaml array when there are multiple ones can contain (€) to mark a premium domain]
credentials: [emailPass | emailAppPass | Oauth] - can also be an array, if multiple are supported availible
status:
state: [OK | PREP | BROKEN] - "PREP" stands for Preparation Steps needed
date: [YYYY-MM]
---
## Comments
[If there are any, but make sure everything regarding preparation is under "## Preparations"]
## Preparations
### Advanced Login Settings [if applicable]
```
[imap and smpt server addresses]
```
[if the provider requires additional steps, describe them here, you may also include images or a video tutorial of the process here]
## status history
[if you change the status, copy the previous here that we can allow for a history]
[has a table format? that we can color code the states]
[just a link to github changelog/history of this file?]
状态选项
状态 | 含义 |
---|---|
OK | 直接使用,无需额外步骤(此例外是自定义域名电子邮件地址,您可能需要手动指定 smtp 和 imap 服务器) |
PREP | 需要准备步骤/步骤 - (在执行一些步骤后即可正常工作 - 例如在提供者页面启用 imap/smtp) |
BROKEN | 无法使用 - 无法工作。 (太不稳定以至于无法使用也属于此类) |
编辑条目
条目
可选的 yaml front matter 字段
limits:
maxRecipients: number | "Unlimited"
messagesPerDay: number | "Unlimited"
maxFileSize: string | "Unlimited"
registration:
inviteOnly: boolean
PhoneAuthRequired: boolean
PersonalDataRequired: boolean
price: string
示例
---
name: example
website: example.com
credentials: emailPass | emailAppPass | Oauth
status:
state: OK | PREP | BROKEN
date: YYYY-MM
---
## Comments
This is an example provider
## Preperations
### Advanced Login Settings
```
imap mail.example.com:993
smtp mail.example.com:465
```
作为 cargo 包使用
用法
extern crate deltachat_provider_overview;
use deltachat_provider_overview::get_provider_info;
fn main() {
let (provider, _domains) = get_provider_info("example.org").unwrap();
println!("{}", provider.name);
if provider.status.state == deltachat_provider_overview::StatusState::PREPARATION {
println!("{}", provider.markdown);
}
}
有关更多信息,请参阅 cargo doc --open
无运行时依赖
~0–335KB