Alpha-sort adapters

Add various labels, descriptions and suggestions for all adapter settings and try to use
the same terminology by the service provider.
This commit is contained in:
Mark Felder 2021-02-06 13:18:48 -06:00
parent 0fcf16dcb8
commit f736501e97
1 changed files with 52 additions and 59 deletions

View File

@ -216,6 +216,7 @@
children: [ children: [
%{ %{
key: :enabled, key: :enabled,
label: "Mailer Enabled",
type: :boolean, type: :boolean,
}, },
%{ %{
@ -224,18 +225,18 @@
description: description:
"One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)", "One of the mail adapters listed in [Swoosh documentation](https://hexdocs.pm/swoosh/Swoosh.html#module-adapters)",
suggestions: [ suggestions: [
Swoosh.Adapters.AmazonSES,
Swoosh.Adapters.Dyn,
Swoosh.Adapters.Gmail,
Swoosh.Adapters.Mailgun,
Swoosh.Adapters.Mailjet,
Swoosh.Adapters.Mandrill,
Swoosh.Adapters.Postmark,
Swoosh.Adapters.SMTP, Swoosh.Adapters.SMTP,
Swoosh.Adapters.Sendgrid, Swoosh.Adapters.Sendgrid,
Swoosh.Adapters.Sendmail, Swoosh.Adapters.Sendmail,
Swoosh.Adapters.Mandrill,
Swoosh.Adapters.Mailgun,
Swoosh.Adapters.Mailjet,
Swoosh.Adapters.Postmark,
Swoosh.Adapters.SparkPost,
Swoosh.Adapters.AmazonSES,
Swoosh.Adapters.Dyn,
Swoosh.Adapters.SocketLabs, Swoosh.Adapters.SocketLabs,
Swoosh.Adapters.Gmail Swoosh.Adapters.SparkPost
] ]
}, },
%{ %{
@ -249,7 +250,8 @@
group: {:subgroup, Swoosh.Adapters.SMTP}, group: {:subgroup, Swoosh.Adapters.SMTP},
key: :port, key: :port,
type: :integer, type: :integer,
description: "SMTP port" description: "SMTP port",
suggestions: ["1025"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.SMTP}, group: {:subgroup, Swoosh.Adapters.SMTP},
@ -270,7 +272,7 @@
key: :ssl, key: :ssl,
label: "Use SSL", label: "Use SSL",
type: :boolean, type: :boolean,
description: "Use implicit SSL/TLS. e.g. port 465" description: "Use Implicit SSL/TLS. e.g. port 465"
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.SMTP}, group: {:subgroup, Swoosh.Adapters.SMTP},
@ -298,139 +300,130 @@
%{ %{
group: {:subgroup, Swoosh.Adapters.Sendgrid}, group: {:subgroup, Swoosh.Adapters.Sendgrid},
key: :api_key, key: :api_key,
label: "API key", label: "SendGrid API Key",
type: :string, type: :string,
description: "`Swoosh.Adapters.Sendgrid` adapter specific setting", suggestions: ["YOUR_API_KEY"]
suggestions: ["my-api-key"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Sendmail}, group: {:subgroup, Swoosh.Adapters.Sendmail},
key: :cmd_path, key: :cmd_path,
type: :string, type: :string,
description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
suggestions: ["/usr/bin/sendmail"] suggestions: ["/usr/bin/sendmail"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Sendmail}, group: {:subgroup, Swoosh.Adapters.Sendmail},
key: :cmd_args, key: :cmd_args,
type: :string, type: :string,
description: "`Swoosh.Adapters.Sendmail` adapter specific setting",
suggestions: ["-N delay,failure,success"] suggestions: ["-N delay,failure,success"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Sendmail}, group: {:subgroup, Swoosh.Adapters.Sendmail},
key: :qmail, key: :qmail,
label: "Qmail compat mode",
type: :boolean, type: :boolean,
description: "`Swoosh.Adapters.Sendmail` adapter specific setting"
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Mandrill}, group: {:subgroup, Swoosh.Adapters.Mandrill},
key: :api_key, key: :api_key,
label: "API key", label: "Mandrill API Key",
type: :string, type: :string,
description: "`Swoosh.Adapters.Mandrill` adapter specific setting", suggestions: ["YOUR_API_KEY"]
suggestions: ["my-api-key"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Mailgun}, group: {:subgroup, Swoosh.Adapters.Mailgun},
key: :api_key, key: :api_key,
label: "API key", label: "Mailgun API Key",
type: :string, type: :string,
description: "`Swoosh.Adapters.Mailgun` adapter specific setting", suggestions: ["YOUR_API_KEY"]
suggestions: ["my-api-key"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Mailgun}, group: {:subgroup, Swoosh.Adapters.Mailgun},
key: :domain, key: :domain,
type: :string, type: :string,
description: "`Swoosh.Adapters.Mailgun` adapter specific setting", suggestions: ["YOUR_DOMAIN_NAME"]
suggestions: ["pleroma.com"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Mailjet}, group: {:subgroup, Swoosh.Adapters.Mailjet},
key: :api_key, key: :api_key,
label: "API key", label: "MailJet Public API Key",
type: :string, type: :string,
description: "`Swoosh.Adapters.Mailjet` adapter specific setting", suggestions: ["MJ_APIKEY_PUBLIC"]
suggestions: ["my-api-key"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Mailjet}, group: {:subgroup, Swoosh.Adapters.Mailjet},
key: :secret, key: :secret,
label: "MailJet Private API Key",
type: :string, type: :string,
description: "`Swoosh.Adapters.Mailjet` adapter specific setting", suggestions: ["MJ_APIKEY_PRIVATE"]
suggestions: ["my-secret-key"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Postmark}, group: {:subgroup, Swoosh.Adapters.Postmark},
key: :api_key, key: :api_key,
label: "API key", label: "Postmark API Key",
type: :string, type: :string,
description: "`Swoosh.Adapters.Postmark` adapter specific setting", suggestions: ["X-Postmark-Server-Token"]
suggestions: ["my-api-key"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.SparkPost}, group: {:subgroup, Swoosh.Adapters.SparkPost},
key: :api_key, key: :api_key,
label: "API key", label: "SparkPost API key",
type: :string, type: :string,
description: "`Swoosh.Adapters.SparkPost` adapter specific setting", suggestions: ["YOUR_API_KEY"]
suggestions: ["my-api-key"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.SparkPost}, group: {:subgroup, Swoosh.Adapters.SparkPost},
key: :endpoint, key: :endpoint,
type: :string, type: :string,
description: "`Swoosh.Adapters.SparkPost` adapter specific setting",
suggestions: ["https://api.sparkpost.com/api/v1"] suggestions: ["https://api.sparkpost.com/api/v1"]
}, },
%{
group: {:subgroup, Swoosh.Adapters.AmazonSES},
key: :region,
type: :string,
description: "`Swoosh.Adapters.AmazonSES` adapter specific setting",
suggestions: ["us-east-1", "us-east-2"]
},
%{ %{
group: {:subgroup, Swoosh.Adapters.AmazonSES}, group: {:subgroup, Swoosh.Adapters.AmazonSES},
key: :access_key, key: :access_key,
label: "AWS Access Key",
type: :string, type: :string,
description: "`Swoosh.Adapters.AmazonSES` adapter specific setting", suggestions: ["AWS_ACCESS_KEY"]
suggestions: ["aws-access-key"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.AmazonSES}, group: {:subgroup, Swoosh.Adapters.AmazonSES},
key: :secret, key: :secret,
label: "AWS Secret Key",
type: :string, type: :string,
description: "`Swoosh.Adapters.AmazonSES` adapter specific setting", suggestions: ["AWS_SECRET_KEY"]
suggestions: ["aws-secret-key"] },
%{
group: {:subgroup, Swoosh.Adapters.AmazonSES},
key: :region,
label: "AWS Region",
type: :string,
suggestions: ["us-east-1", "us-east-2"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Dyn}, group: {:subgroup, Swoosh.Adapters.Dyn},
key: :api_key, key: :api_key,
label: "API key", label: "Dyn API Key",
type: :string, type: :string,
description: "`Swoosh.Adapters.Dyn` adapter specific setting", suggestions: ["apikey"]
suggestions: ["my-api-key"]
},
%{
group: {:subgroup, Swoosh.Adapters.SocketLabs},
key: :server_id,
type: :string,
description: "`Swoosh.Adapters.SocketLabs` adapter specific setting"
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.SocketLabs}, group: {:subgroup, Swoosh.Adapters.SocketLabs},
key: :api_key, key: :api_key,
label: "API key", label: "SocketLabs API Key",
type: :string, type: :string,
description: "`Swoosh.Adapters.SocketLabs` adapter specific setting" suggestions: ["INJECTION_API_KEY"]
},
%{
group: {:subgroup, Swoosh.Adapters.SocketLabs},
key: :server_id,
label: "Server ID",
type: :string,
suggestions: ["SERVER_ID"]
}, },
%{ %{
group: {:subgroup, Swoosh.Adapters.Gmail}, group: {:subgroup, Swoosh.Adapters.Gmail},
key: :access_token, key: :access_token,
label: "GMail API Access Token",
type: :string, type: :string,
description: "`Swoosh.Adapters.Gmail` adapter specific setting" suggestions: ["GMAIL_API_ACCESS_TOKEN"]
} }
] ]
}, },