Merge pull request #3 from hsharghi/scheduled

Add scheduledAt parameter to send email

Author: hsharghi

README.md

@@ -41,29 +41,51 @@ You can send a single email by creating a `ResendEmail` object and retrieving th
 ~~~~swift
 import Resend
 
-let email: ResendEmail = .init(
-    from: .init(email: "hadi@example.com", name: "Hadi"),
-    to: ["hadi@domain.com"],
-    subject: "running xctest",
-    replyTo: [
-        "hadi@example.com",
-        "manager@example.com"
-    ],
-    text: "sending email from XCTest suit",
-    headers: [
-        .init(name: "X-Entity-Ref-ID", value: "234H3-44"),
-        .init(name: "X-Entity-Dep-ID", value: "SALE-03"),
-    ],
-    attachments: [
-        .init(content: .init(data: .init(contentsOf: .init(filePath: "path/to/a/file"))),
-              filename: "sales.xlsx")
-    ],
-    tags: [
-        .init(name: "priority", value: "medium"),
-        .init(name: "department", value: "sales")
-    ]
-)
+let email = ResendEmail(
+        from: .init(email: "hadi@example.com", name: "Hadi"),
+        to: ["hadi@domain.com"],
+        subject: "running xctest",
+        replyTo: [
+            "hadi@example.com",
+            "manager@example.com"
+        ],
+        text: "sending email via Resend API",
+        headers: [
+            .init(name: "X-Entity-Ref-ID", value: "234H3-44"),
+            .init(name: "X-Entity-Dep-ID", value: "SALE-03"),
+        ],
+        attachments: [
+            .init(content: .init(data: .init(contentsOf: .init(filePath: "path/to/a/file"))),
+                filename: "sales.xlsx")
+        ],
+        tags: [
+            .init(name: "priority", value: "medium"),
+            .init(name: "department", value: "sales")
+        ]
+    )
+~~~~
+
+Emails can be scheduled to be sent later. The date should be a `Date` object or a string in natural language (e.g.: in 1 min)
 
+~~~~swift
+let email = ResendEmail(
+        to: ["hadi@domain.com"],
+        subject: "sending scheduled email",
+        scheduledAt: "in an hour",
+        text: "sending email via Resend API",
+    )
+
+let email = ResendEmail(
+        to: ["hadi@domain.com"],
+        subject: "sending scheduled email",
+        scheduledAt: .date(Date(timeIntervalSinceNow: 60\*60)),
+        text: "sending email via Resend API",
+    )
+~~~~
+
+Now the email can be sent using resend client
+
+~~~~swift
 let id = try await resendClient.emails.send(email)
 ~~~~
 `ResendEmail` supports both `text` and `html` content.

Sources/Resend/Models/Request/Email/EmailSchedule.swift

@@ -0,0 +1,38 @@
+//
+//  EmailSchedule.swift
+//  swift-resend
+//
+//  Created by Hadi Sharghi on 7/2/25.
+//
+
+import Foundation
+
+public enum EmailSchedule {
+    case date(Date)
+    case string(String)
+}
+
+extension EmailSchedule: ExpressibleByStringLiteral {
+    public init(stringLiteral value: String) {
+        self = .string(value)
+    }
+}
+
+
+// Custom Codable implementation
+extension EmailSchedule: Codable {
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.singleValueContainer()
+        
+        switch self {
+        case .date(let date):
+            // Encode Date as ISO 8601 string
+            let formatter = ISO8601DateFormatter()
+            formatter.formatOptions = [.withInternetDateTime, .withFractionalSeconds]
+            try container.encode(formatter.string(from: date))
+        case .string(let string):
+            // Encode String directly
+            try container.encode(string)
+        }
+    }
+}

Sources/Resend/Models/Request/Email/ResendEmail.swift

@@ -23,6 +23,9 @@ public struct ResendEmail {
     /// An array of recipients who will receive a blind carbon copy of your email. Each object within this array may contain the name, but must always contain the email, of a recipient.
     public var bcc: [EmailAddress]?
 
+    /// Schedule email to be sent later. The date should be in natural language (e.g.: in 1 min) or ISO 8601 format (e.g: 2024-08-05T11:52:01.858Z).
+    public var scheduledAt: EmailSchedule?
+    
     /// An array of recipients who will receive replies and/or bounces.
     public var replyTo: [EmailAddress]?
 
@@ -46,6 +49,7 @@ public struct ResendEmail {
          subject: String,
          cc: [EmailAddress]? = nil,
          bcc: [EmailAddress]? = nil,
+         scheduledAt: EmailSchedule? = nil,
          replyTo: [EmailAddress]? = nil,
          text: String? = nil,
          html: String? = nil,
@@ -57,6 +61,7 @@ public struct ResendEmail {
         self.subject = subject
         self.cc = cc
         self.bcc = bcc
+        self.scheduledAt = scheduledAt
         self.replyTo = replyTo
         self.text = text
         self.html = html
@@ -72,6 +77,7 @@ public struct ResendEmail {
         case subject
         case cc
         case bcc
+        case scheduledAt = "scheduled_at"
         case replyTo = "reply_to"
         case text
         case html
@@ -91,6 +97,7 @@ extension ResendEmail: Encodable {
         try container.encodeIfPresent(subject, forKey: .subject)
         try container.encodeIfPresent(cc?.stringArray, forKey: .cc)
         try container.encodeIfPresent(bcc?.stringArray, forKey: .bcc)
+        try container.encodeIfPresent(scheduledAt, forKey: .scheduledAt)
         try container.encodeIfPresent(replyTo?.stringArray, forKey: .replyTo)
         try container.encodeIfPresent(text, forKey: .text)
         try container.encodeIfPresent(html, forKey: .html)

Tests/SwiftResendTests/ResendError+ Equatable.swift

@@ -8,7 +8,7 @@
 import Foundation
 @testable import Resend
 
-extension ResendError: Equatable {
+extension ResendError: @retroactive Equatable {
     public static func == (lhs: ResendError, rhs: ResendError) -> Bool {
         lhs.identifier == rhs.identifier
     }

Tests/SwiftResendTests/SwiftResendTests.swift

@@ -44,6 +44,34 @@ final class SwiftResendTests: XCTestCase {
         XCTAssertNotNil(id)
     }
 
+    func testSendWithScheduleInNaturalLanuguage() async throws {
+        let id = try await resend.emails.send(email: .init(
+            from: .init(email: "hadi@softworks.ir", name: "Hadi"),
+            to: ["hsharghi@gmail.com"],
+            subject: "send later",
+            scheduledAt: "in an hour",
+            text: "sending email from XCTest suit with schedule",
+        ))
+        XCTAssertNotNil(id)
+        
+        let info = try await resend.emails.get(emailId: id)
+        XCTAssertEqual("scheduled", info.lastEvent)
+    }
+    
+    func testSendWithScheduleWithDate() async throws {
+        let id = try await resend.emails.send(email: .init(
+            from: .init(email: "hadi@softworks.ir", name: "Hadi"),
+            to: ["hsharghi@gmail.com"],
+            subject: "send later",
+            scheduledAt: .date(Date(timeIntervalSinceNow: 60*60)),
+            text: "sending email from XCTest suit with schedule",
+        ))
+        XCTAssertNotNil(id)
+        
+        let info = try await resend.emails.get(emailId: id)
+        XCTAssertEqual("scheduled", info.lastEvent)
+    }
+    
     func testSendBatch() async throws {
         let response = try await resend.emails.sendBatch(emails: [
         .init(