Directories
¶
| Path | Synopsis |
|---|---|
|
Package admin is courier's internal API: the console module's channel list and check, served on the platform port behind the internal secret.
|
Package admin is courier's internal API: the console module's channel list and check, served on the platform port behind the internal secret. |
|
Package apns is the built-in Apple push provider: APNs over HTTP/2 per channel (a team's auth key) with token-based authentication, and every push type APNs takes, VoIP for PushKit and CallKit included.
|
Package apns is the built-in Apple push provider: APNs over HTTP/2 per channel (a team's auth key) with token-based authentication, and every push type APNs takes, VoIP for PushKit and CallKit included. |
|
apnstest
Package apnstest is a fake APNs for tests: HTTP/2 over TLS, the provider token checked against the channel's key, every push recorded, answers by rules on the device token.
|
Package apnstest is a fake APNs for tests: HTTP/2 over TLS, the provider token checked against the channel's key, every push recorded, answers by rules on the device token. |
|
Package channels holds the installation's channels: their configuration (exactly one provider each), the runtime of each (pool, rate, timeout) and which channel a kind uses by default.
|
Package channels holds the installation's channels: their configuration (exactly one provider each), the runtime of each (pool, rate, timeout) and which channel a kind uses by default. |
|
Package courier is the service's work: an activity per kind of delivery — SendMail, SendPush (with Subscribe and Unsubscribe for FCM topics), SendWebPush (with WebPushKey for the browsers), SendWebhook (signed posts to receivers the product names) and Send<Kind> for every extension provider — each delivering at once through the channel the message names or the kind's default.
|
Package courier is the service's work: an activity per kind of delivery — SendMail, SendPush (with Subscribe and Unsubscribe for FCM topics), SendWebPush (with WebPushKey for the browsers), SendWebhook (signed posts to receivers the product names) and Send<Kind> for every extension provider — each delivering at once through the channel the message names or the kind's default. |
|
Package fcm is the built-in push provider: FCM HTTP v1 per channel (a Firebase project) with OAuth2 from a service account, and topic subscriptions through the Instance ID API.
|
Package fcm is the built-in push provider: FCM HTTP v1 per channel (a Firebase project) with OAuth2 from a service account, and topic subscriptions through the Instance ID API. |
|
fcmtest
Package fcmtest is a fake FCM endpoint for tests (HTTP v1 sends and Instance ID subscriptions): it records what it receives and answers by rules on the target.
|
Package fcmtest is a fake FCM endpoint for tests (HTTP v1 sends and Instance ID subscriptions): it records what it receives and answers by rules on the target. |
|
Package mail is the service's domain: the message a caller hands to courier.SendMail, its checks and limits, address hashing and the MIME it becomes.
|
Package mail is the service's domain: the message a caller hands to courier.SendMail, its checks and limits, address hashing and the MIME it becomes. |
|
Package push is the push domain: the message a caller hands to courier.SendPush, its checks, token hashing and the FCM HTTP v1 message it becomes.
|
Package push is the push domain: the message a caller hands to courier.SendPush, its checks, token hashing and the FCM HTTP v1 message it becomes. |
|
Package smtp is the built-in mail provider: one SMTP relay per channel, a connection per delivery, 5xx replies final.
|
Package smtp is the built-in mail provider: one SMTP relay per channel, a connection per delivery, 5xx replies final. |
|
smtptest
Package smtptest is an SMTP server for tests: it keeps what it receives and refuses the recipients it is told to.
|
Package smtptest is an SMTP server for tests: it keeps what it receives and refuses the recipients it is told to. |
|
Package ui carries the console module: web/dist/plugin copied here by `make web` and embedded into the binary.
|
Package ui carries the console module: web/dist/plugin copied here by `make web` and embedded into the binary. |
|
Package webhook is the built-in webhook provider: a signed HTTP POST of JSON to a URL the product names on every call, signed per Standard Webhooks (webhook-id, webhook-timestamp, webhook-signature: HMAC-SHA256 with the secret the product holds for that receiver).
|
Package webhook is the built-in webhook provider: a signed HTTP POST of JSON to a URL the product names on every call, signed per Standard Webhooks (webhook-id, webhook-timestamp, webhook-signature: HMAC-SHA256 with the secret the product holds for that receiver). |
|
Package webpush is the built-in Web Push provider: the standard protocol every browser's push service speaks (RFC 8030), the payload encrypted to the subscription (RFC 8291) and the sender identified by its VAPID key (RFC 8292).
|
Package webpush is the built-in Web Push provider: the standard protocol every browser's push service speaks (RFC 8030), the payload encrypted to the subscription (RFC 8291) and the sender identified by its VAPID key (RFC 8292). |
Click to show internal directories.
Click to hide internal directories.